File: test_typed_ops.py

package info (click to toggle)
python-xarray 2025.08.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 11,796 kB
  • sloc: python: 115,416; makefile: 258; sh: 47
file content (246 lines) | stat: -rw-r--r-- 6,334 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
import numpy as np

from xarray import DataArray, Dataset, Variable


def test_variable_typed_ops() -> None:
    """Tests for type checking of typed_ops on Variable"""

    var = Variable(dims=["t"], data=[1, 2, 3])

    def _test(var: Variable) -> None:
        # mypy checks the input type
        assert isinstance(var, Variable)

    _int: int = 1
    _list = [1, 2, 3]
    _ndarray = np.array([1, 2, 3])

    # __add__ as an example of binary ops
    _test(var + _int)
    _test(var + _list)
    _test(var + _ndarray)
    _test(var + var)

    # __radd__ as an example of reflexive binary ops
    _test(_int + var)
    _test(_list + var)
    _test(_ndarray + var)  # type: ignore[arg-type]  # numpy problem

    # __eq__ as an example of cmp ops
    _test(var == _int)
    _test(var == _list)
    _test(var == _ndarray)
    _test(_int == var)  # type: ignore[arg-type]  # typeshed problem
    _test(_list == var)  # type: ignore[arg-type]  # typeshed problem
    _test(_ndarray == var)

    # __lt__ as another example of cmp ops
    _test(var < _int)
    _test(var < _list)
    _test(var < _ndarray)
    _test(_int > var)
    _test(_list > var)
    _test(_ndarray > var)  # type: ignore[arg-type]  # numpy problem

    # __iadd__ as an example of inplace binary ops
    var += _int
    var += _list
    var += _ndarray

    # __neg__ as an example of unary ops
    _test(-var)


def test_dataarray_typed_ops() -> None:
    """Tests for type checking of typed_ops on DataArray"""

    da = DataArray([1, 2, 3], dims=["t"])

    def _test(da: DataArray) -> None:
        # mypy checks the input type
        assert isinstance(da, DataArray)

    _int: int = 1
    _list = [1, 2, 3]
    _ndarray = np.array([1, 2, 3])
    _var = Variable(dims=["t"], data=[1, 2, 3])

    # __add__ as an example of binary ops
    _test(da + _int)
    _test(da + _list)
    _test(da + _ndarray)
    _test(da + _var)
    _test(da + da)

    # __radd__ as an example of reflexive binary ops
    _test(_int + da)
    _test(_list + da)
    _test(_ndarray + da)  # type: ignore[arg-type]  # numpy problem
    _test(_var + da)

    # __eq__ as an example of cmp ops
    _test(da == _int)
    _test(da == _list)
    _test(da == _ndarray)
    _test(da == _var)
    _test(_int == da)  # type: ignore[arg-type]  # typeshed problem
    _test(_list == da)  # type: ignore[arg-type]  # typeshed problem
    _test(_ndarray == da)
    _test(_var == da)

    # __lt__ as another example of cmp ops
    _test(da < _int)
    _test(da < _list)
    _test(da < _ndarray)
    _test(da < _var)
    _test(_int > da)
    _test(_list > da)
    _test(_ndarray > da)  # type: ignore[arg-type]  # numpy problem
    _test(_var > da)

    # __iadd__ as an example of inplace binary ops
    da += _int
    da += _list
    da += _ndarray
    da += _var

    # __neg__ as an example of unary ops
    _test(-da)


def test_dataset_typed_ops() -> None:
    """Tests for type checking of typed_ops on Dataset"""

    ds = Dataset({"a": ("t", [1, 2, 3])})

    def _test(ds: Dataset) -> None:
        # mypy checks the input type
        assert isinstance(ds, Dataset)

    _int: int = 1
    _list = [1, 2, 3]
    _ndarray = np.array([1, 2, 3])
    _var = Variable(dims=["t"], data=[1, 2, 3])
    _da = DataArray([1, 2, 3], dims=["t"])

    # __add__ as an example of binary ops
    _test(ds + _int)
    _test(ds + _list)
    _test(ds + _ndarray)
    _test(ds + _var)
    _test(ds + _da)
    _test(ds + ds)

    # __radd__ as an example of reflexive binary ops
    _test(_int + ds)
    _test(_list + ds)
    _test(_ndarray + ds)
    _test(_var + ds)
    _test(_da + ds)

    # __eq__ as an example of cmp ops
    _test(ds == _int)
    _test(ds == _list)
    _test(ds == _ndarray)
    _test(ds == _var)
    _test(ds == _da)
    _test(_int == ds)  # type: ignore[arg-type]  # typeshed problem
    _test(_list == ds)  # type: ignore[arg-type]  # typeshed problem
    _test(_ndarray == ds)
    _test(_var == ds)
    _test(_da == ds)

    # __lt__ as another example of cmp ops
    _test(ds < _int)
    _test(ds < _list)
    _test(ds < _ndarray)
    _test(ds < _var)
    _test(ds < _da)
    _test(_int > ds)
    _test(_list > ds)
    _test(_ndarray > ds)  # type: ignore[arg-type]  # numpy problem
    _test(_var > ds)
    _test(_da > ds)

    # __iadd__ as an example of inplace binary ops
    ds += _int
    ds += _list
    ds += _ndarray
    ds += _var
    ds += _da

    # __neg__ as an example of unary ops
    _test(-ds)


def test_dataarray_groupy_typed_ops() -> None:
    """Tests for type checking of typed_ops on DataArrayGroupBy"""

    da = DataArray([1, 2, 3], coords={"x": ("t", [1, 2, 2])}, dims=["t"])
    grp = da.groupby("x")

    def _testda(da: DataArray) -> None:
        # mypy checks the input type
        assert isinstance(da, DataArray)

    def _testds(ds: Dataset) -> None:
        # mypy checks the input type
        assert isinstance(ds, Dataset)

    _da = DataArray([5, 6], coords={"x": [1, 2]}, dims="x")
    _ds = _da.to_dataset(name="a")

    # __add__ as an example of binary ops
    _testda(grp + _da)
    _testds(grp + _ds)

    # __radd__ as an example of reflexive binary ops
    _testda(_da + grp)
    _testds(_ds + grp)

    # __eq__ as an example of cmp ops
    _testda(grp == _da)
    _testda(_da == grp)
    _testds(grp == _ds)
    _testds(_ds == grp)

    # __lt__ as another example of cmp ops
    _testda(grp < _da)
    _testda(_da > grp)
    _testds(grp < _ds)
    _testds(_ds > grp)


def test_dataset_groupy_typed_ops() -> None:
    """Tests for type checking of typed_ops on DatasetGroupBy"""

    ds = Dataset({"a": ("t", [1, 2, 3])}, coords={"x": ("t", [1, 2, 2])})
    grp = ds.groupby("x")

    def _test(ds: Dataset) -> None:
        # mypy checks the input type
        assert isinstance(ds, Dataset)

    _da = DataArray([5, 6], coords={"x": [1, 2]}, dims="x")
    _ds = _da.to_dataset(name="a")

    # __add__ as an example of binary ops
    _test(grp + _da)
    _test(grp + _ds)

    # __radd__ as an example of reflexive binary ops
    _test(_da + grp)
    _test(_ds + grp)

    # __eq__ as an example of cmp ops
    _test(grp == _da)
    _test(_da == grp)
    _test(grp == _ds)
    _test(_ds == grp)

    # __lt__ as another example of cmp ops
    _test(grp < _da)
    _test(_da > grp)
    _test(grp < _ds)
    _test(_ds > grp)