Skip to content

Commit a76cddd

Browse files
nstarmanclaude
andauthored
✅ test: 100% coverage across every package (#847)
Brings all ten packages to 100% statement + branch coverage. Five of the uncovered lines were uncovered *because* they were unreachable as written: - `_eval_dimension_node` returns a bare number for a numeric factor (`"2 * length"`) but was annotated `-> AbstractDimension`, so that arm always raised under runtime typechecking. - `StaticValue.__eq__`/`__ne__` return a `jax.Array` when compared to one; the annotation admitted only `bool | np.ndarray`. - `StaticValue.from_` took `cls: StaticValue` instead of `type[StaticValue]`, so `StaticValue.from_(quantity)` silently wrapped the quantity rather than rejecting it. - `_inv_jvp`'s zero-tangent arm called `ad.Zero.from_primal_value`, which this JAX no longer has; materialise the zero as `_det_jvp` does. - `cond_p_vq` returns a list (`cond_p` has `multiple_results=True`) but was annotated `-> ABCQ`. Dead code deleted rather than tested: a duplicate `lu_p_q` registration shadowed by the later one, and six unreachable guards in `unxts.linalg`/`unxts.interop.xarray` (rank-table `.get()` fallbacks whose tables are total, and re-checks of invariants enforced at construction). `# pragma: no branch` only where the outcome is version-dependent: the `hasattr(lax, "stack_p")` guard and `linear_solve_p`'s always-a-list result. CI now measures the src-doctest pass for parametric/linalg/xarray (`--cov` plus `--cov-append` on the tests pass); those doctests already ran, they just were not counted. Co-authored-by: Claude Opus 5 <[email protected]>
1 parent a3cf41f commit a76cddd

30 files changed

Lines changed: 721 additions & 88 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -435,8 +435,10 @@ jobs:
435435
run: |
436436
# src doctests: leaf dir `unxts/interop/xarray` shadows the installed
437437
# `xarray`, so sybil mis-imports it; use namespace-aware --doctest-modules.
438-
uv run --frozen --package unxts-interop-xarray pytest packages/unxts.interop.xarray/src --doctest-modules -o addopts="--import-mode=importlib" -o consider_namespace_packages=true -o doctest_optionflags="ELLIPSIS NORMALIZE_WHITESPACE"
439-
uv run --frozen --package unxts-interop-xarray pytest packages/unxts.interop.xarray/tests --cov=packages/unxts.interop.xarray/src --cov-report=xml --cov-report=term
438+
# Both invocations measure coverage (the second appends), so the
439+
# doctest-only lines are not reported as uncovered.
440+
uv run --frozen --package unxts-interop-xarray pytest packages/unxts.interop.xarray/src --doctest-modules -o addopts="--import-mode=importlib" -o consider_namespace_packages=true -o doctest_optionflags="ELLIPSIS NORMALIZE_WHITESPACE" --cov=packages/unxts.interop.xarray/src --cov-report=
441+
uv run --frozen --package unxts-interop-xarray pytest packages/unxts.interop.xarray/tests --cov=packages/unxts.interop.xarray/src --cov-append --cov-report=xml --cov-report=term
440442
441443
- name: Upload coverage report
442444
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
@@ -488,8 +490,8 @@ jobs:
488490
# src doctests and tests are collected in separate invocations: the
489491
# namespace package's leaf dir is imported under one name for src and
490492
# another for tests, so co-collecting them double-imports the module.
491-
uv run --frozen --package unxts-parametric pytest packages/unxts.parametric/src
492-
uv run --frozen --package unxts-parametric pytest packages/unxts.parametric/tests --cov=packages/unxts.parametric/src --cov-report=xml --cov-report=term
493+
uv run --frozen --package unxts-parametric pytest packages/unxts.parametric/src --cov=packages/unxts.parametric/src --cov-report=
494+
uv run --frozen --package unxts-parametric pytest packages/unxts.parametric/tests --cov=packages/unxts.parametric/src --cov-append --cov-report=xml --cov-report=term
493495
494496
- name: Upload coverage report
495497
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
@@ -531,8 +533,8 @@ jobs:
531533
# src doctests and tests are collected in separate invocations: the
532534
# namespace package's leaf dir is imported under one name for src and
533535
# another for tests, so co-collecting them double-imports the module.
534-
uv run --frozen --package unxts-linalg pytest packages/unxts.linalg/src
535-
uv run --frozen --package unxts-linalg pytest packages/unxts.linalg/tests --cov=packages/unxts.linalg/src --cov-report=xml --cov-report=term
536+
uv run --frozen --package unxts-linalg pytest packages/unxts.linalg/src --cov=packages/unxts.linalg/src --cov-report=
537+
uv run --frozen --package unxts-linalg pytest packages/unxts.linalg/tests --cov=packages/unxts.linalg/src --cov-append --cov-report=xml --cov-report=term
536538
537539
- name: Upload coverage report
538540
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0

‎packages/unxts.api/src/unxts/api/_src/quantity.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def is_unit_convertible(to_unit: Any, from_: Any, /) -> bool:
106106
False
107107
108108
"""
109-
return False
109+
raise NotImplementedError # pragma: no cover
110110

111111

112112
@plum.dispatch.abstract

‎packages/unxts.api/tests/test_public_api.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,13 @@ def test_dispatch_functions_are_callable():
1717

1818
def test_version_is_a_string():
1919
assert isinstance(unxts.api.__version__, str)
20+
21+
22+
def test_wrap_to_keyword_form_redirects_to_positional():
23+
"""``wrap_to(x, min=..., max=...)`` forwards to the positional method."""
24+
25+
@unxts.api.wrap_to.dispatch
26+
def _(x: int, min: int, max: int, /) -> tuple:
27+
return (x, min, max)
28+
29+
assert unxts.api.wrap_to(1, min=2, max=3) == (1, 2, 3)

‎packages/unxts.hypothesis/tests/test_public_api.py‎

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
"""Smoke tests for the unxts.hypothesis public API."""
22

3+
import pytest
34
import unxts.hypothesis
4-
from hypothesis import given
5+
from hypothesis import given, strategies as st
56

67
import unxt as u
78

@@ -18,3 +19,63 @@ def test_version_is_a_string():
1819
@given(q=unxts.hypothesis.quantities(unit="km/s"))
1920
def test_a_strategy_produces_a_quantity(q):
2021
assert q.unit == u.unit("km/s")
22+
23+
24+
@given(dim=unxts.hypothesis.named_dimensions())
25+
def test_named_dimensions_strategy(dim):
26+
assert u.dimension_of(dim) is dim
27+
28+
29+
@given(unit=unxts.hypothesis.units("length"))
30+
def test_units_strategy(unit):
31+
assert u.dimension_of(unit) == u.dimension("length")
32+
33+
34+
# The strategy builds a unit system, and beartype (enabled in this suite via
35+
# `UNXT_ENABLE_RUNTIME_TYPECHECKING`) samples container items with the global
36+
# `random`, which Hypothesis deprecates inside a strategy. Not our randomness.
37+
@pytest.mark.filterwarnings("ignore::hypothesis.errors.HypothesisDeprecationWarning")
38+
@given(usys=unxts.hypothesis.unitsystems("m", "s", "kg", "rad"))
39+
def test_unitsystems_strategy(usys):
40+
assert isinstance(usys, u.AbstractUnitSystem)
41+
42+
43+
@given(angle=unxts.hypothesis.angles())
44+
def test_angles_strategy(angle):
45+
assert isinstance(angle, u.Angle)
46+
47+
48+
@given(
49+
angle=unxts.hypothesis.angles(
50+
wrap_to=st.just((u.Q(0, "deg"), u.Q(360, "deg"))), unit="deg"
51+
)
52+
)
53+
def test_angles_strategy_wrapped(angle):
54+
assert 0 <= float(angle.ustrip("deg")) < 360
55+
56+
57+
@given(
58+
q=unxts.hypothesis.wrap_to(
59+
unxts.hypothesis.quantities("deg"),
60+
min=st.just(u.Q(0, "deg")),
61+
max=st.just(u.Q(360, "deg")),
62+
)
63+
)
64+
def test_wrap_to_strategy(q):
65+
assert 0 <= float(q.ustrip("deg")) < 360
66+
67+
68+
@given(unit=unxts.hypothesis.derived_units("m", max_complexity=0))
69+
def test_derived_units_without_compound_factors(unit):
70+
assert u.dimension_of(unit) == u.dimension("length")
71+
72+
73+
@given(unit=unxts.hypothesis.derived_units("m", integer_powers=False))
74+
def test_derived_units_with_fractional_powers(unit):
75+
assert u.dimension_of(unit) == u.dimension("length")
76+
77+
78+
@given(unit=unxts.hypothesis.derived_units("m*s*kg*A*K*mol*cd*rad"))
79+
def test_derived_units_when_every_si_base_is_used(unit):
80+
"""No SI base is left over to build a cancelling factor from."""
81+
assert u.dimension_of(unit) == u.dimension_of(u.unit("m*s*kg*A*K*mol*cd*rad"))

‎packages/unxts.interop.gala/tests/test_conversion.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ def test_round_trip():
2828
# gala's ``UnitSystem.__eq__`` also compares derived/registered units, so
2929
# compare the base units that the conversion round-trips.
3030
assert round_tripped._core_units == usys._core_units
31+
32+
33+
def test_gala_dimensionless_to_unxt():
34+
assert u.unitsystem(gu.DimensionlessUnitSystem()) == u.unitsystems.dimensionless

‎packages/unxts.interop.matplotlib/tests/test_converter.py‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,25 @@ def test_imshow_with_quantity_extent():
4747
assert "mas" in ax.get_xlabel()
4848
finally:
4949
plt.close(fig)
50+
51+
52+
def test_default_units_from_a_quantity():
53+
"""A quantity carries its own unit; no unwrapping needed."""
54+
converter = uimpl.UnxtConverter()
55+
assert converter.default_units(u.Q([1.0, 2.0], "mas"), None) == u.unit("mas")
56+
57+
58+
def test_default_units_of_a_bare_scalar_is_none():
59+
"""A plain scalar has no unit and is not iterable."""
60+
converter = uimpl.UnxtConverter()
61+
assert converter.default_units(1.0, None) is None
62+
63+
64+
def test_setup_can_be_disabled_and_re_enabled():
65+
"""Disabling removes the converter from matplotlib's registry."""
66+
try:
67+
uimpl.setup_matplotlib_support_for_unxt(enable=False)
68+
assert u.quantity.AbstractQuantity not in matplotlib.units.registry
69+
finally:
70+
uimpl.setup_matplotlib_support_for_unxt()
71+
assert u.quantity.AbstractQuantity in matplotlib.units.registry

‎packages/unxts.interop.xarray/src/unxts/interop/xarray/_src/accessors.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ def quantify(
152152
for name in set(list(unit_attrs.keys()) + list(units.keys())):
153153
if name in units:
154154
final_units[name] = units[name]
155-
elif name in unit_attrs:
155+
else: # the loop walks the union, so it must be a unit attribute
156156
final_units[name] = unit_attrs[name]
157157

158158
# Attach units
@@ -200,7 +200,7 @@ def dequantify(
200200
# Format units as strings for attributes
201201
unit_strs: dict[Hashable, str] = {}
202202
for name, unit in units.items():
203-
if unit is not None:
203+
if unit is not None: # pragma: no branch -- never extracted as None
204204
if format is not None:
205205
unit_strs[name] = builtins.format(unit, format)
206206
else:
@@ -213,7 +213,7 @@ def dequantify(
213213
for name, unit_str in unit_strs.items():
214214
if name is None:
215215
continue
216-
if name in stripped.coords:
216+
if name in stripped.coords: # pragma: no branch -- keys are coords
217217
stripped.coords[name].attrs[unit_attribute] = unit_str
218218

219219
return stripped
@@ -311,7 +311,7 @@ def quantify(
311311
for name in set(list(unit_attrs.keys()) + list(units.keys())):
312312
if name in units:
313313
final_units[name] = units[name]
314-
elif name in unit_attrs:
314+
else: # the loop walks the union, so it must be a unit attribute
315315
final_units[name] = unit_attrs[name]
316316

317317
# Attach units
@@ -360,7 +360,7 @@ def dequantify(
360360
# Format units as strings for attributes
361361
unit_strs: dict[Hashable, str] = {}
362362
for name, unit in units.items():
363-
if unit is not None:
363+
if unit is not None: # pragma: no branch -- never extracted as None
364364
if format is not None:
365365
unit_strs[name] = builtins.format(unit, format)
366366
else:
@@ -370,7 +370,7 @@ def dequantify(
370370
for name, unit_str in unit_strs.items():
371371
if name in stripped.data_vars:
372372
stripped[name].attrs[unit_attribute] = unit_str
373-
elif name in stripped.coords:
373+
else: # a variable that is not a data var is a coordinate
374374
stripped.coords[name].attrs[unit_attribute] = unit_str
375375

376376
return stripped
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
"""Edge cases of the unxts.interop.xarray accessors and conversion helpers."""
2+
3+
import pytest
4+
import unxts.interop.xarray as ux
5+
import xarray as xr
6+
7+
import unxt as u
8+
9+
10+
@pytest.mark.parametrize(
11+
("fn", "match"),
12+
[
13+
(ux.extract_unit_attributes, "Cannot extract unit attributes from type"),
14+
(ux.extract_units, "Cannot extract units from type"),
15+
],
16+
)
17+
def test_extract_from_an_unsupported_type(fn, match):
18+
with pytest.raises(TypeError, match=match):
19+
fn(object())
20+
21+
22+
def test_attach_units_to_an_unsupported_type():
23+
with pytest.raises(TypeError, match="Cannot attach units to type"):
24+
ux.attach_units(object(), {None: "m"})
25+
26+
27+
def test_strip_units_from_an_unsupported_type():
28+
with pytest.raises(TypeError, match="Cannot strip units from type"):
29+
ux.strip_units(object())
30+
31+
32+
def test_quantify_rejects_a_bad_units_argument():
33+
da = xr.DataArray([1.0, 2.0], dims=["x"])
34+
with pytest.raises(TypeError, match="units must be a string"):
35+
da.unxt.quantify(1.0)
36+
37+
38+
def test_extract_units_of_an_unquantified_dataarray():
39+
"""Nothing carries a unit, so nothing is extracted."""
40+
da = xr.DataArray([1.0, 2.0], dims=["i"], coords={"i": [0, 1]})
41+
assert ux.extract_units(da) == {}
42+
assert ux.extract_units(xr.Dataset({"a": ("x", [1.0, 2.0])})) == {}
43+
44+
45+
def _dataarray_with_coord_units() -> xr.DataArray:
46+
return xr.DataArray(
47+
[1.0, 2.0],
48+
dims=["i"],
49+
coords={"i": [0, 1], "x": ("i", [0.0, 1.0], {"units": "s"})},
50+
attrs={"units": "m"},
51+
).unxt.quantify()
52+
53+
54+
def test_dataarray_round_trip_with_coordinate_units():
55+
"""Coordinate units survive quantify -> dequantify on a DataArray."""
56+
q = _dataarray_with_coord_units()
57+
assert ux.extract_units(q)["x"] == u.unit("s")
58+
59+
back = q.unxt.dequantify()
60+
assert back.attrs["units"] == "m"
61+
assert back.coords["x"].attrs["units"] == "s"
62+
63+
64+
def test_dequantify_honours_the_format_spec():
65+
"""``format`` is forwarded to ``builtins.format`` for the unit string."""
66+
q = _dataarray_with_coord_units()
67+
back = q.unxt.dequantify(format="latex")
68+
assert back.attrs["units"] == format(u.unit("m"), "latex")
69+
70+
71+
def test_dataset_quantify_with_explicit_units_mapping():
72+
"""An explicit mapping overrides (and supplements) the ``units`` attributes."""
73+
ds = xr.Dataset({"a": ("x", [1.0, 2.0], {"units": "m"}), "b": ("x", [3.0, 4.0])})
74+
q = ds.unxt.quantify({"b": "s"})
75+
assert u.unit_of(q["a"].data) == u.unit("m")
76+
assert u.unit_of(q["b"].data) == u.unit("s")
77+
78+
79+
def test_dataset_round_trip_with_coordinate_units():
80+
"""Coordinate units survive quantify -> dequantify on a Dataset."""
81+
ds = xr.Dataset(
82+
{"a": ("i", [1.0, 2.0], {"units": "m"})},
83+
coords={"i": [0, 1], "x": ("i", [0.0, 1.0], {"units": "s"})},
84+
)
85+
q = ds.unxt.quantify()
86+
back = q.unxt.dequantify(format="latex")
87+
assert back["a"].attrs["units"] == format(u.unit("m"), "latex")
88+
assert back.coords["x"].attrs["units"] == format(u.unit("s"), "latex")
89+
90+
91+
def test_dequantify_a_dataarray_whose_data_has_no_unit():
92+
"""Only the coordinate carries a unit, so no data-level ``units`` attribute."""
93+
da = xr.DataArray(
94+
[1.0, 2.0],
95+
dims=["i"],
96+
coords={"i": [0, 1], "x": ("i", [0.0, 1.0], {"units": "s"})},
97+
).unxt.quantify()
98+
back = da.unxt.dequantify()
99+
assert "units" not in back.attrs
100+
assert back.coords["x"].attrs["units"] == "s"

‎packages/unxts.linalg/src/unxts/linalg/_src/_inv.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
import jax
1616
import jax.numpy as jnp
1717
import quax
18+
from jax import lax
1819
from jax.extend import core as jexc
1920
from jax.interpreters import ad as jax_ad, batching as jax_batching, mlir as jax_mlir
2021
from jaxtyping import Array
@@ -135,7 +136,9 @@ def _inv_jvp(primals: tuple, tangents: tuple) -> tuple[Array, Array]:
135136
(dx,) = tangents
136137
primal_out = inv_p.bind(x)
137138
if type(dx) is jax_ad.Zero:
138-
tangent_out = jax_ad.Zero.from_primal_value(primal_out) # ty: ignore[unresolved-attribute]
139+
# Materialise the zero (as `_det_jvp` does): `Zero.from_primal_value`
140+
# is not part of the supported jax API.
141+
tangent_out = lax.full_like(primal_out, 0.0)
139142
else:
140143
tangent_out = -primal_out @ dx @ primal_out
141144
return primal_out, tangent_out

‎packages/unxts.linalg/src/unxts/linalg/_src/_quantity_matrix.py‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -291,9 +291,9 @@ def __matmul__(self, other: Any) -> Any:
291291
292292
"""
293293
if isinstance(other, QuantityMatrix):
294-
product = _PRODUCT_BY_RANK.get((self.unit.ndim, other.unit.ndim))
295-
if product is not None:
296-
return product(self, other)
294+
# A `UnitsMatrix` is 1-D or 2-D by construction, so every rank pair
295+
# is in the table.
296+
return _PRODUCT_BY_RANK[(self.unit.ndim, other.unit.ndim)](self, other)
297297
return super().__matmul__(other)
298298

299299
# ── Quax API ─────────────────────────────────────────────────────
@@ -497,6 +497,8 @@ def QuantityMatrix_to_quantity(x: QuantityMatrix, /) -> u.Q:
497497
"""
498498
units = x.unit._units.ravel()
499499

500+
# An empty `UnitsMatrix` is constructible (see `UnitsMatrix.__pow__`), and
501+
# `is_uniform` is vacuously true for it, so this must come first.
500502
if units.size == 0:
501503
msg = "Cannot convert QuantityMatrix with no unit entries."
502504
raise ValueError(msg)
@@ -518,12 +520,10 @@ def _convert_value(
518520
"""Convert value with heterogeneous units (works for both 1D and 2D)."""
519521
from_tup = from_units.to_tuple()
520522
to_tup = to_units.to_tuple()
523+
# A `UnitsMatrix` is 1-D or 2-D by construction.
521524
if from_units.ndim == 1:
522525
return _convert_value_vector(value, from_tup, to_tup)
523-
if from_units.ndim == 2:
524-
return _convert_value_matrix(value, from_tup, to_tup)
525-
msg = f"Unsupported ndim={from_units.ndim}"
526-
raise NotImplementedError(msg)
526+
return _convert_value_matrix(value, from_tup, to_tup)
527527

528528

529529
@plum.dispatch

0 commit comments

Comments
 (0)