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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
import re
import pint
import pytest
import xarray as xr
import pint_xarray
from pint_xarray.testing import assert_units_equal
ureg = pint_xarray.unit_registry
class TestExpects:
@pytest.mark.parametrize(
["values", "units", "expected"],
(
((ureg.Quantity(1, "m"), 2), ("mm", None, None), 500),
((ureg.Quantity(1, "m"), ureg.Quantity(0.5, "s")), ("mm", "ms", None), 2),
(
(xr.DataArray(4).pint.quantify("km"), 2),
("m", None, None),
xr.DataArray(2000),
),
(
(
xr.DataArray([4, 2, 0]).pint.quantify("cm"),
xr.DataArray([4, 2, 1]).pint.quantify("mg"),
),
("m", "g", None),
xr.DataArray([10, 10, 0]),
),
(
(ureg.Quantity(16, "m"), 2, ureg.Quantity(4, "s")),
("mm", None, "ms"),
2,
),
),
)
def test_args(self, values, units, expected):
@pint_xarray.expects(*units)
def func(a, b, c=1):
return a / (b * c)
actual = func(*values)
if isinstance(actual, xr.DataArray):
xr.testing.assert_identical(actual, expected)
elif isinstance(actual, pint.Quantity):
pint.testing.assert_equal(actual, expected)
else:
assert actual == expected
@pytest.mark.parametrize(
["value", "units", "error", "message", "multiple"],
(
(
ureg.Quantity(1, "m"),
(None, None),
TypeError,
"Passed in a quantity where none was expected",
True,
),
(1, ("m", None), TypeError, "Attempting to convert non-quantity", True),
(
1,
(None,),
ValueError,
"Missing units for the following parameters: 'b'",
False,
),
(
ureg.Quantity(1, "m"),
("nonsense_unit", None),
pint.errors.UndefinedUnitError,
"'nonsense_unit' is not defined in the unit registry",
True,
),
),
)
def test_args_error(self, value, units, error, message, multiple):
if multiple:
root_error = ExceptionGroup
root_message = "Errors while converting parameters"
else:
root_error = error
root_message = message
with pytest.raises(root_error, match=root_message) as excinfo:
@pint_xarray.expects(*units)
def func(a, b=1):
return a * b
func(value)
if not multiple:
return
group = excinfo.value
assert len(group.exceptions) == 1, f"Found {len(group.exceptions)} exceptions"
exc = group.exceptions[0]
assert isinstance(
exc, error
), f"Unexpected exception type: {type(exc)}, expected {error}"
if not re.search(message, str(exc)):
raise AssertionError(f"exception {exc!r} did not match pattern {message!r}")
@pytest.mark.parametrize(
["values", "units", "expected"],
(
(
{"a": ureg.Quantity(1, "m"), "b": 2},
{"a": "mm", "b": None, "c": None},
1000,
),
(
{"a": 2, "b": ureg.Quantity(100, "cm")},
{"a": None, "b": "m", "c": None},
4,
),
(
{"a": ureg.Quantity(1, "m"), "b": ureg.Quantity(0.5, "s")},
{"a": "mm", "b": "ms", "c": None},
4,
),
(
{"a": xr.DataArray(4).pint.quantify("km"), "b": 2},
{"a": "m", "b": None, "c": None},
xr.DataArray(4000),
),
(
{
"a": xr.DataArray([4, 2, 0]).pint.quantify("cm"),
"b": xr.DataArray([4, 2, 1]).pint.quantify("mg"),
},
{"a": "m", "b": "g", "c": None},
xr.DataArray([20, 20, 0]),
),
),
)
def test_kwargs(self, values, units, expected):
@pint_xarray.expects(**units)
def func(a, b, c=2):
return a / b * c
actual = func(**values)
if isinstance(actual, xr.DataArray):
xr.testing.assert_identical(actual, expected)
elif isinstance(actual, pint.Quantity):
pint.testing.assert_equal(actual, expected)
else:
assert actual == expected
@pytest.mark.parametrize(
["values", "return_value_units", "expected"],
(
((1, 2), ("m", "s"), (ureg.Quantity(1, "m"), ureg.Quantity(2, "s"))),
((1, 2), "m / s", ureg.Quantity(0.5, "m / s")),
((1, 2), None, 0.5),
(
(xr.DataArray(2), 2),
("m", "s"),
(xr.DataArray(2).pint.quantify("m"), ureg.Quantity(2, "s")),
),
(
(xr.DataArray(2), 2),
"kg / m^2",
xr.DataArray(1).pint.quantify("kg / m^2"),
),
),
)
def test_return_value(self, values, return_value_units, expected):
multiple = isinstance(return_value_units, tuple)
@pint_xarray.expects(a=None, b=None, return_value=return_value_units)
def func(a, b):
if multiple:
return a, b
else:
return a / b
actual = func(*values)
if isinstance(actual, xr.DataArray):
xr.testing.assert_identical(actual, expected)
elif isinstance(actual, pint.Quantity):
pint.testing.assert_equal(actual, expected)
else:
assert actual == expected
def test_return_value_none(self):
@pint_xarray.expects(None)
def func(a):
return None
actual = func(1)
assert actual is None
def test_return_value_none_error(self):
@pint_xarray.expects(return_value="Hz")
def func():
return None
with pytest.raises(
ValueError,
match="mismatched number of return values: expected 1 but got 0.",
):
func()
@pytest.mark.parametrize(
[
"return_value_units",
"multiple_units",
"error",
"multiple_errors",
"message",
],
(
(
("m", "s"),
False,
ValueError,
False,
"mismatched number of return values",
),
(
"m",
True,
ValueError,
False,
"mismatched number of return values: expected 1 but got 2",
),
(
("m",),
True,
ValueError,
False,
"mismatched number of return values: expected 1 but got 2",
),
(1, False, TypeError, True, "units must be of type"),
(("m",), False, ValueError, False, ".*expected a 1-sized tuple.*"),
("m", 1, ValueError, False, ".*expected a single return value.*"),
),
)
def test_return_value_error(
self, return_value_units, multiple_units, error, multiple_errors, message
):
if multiple_errors:
root_error = ExceptionGroup
root_message = "Errors while converting return values"
else:
root_error = error
root_message = message
with pytest.raises(root_error, match=root_message) as excinfo:
@pint_xarray.expects(a=None, b=None, return_value=return_value_units)
def func(a, b):
if not isinstance(multiple_units, bool) and multiple_units == 1:
print("return 1-tuple")
return (a / b,)
elif multiple_units:
return a, b
else:
return a / b
func(1, 2)
if not multiple_errors:
return
group = excinfo.value
assert len(group.exceptions) == 1, f"Found {len(group.exceptions)} exceptions"
exc = group.exceptions[0]
assert isinstance(
exc, error
), f"Unexpected exception type: {type(exc)}, expected {error}"
if not re.search(message, str(exc)):
raise AssertionError(f"exception {exc!r} did not match pattern {message!r}")
def test_datasets(self):
@pint_xarray.expects({"m": "kg", "a": "m / s^2"}, return_value={"f": "newtons"})
def second_law(ds):
f_da = ds["m"] * ds["a"]
return f_da.to_dataset(name="f")
ds = xr.Dataset({"m": 0.1, "a": 10}).pint.quantify(
{"m": "tons", "a": "feet / second^2"}
)
expected = xr.Dataset({"f": ds["m"] * ds["a"]}).pint.to("newtons")
actual = second_law(ds)
assert_units_equal(actual, expected)
xr.testing.assert_allclose(actual, expected)
|
