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
|
"""
Utilities for writing tests
"""
import warnings
from unyt.array import NULL_UNIT, allclose_units
def assert_allclose_units(actual, desired, rtol=1e-7, atol=0, **kwargs):
"""Raise an error if two objects are not equal up to desired tolerance
This is a wrapper for :func:`numpy.testing.assert_allclose` that also
verifies unit consistency
Parameters
----------
actual : array-like
Array obtained (possibly with attached units)
desired : array-like
Array to compare with (possibly with attached units)
rtol : float, optional
Relative tolerance, defaults to 1e-7
atol : float or quantity, optional
Absolute tolerance. If units are attached, they must be consistent
with the units of ``actual`` and ``desired``. If no units are attached,
assumes the same units as ``desired``. Defaults to zero.
See Also
--------
:func:`unyt.array.allclose_units`
Notes
-----
Also accepts additional keyword arguments accepted by
:func:`numpy.testing.assert_allclose`, see the documentation of that
function for details.
Examples
--------
>>> import unyt as u
>>> actual = [1e-5, 1e-3, 1e-1]*u.m
>>> desired = actual.to("cm")
>>> assert_allclose_units(actual, desired)
"""
if not allclose_units(actual, desired, rtol, atol, **kwargs):
raise AssertionError
def assert_array_equal_units(x, y, **kwargs):
"""A thin wrapper around :func:`numpy.testing.assert_array_equal` that also
verifies unit consistency
Arrays without units are considered dimensionless.
Parameters
----------
x : array_like
The actual object to check.
y : array_like
The desired, expected object.
See Also
--------
:func:`numpy.testing.assert_array_equal`
Notes
-----
Also accepts additional keyword arguments accepted by
:func:`numpy.testing.assert_array_equel`, see the documentation of that
function for details.
"""
# see https://github.com/yt-project/unyt/issues/281
from numpy.testing import assert_array_equal
assert_array_equal(x, y, **kwargs)
if not (xu := getattr(x, "units", NULL_UNIT)) == (
yu := getattr(y, "units", NULL_UNIT)
):
raise AssertionError(f"Arguments' units do not match (got {xu} and {yu})")
def _process_warning(op, message, warning_class, args=(), kwargs=None):
if kwargs is None:
kwargs = {}
with warnings.catch_warnings(record=True) as w:
warnings.simplefilter("always")
op(*args, **kwargs)
assert len(w) == 1
assert issubclass(w[0].category, warning_class)
assert str(w[0].message) == message
|