Skip to content

simple test classes for creation and reduction #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ci/requirements/environment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ name: xarray-array-testing-tests
channels:
- conda-forge
dependencies:
- python=3.12
- ipython
- pre-commit
- pytest
- pytest-reportlog
- pytest-cov
- hypothesis
- xarray
- numpy
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "xarray-array-testing"
requires-python = ">= 3.12"
requires-python = ">= 3.11"
license = {text = "Apache-2.0"}
dependencies = [
"hypothesis",
Expand Down Expand Up @@ -51,7 +51,7 @@ ignore = [
"E501", # E501: line too long - let black worry about that
"E731", # E731: do not assign a lambda expression, use a def
]
fixable = ["I"]
fixable = ["I", "TID"]
extend-safe-fixes = [
"TID252", # absolute imports
]
Expand Down
27 changes: 27 additions & 0 deletions xarray_array_testing/base.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import abc
from abc import ABC
from types import ModuleType

import numpy.testing as npt
from xarray.namedarray._typing import duckarray


class DuckArrayTestMixin(ABC):
@property
@abc.abstractmethod
def xp() -> ModuleType:
pass

@property
@abc.abstractmethod
def array_type(self) -> type[duckarray]:
pass

@staticmethod
@abc.abstractmethod
def array_strategy_fn(*, shape, dtype):
raise NotImplementedError("has to be overridden")

@staticmethod
def assert_equal(a, b):
npt.assert_equal(a, b)
13 changes: 13 additions & 0 deletions xarray_array_testing/creation.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import hypothesis.strategies as st
import xarray.testing.strategies as xrst
from hypothesis import given

from xarray_array_testing.base import DuckArrayTestMixin


class CreationTests(DuckArrayTestMixin):
@given(st.data())
def test_create_variable(self, data):
variable = data.draw(xrst.variables(array_strategy_fn=self.array_strategy_fn))

assert isinstance(variable.data, self.array_type)
33 changes: 33 additions & 0 deletions xarray_array_testing/reduction.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
from contextlib import nullcontext

import hypothesis.strategies as st
import xarray.testing.strategies as xrst
from hypothesis import given

from xarray_array_testing.base import DuckArrayTestMixin


class ReductionTests(DuckArrayTestMixin):
@staticmethod
def expected_errors(op, **parameters):
return nullcontext()

@given(st.data())
def test_variable_mean(self, data):
variable = data.draw(xrst.variables(array_strategy_fn=self.array_strategy_fn))

with self.expected_errors("mean", variable=variable):
actual = variable.mean().data
expected = self.xp.mean(variable.data)

self.assert_equal(actual, expected)

@given(st.data())
def test_variable_prod(self, data):
variable = data.draw(xrst.variables(array_strategy_fn=self.array_strategy_fn))

with self.expected_errors("prod", variable=variable):
actual = variable.prod().data
expected = self.xp.prod(variable.data)

self.assert_equal(actual, expected)
34 changes: 34 additions & 0 deletions xarray_array_testing/tests/test_numpy.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
from types import ModuleType

import hypothesis.strategies as st
import numpy as np

from xarray_array_testing.base import DuckArrayTestMixin
from xarray_array_testing.creation import CreationTests
from xarray_array_testing.reduction import ReductionTests


def create_numpy_array(*, shape, dtype):
return st.builds(np.ones, shape=st.just(shape), dtype=st.just(dtype))


class NumpyTestMixin(DuckArrayTestMixin):
@property
def xp(self) -> ModuleType:
return np

@property
def array_type(self) -> type[np.ndarray]:
return np.ndarray

@staticmethod
def array_strategy_fn(*, shape, dtype):
return create_numpy_array(shape=shape, dtype=dtype)


class TestCreationNumpy(CreationTests, NumpyTestMixin):
pass


class TestReductionNumpy(ReductionTests, NumpyTestMixin):
pass