|
1
|
|
|
# Copyright (c) 2008-2015 MetPy Developers. |
|
2
|
|
|
# Distributed under the terms of the BSD 3-Clause License. |
|
3
|
|
|
# SPDX-License-Identifier: BSD-3-Clause |
|
4
|
|
|
r"""Collection of utilities for testing. |
|
5
|
|
|
|
|
6
|
|
|
This includes: |
|
7
|
|
|
* unit-aware test functions |
|
8
|
|
|
* code for testing matplotlib figures |
|
9
|
|
|
""" |
|
10
|
|
|
|
|
11
|
|
|
import numpy as np |
|
12
|
|
|
import numpy.testing |
|
13
|
|
|
from pint import DimensionalityError |
|
14
|
|
|
import pytest |
|
15
|
|
|
|
|
16
|
|
|
from .units import units |
|
17
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
def check_and_drop_units(actual, desired): |
|
20
|
|
|
r"""Check that the units on the passed in arrays are compatible; return the magnitudes. |
|
21
|
|
|
|
|
22
|
|
|
Parameters |
|
23
|
|
|
---------- |
|
24
|
|
|
actual : `pint.Quantity` or array-like |
|
25
|
|
|
|
|
26
|
|
|
desired : `pint.Quantity` or array-like |
|
27
|
|
|
|
|
28
|
|
|
Returns |
|
29
|
|
|
------- |
|
30
|
|
|
actual, desired |
|
31
|
|
|
array-like versions of `actual` and `desired` once they have been |
|
32
|
|
|
coerced to compatible units. |
|
33
|
|
|
|
|
34
|
|
|
Raises |
|
35
|
|
|
------ |
|
36
|
|
|
AssertionError |
|
37
|
|
|
If the units on the passed in objects are not compatible. |
|
38
|
|
|
""" |
|
39
|
|
|
try: |
|
40
|
|
|
# If the desired result has units, add dimensionless units if necessary, then |
|
41
|
|
|
# ensure that this is compatible to the desired result. |
|
42
|
|
|
if hasattr(desired, 'units'): |
|
43
|
|
|
if not hasattr(actual, 'units'): |
|
44
|
|
|
actual = units.Quantity(actual, 'dimensionless') |
|
45
|
|
|
actual = actual.to(desired.units) |
|
46
|
|
|
# Otherwise, the desired result has no units. Convert the actual result to |
|
47
|
|
|
# dimensionless units if it is a united quantity. |
|
48
|
|
|
else: |
|
49
|
|
|
if hasattr(actual, 'units'): |
|
50
|
|
|
actual = actual.to('dimensionless') |
|
51
|
|
|
except DimensionalityError: |
|
52
|
|
|
raise AssertionError('Units are not compatible: {} should be {}'.format( |
|
53
|
|
|
actual.units, getattr(desired, 'units', 'dimensionless'))) |
|
54
|
|
|
except AttributeError: |
|
55
|
|
|
pass |
|
56
|
|
|
|
|
57
|
|
|
if hasattr(actual, 'magnitude'): |
|
58
|
|
|
actual = actual.magnitude |
|
59
|
|
|
if hasattr(desired, 'magnitude'): |
|
60
|
|
|
desired = desired.magnitude |
|
61
|
|
|
|
|
62
|
|
|
return actual, desired |
|
63
|
|
|
|
|
64
|
|
|
|
|
65
|
|
|
def assert_nan(value, units): |
|
66
|
|
|
"""Helper to check for nan with proper units.""" |
|
67
|
|
|
if not np.isnan(value): |
|
68
|
|
|
pytest.fail('{} is not np.nan'.format(value)) |
|
69
|
|
|
|
|
70
|
|
|
check_and_drop_units(value, np.nan * units) |
|
71
|
|
|
return True |
|
72
|
|
|
|
|
73
|
|
|
|
|
74
|
|
|
def assert_almost_equal(actual, desired, decimal=7): |
|
75
|
|
|
"""Check that values are almost equal, including units. |
|
76
|
|
|
|
|
77
|
|
|
Wrapper around :func:`numpy.testing.assert_almost_equal` |
|
78
|
|
|
""" |
|
79
|
|
|
actual, desired = check_and_drop_units(actual, desired) |
|
80
|
|
|
numpy.testing.assert_almost_equal(actual, desired, decimal) |
|
81
|
|
|
|
|
82
|
|
|
|
|
83
|
|
|
def assert_array_almost_equal(actual, desired, decimal=7): |
|
84
|
|
|
"""Check that arrays are almost equal, including units. |
|
85
|
|
|
|
|
86
|
|
|
Wrapper around :func:`numpy.testing.assert_array_almost_equal` |
|
87
|
|
|
""" |
|
88
|
|
|
actual, desired = check_and_drop_units(actual, desired) |
|
89
|
|
|
numpy.testing.assert_array_almost_equal(actual, desired, decimal) |
|
90
|
|
|
|
|
91
|
|
|
|
|
92
|
|
|
def assert_array_equal(actual, desired): |
|
93
|
|
|
"""Check that arrays are equal, including units. |
|
94
|
|
|
|
|
95
|
|
|
Wrapper around :func:`numpy.testing.assert_array_equal` |
|
96
|
|
|
""" |
|
97
|
|
|
actual, desired = check_and_drop_units(actual, desired) |
|
98
|
|
|
numpy.testing.assert_array_equal(actual, desired) |
|
99
|
|
|
|
|
100
|
|
|
|
|
101
|
|
|
@pytest.fixture(scope='module', autouse=True) |
|
102
|
|
|
def set_agg_backend(): |
|
103
|
|
|
"""Fixture to ensure the Agg backend is active.""" |
|
104
|
|
|
import matplotlib.pyplot as plt |
|
105
|
|
|
prev_backend = plt.get_backend() |
|
106
|
|
|
try: |
|
107
|
|
|
plt.switch_backend('agg') |
|
108
|
|
|
yield |
|
109
|
|
|
finally: |
|
110
|
|
|
plt.switch_backend(prev_backend) |
|
111
|
|
|
|
|
112
|
|
|
|
|
113
|
|
|
@pytest.fixture(autouse=True) |
|
114
|
|
|
def patch_round(monkeypatch): |
|
115
|
|
|
"""Fixture to patch builtin round using numpy's. |
|
116
|
|
|
|
|
117
|
|
|
This works around the fact that built-in round changed between Python 2 and 3. This |
|
118
|
|
|
is probably not needed once we're testing on matplotlib 2.0, which has been updated |
|
119
|
|
|
to use numpy's throughout. |
|
120
|
|
|
""" |
|
121
|
|
|
monkeypatch.setitem(__builtins__, 'round', np.round) |
|
122
|
|
|
|
Unidata /
MetPy
