zarr-cm 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

zarr_cm/__init__.py

@@ -6,6 +6,15 @@ zarr-cm: Python implementation of Zarr Conventions Metadata
 
 from __future__ import annotations
 
+import typing
+from typing import Any, Final, Literal, NotRequired, TypedDict
+
+if typing.TYPE_CHECKING:
+    import types
+    from collections.abc import Iterable
+
+from . import geo_proj, multiscales, spatial, uom
+from . import license as license_
 from ._core import (
     ConventionAttrs,
     ConventionMetadataObject,
@@ -23,15 +32,231 @@ from .multiscales import (
 from .spatial import SpatialAttrs, SpatialConventionAttrs
 from .uom import UCUM, UomAttrs, UomConventionAttrs
 
+ConventionName = Literal["geo-proj", "spatial", "multiscales", "license", "uom"]
+
+_REGISTRY: Final[dict[ConventionName, types.ModuleType]] = {
+    "geo-proj": geo_proj,
+    "spatial": spatial,
+    "multiscales": multiscales,
+    "license": license_,
+    "uom": uom,
+}
+
+CONVENTION_NAMES: Final = frozenset(_REGISTRY)
+
+ALL_CONVENTION_KEYS: Final = frozenset(
+    geo_proj.CONVENTION_KEYS
+    | spatial.CONVENTION_KEYS
+    | multiscales.CONVENTION_KEYS
+    | license_.CONVENTION_KEYS
+    | uom.CONVENTION_KEYS
+)
+
+MultiConventionAttrs = TypedDict(
+    "MultiConventionAttrs",
+    {
+        "zarr_conventions": NotRequired[list[ConventionMetadataObject]],
+        # geo-proj
+        "proj:code": NotRequired[str],
+        "proj:wkt2": NotRequired[str],
+        "proj:projjson": NotRequired[dict[str, Any]],
+        # spatial
+        "spatial:dimensions": NotRequired[list[str]],
+        "spatial:bbox": NotRequired[list[float]],
+        "spatial:transform_type": NotRequired[str],
+        "spatial:transform": NotRequired[list[float]],
+        "spatial:shape": NotRequired[list[int]],
+        "spatial:registration": NotRequired[str],
+        # multiscales
+        "multiscales": NotRequired[MultiscalesAttrs],
+        # license
+        "license": NotRequired[LicenseAttrs],
+        # uom
+        "uom": NotRequired[UomAttrs],
+    },
+)
+
+
+def _get_module(name: ConventionName) -> types.ModuleType:
+    """Look up convention module by display name, raise ValueError if unknown."""
+    try:
+        return _REGISTRY[name]
+    except KeyError:
+        msg = f"Unknown convention {name!r}. Valid names: {sorted(CONVENTION_NAMES)}"
+        raise ValueError(msg) from None
+
+
+def _detect_conventions(attrs: dict[str, Any]) -> frozenset[ConventionName]:
+    """Identify which conventions are present by matching UUIDs in zarr_conventions."""
+    uuids = {cmo.get("uuid") for cmo in attrs.get("zarr_conventions", [])}
+    return frozenset(name for name, mod in _REGISTRY.items() if mod.UUID in uuids)
+
+
+def create_many(
+    conventions: dict[ConventionName, dict[str, Any]],
+) -> dict[str, Any]:
+    """Create and insert multiple conventions into a single attributes dict.
+
+    Parameters
+    ----------
+    conventions
+        Mapping from convention display name (e.g. ``"geo-proj"``) to
+        already-formed convention data (the ``AttrsT`` value).
+
+    Returns
+    -------
+    dict[str, Any]
+        A new attributes dict containing all convention data and a
+        combined ``zarr_conventions`` array.
+    """
+    result: dict[str, Any] = {}
+    for name, data in conventions.items():
+        mod = _get_module(name)
+        mod.validate(data)
+        result = mod.insert(result, data, overwrite=True)
+    return result
+
+
+def validate_many(
+    attrs: dict[str, Any],
+    conventions: Iterable[ConventionName],
+) -> dict[str, Any]:
+    """Validate multiple conventions within an attributes dict.
+
+    Parameters
+    ----------
+    attrs
+        The attributes dict to validate.
+    conventions
+        Convention names to validate.
+
+    Returns
+    -------
+    dict[str, Any]
+        The input *attrs* (pass-through on success).
+    """
+    for name in conventions:
+        mod = _get_module(name)
+        _, extracted = mod.extract(attrs)
+        mod.validate(dict(extracted))
+    return attrs
+
+
+def insert_many(
+    attrs: dict[str, Any],
+    conventions: dict[ConventionName, dict[str, Any]],
+    *,
+    overwrite: bool = False,
+) -> dict[str, Any]:
+    """Insert multiple conventions into an attributes dict.
+
+    Parameters
+    ----------
+    attrs
+        The existing attributes dict.
+    conventions
+        Mapping from convention display name to already-formed convention data.
+    overwrite
+        If False (default), raise ``ValueError`` when *attrs* already
+        contains keys present in a convention's data.
+
+    Returns
+    -------
+    dict[str, Any]
+        A new attributes dict with all convention data merged in.
+    """
+    result = attrs
+    for name, data in conventions.items():
+        mod = _get_module(name)
+        mod.validate(data)
+        result = mod.insert(result, data, overwrite=overwrite)
+    return result
+
+
+def extract_many(
+    attrs: dict[str, Any],
+    conventions: Iterable[ConventionName],
+) -> tuple[dict[str, Any], dict[ConventionName, dict[str, Any]]]:
+    """Extract multiple conventions from an attributes dict.
+
+    Parameters
+    ----------
+    attrs
+        The attributes dict to extract from.
+    conventions
+        Convention names to extract.
+
+    Returns
+    -------
+    tuple[dict[str, Any], dict[str, dict[str, Any]]]
+        ``(remaining_attrs, extracted)`` where *extracted* maps
+        convention names to their convention data dicts.
+    """
+    remaining = attrs
+    extracted: dict[ConventionName, dict[str, Any]] = {}
+    for name in conventions:
+        mod = _get_module(name)
+        remaining, data = mod.extract(remaining)
+        extracted[name] = dict(data)
+    return remaining, extracted
+
+
+def validate_all(
+    attrs: dict[str, Any],
+) -> dict[str, Any]:
+    """Validate all detected conventions within an attributes dict.
+
+    Detects which conventions are present by matching UUIDs in
+    ``zarr_conventions``, then validates each one.
+
+    Parameters
+    ----------
+    attrs
+        The attributes dict to validate.
+
+    Returns
+    -------
+    dict[str, Any]
+        The input *attrs* (pass-through on success).
+    """
+    return validate_many(attrs, _detect_conventions(attrs))
+
+
+def extract_all(
+    attrs: dict[str, Any],
+) -> tuple[dict[str, Any], dict[ConventionName, dict[str, Any]]]:
+    """Extract all detected conventions from an attributes dict.
+
+    Detects which conventions are present by matching UUIDs in
+    ``zarr_conventions``, then extracts each one.
+
+    Parameters
+    ----------
+    attrs
+        The attributes dict to extract from.
+
+    Returns
+    -------
+    tuple[dict[str, Any], dict[str, dict[str, Any]]]
+        ``(remaining_attrs, extracted)`` where *extracted* maps
+        convention names to their convention data dicts.
+    """
+    return extract_many(attrs, _detect_conventions(attrs))
+
+
 __all__ = [
+    "ALL_CONVENTION_KEYS",
+    "CONVENTION_NAMES",
     "UCUM",
     "ConventionAttrs",
     "ConventionMetadataObject",
+    "ConventionName",
     "GeoProjAttrs",
     "GeoProjConventionAttrs",
     "LayoutObject",
     "LicenseAttrs",
     "LicenseConventionAttrs",
+    "MultiConventionAttrs",
     "MultiscalesAttrs",
     "MultiscalesConventionAttrs",
     "SpatialAttrs",
@@ -40,5 +265,11 @@ __all__ = [
     "UomAttrs",
     "UomConventionAttrs",
     "__version__",
+    "create_many",
+    "extract_all",
+    "extract_many",
+    "insert_many",
+    "validate_all",
     "validate_convention_metadata_object",
+    "validate_many",
 ]

zarr_cm/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.0'
-__version_tuple__ = version_tuple = (0, 1, 0)
+__version__ = version = '0.2.0'
+__version_tuple__ = version_tuple = (0, 2, 0)
 
 __commit_id__ = commit_id = None

{zarr_cm-0.1.0.dist-info → zarr_cm-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zarr-cm
-Version: 0.1.0
+Version: 0.2.0
 Summary: Python implementation of Zarr Conventions Metadata
 Project-URL: Homepage, https://github.com/zarr-conventions/zarr-cm
 Project-URL: Bug Tracker, https://github.com/zarr-conventions/zarr-cm/issues

{zarr_cm-0.1.0.dist-info → zarr_cm-0.2.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-zarr_cm/__init__.py,sha256=qM43_Ok_QvqmUJgJQs-DH_wmjMKrDhci7jFjJsf66x4,1095
+zarr_cm/__init__.py,sha256=Hw5KH_lASVSgY_eIeOdpGXbr_aYEogbIbNuAyzErxuY,7662
 zarr_cm/_core.py,sha256=FBf_dSy6e_JhO2NLLZAsjd9lo0doNj-sP6SaD9ccXSw,3318
-zarr_cm/_version.py,sha256=5jwwVncvCiTnhOedfkzzxmxsggwmTBORdFL_4wq0ZeY,704
+zarr_cm/_version.py,sha256=Dg8AmJomLVpjKL6prJylOONZAPRtB86LOce7dorQS_A,704
 zarr_cm/_version.pyi,sha256=o7uNL6MhuJoiqpEnriU7rBT6TmkJZA-i2qMoNz9YcgQ,82
 zarr_cm/geo_proj.py,sha256=hThP9JXBS_UJBv5LVVlGVlqPa-FJIHxFGbQqkNhsgz0,2877
 zarr_cm/license.py,sha256=K1VmX_iGBiXc7jBMhor2Z3MRfv3u_OPSUu7HzCYfB1M,3082
@@ -8,7 +8,7 @@ zarr_cm/multiscales.py,sha256=Fb0npvFyMB72FADfyXCxR2N8nZ0HoQWlZdyffNGUVsk,3561
 zarr_cm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zarr_cm/spatial.py,sha256=7VT8KuuLOhvx9pM4FadpFUSxB-F-4Kw92faYnfJri1Y,4171
 zarr_cm/uom.py,sha256=Hgiq2nk-h0B3KkFSkR_B-mjbaZrGw6OPo78ZA2qFW68,2610
-zarr_cm-0.1.0.dist-info/METADATA,sha256=XOi54qq3ZumTKsAT7POTgaI2IRJW1FyzXC7NKGQTEyY,5340
-zarr_cm-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-zarr_cm-0.1.0.dist-info/licenses/LICENSE,sha256=ZE1QpSxHhv5y8vLtkWCxZA9-et8IrqusTlNS9ARqr4s,1523
-zarr_cm-0.1.0.dist-info/RECORD,,
+zarr_cm-0.2.0.dist-info/METADATA,sha256=vZU_Ui1jfU3BxruNriA6efUqdAs5sG6ss7o_l8AfT1g,5340
+zarr_cm-0.2.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+zarr_cm-0.2.0.dist-info/licenses/LICENSE,sha256=ZE1QpSxHhv5y8vLtkWCxZA9-et8IrqusTlNS9ARqr4s,1523
+zarr_cm-0.2.0.dist-info/RECORD,,