xarray-annotated 0.5.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

xarray_annotated/__init__.py

@@ -1,4 +1,4 @@
-"""xarray-annotated: validate xarray DataArray properties declared via ``typing.Annotated``.
+"""xarray-annotated: validate DataArray properties declared via ``typing.Annotated``.
 
 Annotation is the unifying technology: a declared property is read off an
 ``Annotated[DataArray, ...]`` hint and validated at runtime.  Each kind of

xarray_annotated/_annotations.py

@@ -14,7 +14,6 @@ from collections.abc import Callable
 from typing import (
     Annotated,
     Any,
-    TypeVar,
     Union,
     get_args,
     get_origin,
@@ -24,8 +23,6 @@ from typing import (
 
 import xarray as xr
 
-_T = TypeVar("_T")
-
 
 def unwrap_annotated(hint: Any) -> Any:
     """Return the underlying type of an `Annotated` hint, else the hint itself.
@@ -44,30 +41,40 @@ def unwrap_annotated(hint: Any) -> Any:
 
 
 def _is_dataarray_type(tp: Any) -> bool:
-    """Return whether `tp` is `DataArray` (possibly wrapped in a Union).
+    """Return whether `tp` is `DataArray` (possibly wrapped or in a Union).
 
     Accepts a bare `DataArray` as well as `DataArray | None` /
     `Optional[DataArray]` (and any other union that includes `DataArray`), so an
     optional DataArray parameter can still carry a declaration.  Anything else
     (scalars, `str`, `bool`, `Dataset`, …) is not a declaration-bearing type.
 
+    Also accepts any *array-type wrapper* that exposes the underlying array class
+    as an `array_type` attribute — notably jaxtyping's `Float[DataArray, "t x"]`,
+    which occupies the base-type slot of an `Annotated` hint rather than competing
+    with it.  This is a duck-typed check: jaxtyping is never imported, and any
+    other library following the same convention composes for free.  See
+    `docs/guides/jaxtyping.md`.
+
     Args:
         tp: A type annotation to inspect.
 
     Returns:
-        `True` if `tp` is or contains `DataArray`.
+        `True` if `tp` is, wraps, or contains `DataArray`.
     """
     if tp is xr.DataArray:
         return True
+    inner = getattr(tp, "array_type", None)
+    if isinstance(inner, type) and issubclass(inner, xr.DataArray):
+        return True
     if get_origin(tp) in (Union, types.UnionType):
         return any(_is_dataarray_type(arg) for arg in get_args(tp))
     return False
 
 
-def walk_signature(
+def walk_signature[T](
     func: object,
-    extract: Callable[[Any], _T | None],
-) -> tuple[dict[str, _T], dict[str, _T] | _T | None]:
+    extract: Callable[[Any], T | None],
+) -> tuple[dict[str, T], dict[str, T] | T | None]:
     """Extract per-parameter and return declarations from a function's hints.
 
     Reads `get_type_hints(func, include_extras=True)` and maps each hint through
@@ -98,7 +105,7 @@ def walk_signature(
         if (payload := extract(hint)) is not None
     }
 
-    output: dict[str, _T] | _T | None
+    output: dict[str, T] | T | None
     if is_typeddict(ret):
         ret_hints = get_type_hints(ret, include_extras=True)
         output = {

xarray_annotated/_config.py

@@ -19,7 +19,6 @@ live here.
 
 import os
 from collections.abc import Callable
-from typing import TypeVar
 
 #: Master switch default. Validation is on unless explicitly disabled.
 DEFAULT_ENABLED: bool = True
@@ -35,8 +34,6 @@ _FALSEY: frozenset[str] = frozenset({"0", "false", "no", "off"})
 #: Process-wide override for the master switch, shared across all domains.
 _process_enabled: bool | None = None
 
-_T = TypeVar("_T")
-
 
 class _Unset:
     """Sentinel distinguishing 'argument omitted' from 'explicitly set to None'."""
@@ -48,12 +45,12 @@ class _Unset:
 _UNSET = _Unset()
 
 
-def _resolve(
+def _resolve[T](
     env_var: str,
-    process_value: _T | None,
-    default: _T,
-    parse: Callable[[str], _T],
-) -> _T:
+    process_value: T | None,
+    default: T,
+    parse: Callable[[str], T],
+) -> T:
     """Resolve one axis: env var (parsed) → process override → default."""
     env = os.environ.get(env_var)
     if env:

xarray_annotated/schema/__init__.py

@@ -13,8 +13,9 @@ Declare several at once inside ``Annotated`` and apply them with ``declare_schem
     from xarray_annotated.schema import declare_schema, Dims, Dtype
 
     @declare_schema
-    def f(x: Annotated[xr.DataArray, Dims("time", "x"), Dtype("float64")]) -> xr.DataArray:
-        ...
+    def f(
+        x: Annotated[xr.DataArray, Dims("time", "x"), Dtype("float64")],
+    ) -> xr.DataArray: ...
 """
 
 from ._annotations import (

xarray_annotated/schema/_annotations.py

@@ -48,7 +48,7 @@ class Dims:
     _names: tuple[str, ...]
     _ordered: bool
     _on_mismatch: OnMismatch | None
-    __slots__ = ("_names", "_ordered", "_on_mismatch")
+    __slots__ = ("_names", "_on_mismatch", "_ordered")
 
     def __init__(
         self,

xarray_annotated/schema/_config.py

@@ -20,11 +20,11 @@ from dataclasses import dataclass
 from typing import Literal
 
 from .._config import (
+    _UNSET,
     DEFAULT_ENABLED,
     ENABLED_ENV_VAR,
     _resolve,
     _Unset,
-    _UNSET,
     get_enabled_override,
     resolve_enabled,
     set_enabled_override,
@@ -100,8 +100,8 @@ def get_policy() -> Policy:
 
 def set_policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_mismatch: OnMismatch | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_mismatch: OnMismatch | _Unset | None = _UNSET,
 ) -> None:
     """Set process-wide schema-policy overrides for one or more axes.
 
@@ -125,8 +125,8 @@ def set_policy(
 @contextmanager
 def policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_mismatch: OnMismatch | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_mismatch: OnMismatch | _Unset | None = _UNSET,
 ):
     """Temporarily override schema-policy axes, restoring them on exit.
 

xarray_annotated/schema/_decorator.py

@@ -44,8 +44,8 @@ def declare_schema(
     default).  When the policy is **disabled** the wrapper is a total no-op.
 
     Usable bare (`@declare_schema`) or called (`@declare_schema(on_mismatch=...)`).
-    Every marker declaration is validated **at decoration time** (`assert_valid_schema`),
-    so a malformed declaration fails fast at import.
+    Every marker declaration is validated **at decoration time**
+    (`assert_valid_schema`), so a malformed declaration fails fast at import.
 
     Args:
         func: The function to decorate (when used bare); `None` when parametrised.
@@ -91,7 +91,8 @@ def declare_schema(
             if not pol.enabled:
                 # Master switch off: a total no-op (no validation at all).
                 return fn(*args, **kwargs)
-            # Per-call default severity (a marker's own override still wins in check_schema).
+            # Per-call default severity (a marker's own override still wins
+            # inside check_schema).
             eff = on_mismatch if on_mismatch is not None else pol.on_mismatch
             if input_markers:
                 bound = sig.bind_partial(*args, **kwargs)

xarray_annotated/temporal/__init__.py

@@ -16,7 +16,9 @@ the classic resample footgun of a series landing on Wednesdays::
     from xarray_annotated.temporal import declare_freq, Freq
 
     @declare_freq
-    def weekly_mean(x: Annotated[xr.DataArray, Freq("D")]) -> Annotated[xr.DataArray, Freq("W-SUN")]:
+    def weekly_mean(
+        x: Annotated[xr.DataArray, Freq("D")],
+    ) -> Annotated[xr.DataArray, Freq("W-SUN")]:
         return x.resample(time="W-SUN").mean()
 
 ``freq_compatible`` is the same comparison with no array in hand, for a build-time

xarray_annotated/temporal/_annotations.py

@@ -55,7 +55,7 @@ class Freq:
     _dim: str | None
     _anchored: bool | None
     _on_mismatch: OnMismatch | None
-    __slots__ = ("_freq", "_dim", "_anchored", "_on_mismatch")
+    __slots__ = ("_anchored", "_dim", "_freq", "_on_mismatch")
 
     def __init__(
         self,

xarray_annotated/temporal/_config.py

@@ -24,11 +24,11 @@ from dataclasses import dataclass
 from typing import Literal
 
 from .._config import (
+    _UNSET,
     DEFAULT_ENABLED,
     ENABLED_ENV_VAR,
     _resolve,
     _Unset,
-    _UNSET,
     get_enabled_override,
     resolve_enabled,
     set_enabled_override,
@@ -127,9 +127,9 @@ def get_policy() -> Policy:
 
 def set_policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_mismatch: OnMismatch | None | _Unset = _UNSET,
-    on_uninferable: OnUninferable | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_mismatch: OnMismatch | _Unset | None = _UNSET,
+    on_uninferable: OnUninferable | _Unset | None = _UNSET,
 ) -> None:
     """Set process-wide temporal-policy overrides for one or more axes.
 
@@ -158,9 +158,9 @@ def set_policy(
 @contextmanager
 def policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_mismatch: OnMismatch | None | _Unset = _UNSET,
-    on_uninferable: OnUninferable | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_mismatch: OnMismatch | _Unset | None = _UNSET,
+    on_uninferable: OnUninferable | _Unset | None = _UNSET,
 ):
     """Temporarily override temporal-policy axes, restoring them on exit.
 

xarray_annotated/units/_check.py

@@ -425,13 +425,13 @@ def _apply_output_quantified(
         return da
     if equal:
         return da
-    if on_output == "strict":
-        if units_compatible(label, declared):
-            raise ValueError(
-                f"{prefix}output {name!r}: unit {label!r} differs from declared "
-                f"{declared!r} and on_output='strict' requires them to match"
-            )
-        # Fall through: the conversion below raises DimensionalityError for us.
+    # Only *compatible* units raise here; an incompatible label falls through to the
+    # conversion below, which raises DimensionalityError for us.
+    if on_output == "strict" and units_compatible(label, declared):
+        raise ValueError(
+            f"{prefix}output {name!r}: unit {label!r} differs from declared "
+            f"{declared!r} and on_output='strict' requires them to match"
+        )
     try:
         return da.pint.to(declared)
     except PintExceptionGroup as group:

xarray_annotated/units/_config.py

@@ -31,11 +31,11 @@ from dataclasses import dataclass
 from typing import Literal
 
 from .._config import (
+    _UNSET,
     DEFAULT_ENABLED,
     ENABLED_ENV_VAR,
     _resolve,
     _Unset,
-    _UNSET,
     get_enabled_override,
     resolve_enabled,
     set_enabled_override,
@@ -152,10 +152,10 @@ def get_policy() -> Policy:
 
 def set_policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_missing: OnMissing | None | _Unset = _UNSET,
-    on_inexact: OnInexact | None | _Unset = _UNSET,
-    on_output: OnOutput | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_missing: OnMissing | _Unset | None = _UNSET,
+    on_inexact: OnInexact | _Unset | None = _UNSET,
+    on_output: OnOutput | _Unset | None = _UNSET,
 ) -> None:
     """Set process-wide policy overrides for one or more axes.
 
@@ -189,10 +189,10 @@ def set_policy(
 @contextmanager
 def policy(
     *,
-    enabled: bool | None | _Unset = _UNSET,
-    on_missing: OnMissing | None | _Unset = _UNSET,
-    on_inexact: OnInexact | None | _Unset = _UNSET,
-    on_output: OnOutput | None | _Unset = _UNSET,
+    enabled: bool | _Unset | None = _UNSET,
+    on_missing: OnMissing | _Unset | None = _UNSET,
+    on_inexact: OnInexact | _Unset | None = _UNSET,
+    on_output: OnOutput | _Unset | None = _UNSET,
 ):
     """Temporarily override policy axes, restoring all of them on exit.
 

xarray_annotated/units/_decorator.py

@@ -199,5 +199,6 @@ def declare_units(
         return wrapper
 
     # @declare_units  →  func is the decorated function;
-    # @declare_units(on_missing=...)  →  func is None, return the parametrised decorator.
+    # @declare_units(on_missing=...)  →  func is None, return the parametrised
+    # decorator.
     return decorate if func is None else decorate(func)

{xarray_annotated-0.5.2.dist-info → xarray_annotated-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xarray-annotated
-Version: 0.5.2
+Version: 0.6.0
 Summary: Run-time validation of xarray DataArray properties (units, dims/coords/dtype) declared via typing.Annotated
 Keywords: xarray,pint,units,validation,annotations
 Author: jmarshrossney
@@ -78,10 +78,12 @@ It assumes a unit (pascals) and says so in the docstring but doesn't check or en
 ```python
 import xarray as xr
 
+
 def altitude(p: xr.DataArray) -> xr.DataArray:
     """Barometric altitude. Assumes p is in Pa."""
     return 44330.0 * (1.0 - (p / 101325.0) ** 0.1903)
 
+
 p = xr.DataArray([1013.0, 1000.0], dims=["time"], attrs={"units": "hPa"})
 altitude(p)
 ```
@@ -104,6 +106,7 @@ import xarray as xr
 from xarray_annotated.schema import declare_schema, Dims
 from xarray_annotated.units import declare_units, Unit
 
+
 @declare_units
 @declare_schema
 def altitude(
@@ -112,6 +115,7 @@ def altitude(
     """Barometric altitude."""
     return 44330.0 * (1.0 - (p / 101325.0) ** 0.1903)
 
+
 p = xr.DataArray([1013.0, 1000.0], dims=["time"], attrs={"units": "hPa"})
 altitude(p)
 ```

xarray_annotated-0.6.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+xarray_annotated/__init__.py,sha256=ht5hPD7C3sg_TBCP6V2b3hzckytcL5wrbH4y9eet8Ok,2033
+xarray_annotated/_annotations.py,sha256=PTr693OmIxBqFT_77cAscO-uT0FDrkGK42Rdl3ipzQs,4611
+xarray_annotated/_config.py,sha256=JkSP9GIjVy45IUnQXCvY1qg1FoO49vHwTUNjSUB_U8o,3375
+xarray_annotated/_reader.py,sha256=UBmneo6B8aAeK0xWTVy6zDMdm-PaoDH5Pi7hF28UHKA,4857
+xarray_annotated/_writer.py,sha256=BsEUVK3YfZi8QEf8Hz31pYkfO8-WRBP7fcMNbpPCak0,4172
+xarray_annotated/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xarray_annotated/schema/__init__.py,sha256=Podg0xG-oAP2m6M0YftRr1ETV7SKZzyxzi5NC6yfagM,1489
+xarray_annotated/schema/_annotations.py,sha256=1_slbAJvmo0GXPuecGqXgKLuVFqQCq8bpKzQqtQDU0c,8723
+xarray_annotated/schema/_check.py,sha256=oU5Ayx4nDr-VBlnhmj2n46-AEyrHp_wJj17BlJTxq9U,9017
+xarray_annotated/schema/_config.py,sha256=LSuhTkVpk3yPM7xGaOWPqZIlFnDI1MNTSy25V4oiJug,4736
+xarray_annotated/schema/_decorator.py,sha256=s_AlTKIBFNhiBFRC_K6LkkGeXuZMmxMmJNQZ6sKgvY4,5657
+xarray_annotated/temporal/__init__.py,sha256=QyLAb0OQDBdoj-89YQ84Ct5aETufrxfgxBi5c28o2FM,1797
+xarray_annotated/temporal/_annotations.py,sha256=gO0Ne_Ui7LTCyE33cklJPBQY18bBRxhaW3W4okNIceY,5757
+xarray_annotated/temporal/_check.py,sha256=4Xn8YkxkevSFSMXS_Uq_loLpB1UiGu1GgH-YKIoBII0,13253
+xarray_annotated/temporal/_config.py,sha256=GnEkAiRV2QfQO3J776HKTWKJyGigh1mT9Ck0u1SCiU8,6642
+xarray_annotated/temporal/_decorator.py,sha256=t70bNlOkEprCA-8rhy4ZAgb-_kqRzKOMbf4h4df2dm4,5930
+xarray_annotated/units/__init__.py,sha256=rzFW1KdrCydAnul5pQJW4aRpR-BmINF0b7Ul-g0C_Rs,1018
+xarray_annotated/units/_annotations.py,sha256=dfKEzxTJ4s5yaXI8ypT0gQtyIDXZl6yzmi_CeciIzk8,6516
+xarray_annotated/units/_check.py,sha256=IdJT6jZ1JWApNGeMDMw7iyt-ukntJdRCHpKeyoquy5o,25636
+xarray_annotated/units/_config.py,sha256=O0P1RpTIVocDmJinpSa4RMP6ULKWw-GGo0E_ZaGjfSU,8739
+xarray_annotated/units/_decorator.py,sha256=2lo4JjNAE08LemLffDpZp0DhWyKiwbygVWhOzQYCITs,9477
+xarray_annotated/units/_registry.py,sha256=SGzhwLNmCGoR92UobeUpMxKMft8IodyyXWe9h6pZSQQ,3313
+xarray_annotated-0.6.0.dist-info/licenses/LICENSE,sha256=YhhIjDcfuWhp2dZ8e2W8H6k-HAKceHoWiG6zciVguvo,1074
+xarray_annotated-0.6.0.dist-info/WHEEL,sha256=EmLkUISDECbcUx3FMCYOqokNOJqNp2r0d4mJzjErvvs,80
+xarray_annotated-0.6.0.dist-info/METADATA,sha256=lePQQHHeuCZbaWI-CziyicQGSAd6O0uW3tw5Y-D7JAk,6245
+xarray_annotated-0.6.0.dist-info/RECORD,,

{xarray_annotated-0.5.2.dist-info → xarray_annotated-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.12.1
+Generator: uv 0.12.3
 Root-Is-Purelib: true
 Tag: py3-none-any

xarray_annotated-0.5.2.dist-info/RECORD

@@ -1,26 +0,0 @@
-xarray_annotated/__init__.py,sha256=1vO0qejeRzcUS-zqDIU1UMkBtd2HnZaIyAZMgzsI2iE,2040
-xarray_annotated/_annotations.py,sha256=yRcx9LpLZgmHm_5dg2li-tPEGJLMokujRaIRXCNHZns,4071
-xarray_annotated/_config.py,sha256=H0vKNY7VNJ1rw_4Ymzu2vIOGo1luJLTlGp0e6UzhVpk,3423
-xarray_annotated/_reader.py,sha256=UBmneo6B8aAeK0xWTVy6zDMdm-PaoDH5Pi7hF28UHKA,4857
-xarray_annotated/_writer.py,sha256=BsEUVK3YfZi8QEf8Hz31pYkfO8-WRBP7fcMNbpPCak0,4172
-xarray_annotated/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-xarray_annotated/schema/__init__.py,sha256=0i4hIqpHJG_FXGzoymjOqgRmuT_iBJZQNhAAzr_bOPE,1482
-xarray_annotated/schema/_annotations.py,sha256=sD-vpRKz_eThak-Uti7lSlRKA4JSnh-9HFbbTzzdbQI,8723
-xarray_annotated/schema/_check.py,sha256=oU5Ayx4nDr-VBlnhmj2n46-AEyrHp_wJj17BlJTxq9U,9017
-xarray_annotated/schema/_config.py,sha256=0HLAvUIIsZ-eI5XGce-xu8D7SmEO7zdoExQI1jKRB4Q,4736
-xarray_annotated/schema/_decorator.py,sha256=joRCMs3gSHEV8sst02topZyxz2acHtYNGjPhm9hQ0Mw,5639
-xarray_annotated/temporal/__init__.py,sha256=KW5nbDDe8SFzA7sQfUIPUd9xfbf53fEyJLVwG-sxQnQ,1782
-xarray_annotated/temporal/_annotations.py,sha256=gDr3fG0qj3KqgrafR2VWiAWGYsOweUpVoj-Q2pQ5ZYk,5757
-xarray_annotated/temporal/_check.py,sha256=4Xn8YkxkevSFSMXS_Uq_loLpB1UiGu1GgH-YKIoBII0,13253
-xarray_annotated/temporal/_config.py,sha256=uP3Ywc1PRcqWPRScEQdh3p1OcwU8lIzFCVMXoQyV38g,6642
-xarray_annotated/temporal/_decorator.py,sha256=t70bNlOkEprCA-8rhy4ZAgb-_kqRzKOMbf4h4df2dm4,5930
-xarray_annotated/units/__init__.py,sha256=rzFW1KdrCydAnul5pQJW4aRpR-BmINF0b7Ul-g0C_Rs,1018
-xarray_annotated/units/_annotations.py,sha256=dfKEzxTJ4s5yaXI8ypT0gQtyIDXZl6yzmi_CeciIzk8,6516
-xarray_annotated/units/_check.py,sha256=OHl-gemlWVaO_WcwtbDtC5joUgyFaAKTlpRb73md9kw,25590
-xarray_annotated/units/_config.py,sha256=8_rnIf5bCTLFxxgApN1QYacEo-0Fcfe32c2bzrLh52M,8739
-xarray_annotated/units/_decorator.py,sha256=zoVIPIrChR5g8xPgRRMOXv6tnUyJo2o1F_ZMiDby0Hw,9471
-xarray_annotated/units/_registry.py,sha256=SGzhwLNmCGoR92UobeUpMxKMft8IodyyXWe9h6pZSQQ,3313
-xarray_annotated-0.5.2.dist-info/licenses/LICENSE,sha256=YhhIjDcfuWhp2dZ8e2W8H6k-HAKceHoWiG6zciVguvo,1074
-xarray_annotated-0.5.2.dist-info/WHEEL,sha256=lrO5MD1WVAWzcbNy_L2BwtfPrcM3KfUFpbKYXLkJX4A,80
-xarray_annotated-0.5.2.dist-info/METADATA,sha256=qJx0mdO5RheqHZpMz_CRlPhwV2Io-rE8wNKsK8JJiO8,6241
-xarray_annotated-0.5.2.dist-info/RECORD,,