"""
pint.testing
~~~~~~~~~~~~
Functions for testing whether pint quantities are equal.
:copyright: 2016 by Pint Authors, see AUTHORS for more details..
:license: BSD, see LICENSE for more details.
"""
from __future__ import annotations
import math
import warnings
from numbers import Number
from . import Quantity
from .compat import ndarray
try:
import numpy as np
except ImportError:
np = None
def _get_comparable_magnitudes(first, second, msg):
if isinstance(first, Quantity) and isinstance(second, Quantity):
ctx = first._REGISTRY._active_ctx.contexts
if first.is_compatible_with(second, *ctx):
second = second.to(first)
assert first.units == second.units, msg + " Units are not equal."
m1, m2 = first.magnitude, second.magnitude
elif isinstance(first, Quantity):
assert first.dimensionless, msg + " The first is not dimensionless."
first = first.to("")
m1, m2 = first.magnitude, second
elif isinstance(second, Quantity):
assert second.dimensionless, msg + " The second is not dimensionless."
second = second.to("")
m1, m2 = first, second.magnitude
else:
m1, m2 = first, second
return m1, m2
[docs]
def assert_equal(first, second, msg: str | None = None) -> None:
"""
Assert that two quantities are equal
Parameters
----------
first
First quantity to compare
second
Second quantity to compare
msg
If supplied, message to show if the two quantities aren't equal.
Raises
------
AssertionError
The two quantities are not equal.
"""
if msg is None:
msg = f"Comparing {first!r} and {second!r}. "
m1, m2 = _get_comparable_magnitudes(first, second, msg)
msg += f" (Converted to {m1!r} and {m2!r}): Magnitudes are not equal"
if isinstance(m1, ndarray) or isinstance(m2, ndarray):
np.testing.assert_array_equal(m1, m2, err_msg=msg)
elif not isinstance(m1, Number):
warnings.warn(
f"In assert_equal, m1 is not a number {first} ({m1}) vs. {second} ({m2}) ",
UserWarning,
)
return
elif not isinstance(m2, Number):
warnings.warn(
f"In assert_equal, m2 is not a number {first} ({m1}) vs. {second} ({m2}) ",
UserWarning,
)
return
elif math.isnan(m1):
assert math.isnan(m2), msg
elif math.isnan(m2):
assert math.isnan(m1), msg
else:
assert m1 == m2, msg
[docs]
def assert_allclose(
first, second, rtol: float = 1e-07, atol: float = 0, msg: str | None = None
) -> None:
"""
Assert that two quantities are all close
Unlike numpy, this uses a symmetric check of closeness.
Parameters
----------
first
First quantity to compare
second
Second quantity to compare
rtol
Relative tolerance to use when checking for closeness.
atol
Absolute tolerance to use when checking for closeness.
msg
If supplied, message to show if the two quantities aren't equal.
Raises
------
AssertionError
The two quantities are not close to within the supplied tolerance.
"""
if msg is None:
try:
msg = f"Comparing {first!r} and {second!r}. "
except (TypeError, ValueError):
try:
msg = f"Comparing {first} and {second}. "
except Exception:
msg = "Comparing"
m1, m2 = _get_comparable_magnitudes(first, second, msg)
msg += f" (Converted to {m1!r} and {m2!r})"
if isinstance(m1, ndarray) or isinstance(m2, ndarray):
np.testing.assert_allclose(m1, m2, rtol=rtol, atol=atol, err_msg=msg)
elif not isinstance(m1, Number):
warnings.warn(
f"In assert_equal, m1 is not a number {first} ({m1}) vs. {second} ({m2}) ",
UserWarning,
)
return
elif not isinstance(m2, Number):
warnings.warn(
f"In assert_equal, m1 is not a number {first} ({m1}) vs. {second} ({m2}) ",
UserWarning,
)
return
elif math.isnan(m1):
assert math.isnan(m2), msg
elif math.isnan(m2):
assert math.isnan(m1), msg
elif math.isinf(m1):
assert math.isinf(m2), msg
elif math.isinf(m2):
assert math.isinf(m1), msg
else:
# Numpy version (don't like because is not symmetric)
# assert abs(m1 - m2) <= atol + rtol * abs(m2), msg
assert abs(m1 - m2) <= max(rtol * max(abs(m1), abs(m2)), atol), msg
