anemoi-utils 0.4.17__tar.gz → 0.4.19__tar.gz

anemoi_utils-0.4.19/.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    pre_build:
+    - bash docs/scripts/api_build.sh
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

anemoi_utils-0.4.19/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+    ".": "0.4.19"
+}

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/CHANGELOG.md

@@ -8,6 +8,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Please add your functional changes to the appropriate section in the PR.
 Keep it human-readable, your future self will thank you!
 
+## [0.4.19](https://github.com/ecmwf/anemoi-utils/compare/0.4.18...0.4.19) (2025-04-04)
+
+
+### Features
+
+* more testing support functions ([#136](https://github.com/ecmwf/anemoi-utils/issues/136)) ([5687b87](https://github.com/ecmwf/anemoi-utils/commit/5687b87ed17748412340d00f0724249f59b4e3f2))
+
+
+### Documentation
+
+* add api ([#133](https://github.com/ecmwf/anemoi-utils/issues/133)) ([16af518](https://github.com/ecmwf/anemoi-utils/commit/16af5184eafbfc29cc3f0217a35675f2aa32847e))
+
+## [0.4.18](https://github.com/ecmwf/anemoi-utils/compare/0.4.17...0.4.18) (2025-03-31)
+
+
+### Features
+
+* add matching rules ([#132](https://github.com/ecmwf/anemoi-utils/issues/132)) ([2382980](https://github.com/ecmwf/anemoi-utils/commit/2382980f4f53909a73fa0a5c8cfab108625f3c55))
+
 ## [0.4.17](https://github.com/ecmwf/anemoi-utils/compare/0.4.16...0.4.17) (2025-03-27)
 
 

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anemoi-utils
-Version: 0.4.17
+Version: 0.4.19
 Summary: A package to hold various functions to support training of ML models on ECMWF data.
 Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
 License:                                  Apache License
@@ -237,6 +237,7 @@ Requires-Dist: anemoi-utils[grib,provenance,s3,text]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: anemoi-utils[all,docs,tests]; extra == "dev"
 Provides-Extra: docs
+Requires-Dist: anemoi-utils[all]; extra == "docs"
 Requires-Dist: nbsphinx; extra == "docs"
 Requires-Dist: pandoc; extra == "docs"
 Requires-Dist: requests; extra == "docs"

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/docs/Makefile

@@ -19,4 +19,5 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	bash $(SOURCEDIR)/scripts/api_build.sh
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

anemoi_utils-0.4.19/docs/_templates/apidoc/package.rst.jinja

@@ -0,0 +1,55 @@
+{%- macro automodule(modname, options) -%}
+.. automodule:: {{ modname }}
+{%- for option in options %}
+   :{{ option }}:
+{%- endfor %}
+{%- endmacro %}
+
+{%- macro toctree(docnames) -%}
+.. toctree::
+   :maxdepth: {{ maxdepth }}
+{% for docname in docnames %}
+   {{ docname }}
+{%- endfor %}
+{%- endmacro %}
+
+{%- if is_namespace %}
+{{- pkgname.split(".")[1:] | join(".") | e | heading }}
+{% else %}
+{{- pkgname.split(".")[1:] | join(" ") | e | heading }}
+{% endif %}
+
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
+{%- if modulefirst and not is_namespace %}
+{{ automodule(["anemoi", pkgname] | join("."), [""]) }}
+{% endif %}
+
+{%- if subpackages %}
+Subpackages
+-----------
+
+{{ toctree(subpackages) }}
+{% endif %}
+
+{%- if submodules %}
+{% if separatemodules %}
+{{ toctree(submodules) }}
+{% else %}
+{%- for submodule in submodules %}
+{% if show_headings %}
+{{- submodule.split(".")[2:] | join(".") | e | heading(2) }}
+{% endif %}
+{{ automodule(["anemoi", submodule] | join("."), automodule_options) }}
+{% endfor %}
+{%- endif %}
+{%- endif %}
+
+{%- if not modulefirst and not is_namespace %}
+Module contents
+---------------
+
+{{ automodule(pkgname, automodule_options) }}
+{% endif %}

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/docs/index.rst

@@ -30,15 +30,15 @@ of the *Anemoi* packages.
 
    installing
 
-*********
- Modules
-*********
+*****
+ API
+*****
 
 .. toctree::
    :maxdepth: 1
    :glob:
 
-   modules/*
+   _api/*
 
 ***********************
  Other Anemoi packages

anemoi_utils-0.4.19/docs/scripts/api_build.sh

@@ -0,0 +1,13 @@
+
+
+set -e
+
+script_dir=$(dirname "${BASH_SOURCE[0]}")
+docs_dir="$script_dir/.."
+source_dir="$script_dir/../../src/"
+
+
+trap 'rm -f $source_dir/anemoi/__init__.py' EXIT
+
+touch "$source_dir/anemoi/__init__.py"
+sphinx-apidoc -M -f -o "$docs_dir/_api" "$source_dir/anemoi" #-t "$docs_dir/_templates/apidoc"

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/pyproject.toml

@@ -54,6 +54,7 @@ optional-dependencies.all = [ "anemoi-utils[grib,provenance,text,s3]" ]
 optional-dependencies.dev = [ "anemoi-utils[all,docs,tests]" ]
 
 optional-dependencies.docs = [
+  "anemoi-utils[all]",
   "nbsphinx",
   "pandoc",
   "requests",

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi/utils/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.17'
-__version_tuple__ = version_tuple = (0, 4, 17)
+__version__ = version = '0.4.19'
+__version_tuple__ = version_tuple = (0, 4, 19)

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi/utils/registry.py

@@ -17,8 +17,10 @@ from functools import cached_property
 from typing import Any
 from typing import Callable
 from typing import Dict
+from typing import Generic
 from typing import List
 from typing import Optional
+from typing import TypeVar
 from typing import Union
 
 import entrypoints
@@ -78,8 +80,10 @@ class Error:
 
 _BY_KIND = {}
 
+T = TypeVar("T")
 
-class Registry:
+
+class Registry(Generic[T]):
     """A registry of factories.
 
     Parameters
@@ -287,7 +291,7 @@ class Registry:
 
         return sorted(self.factories.keys())
 
-    def create(self, name: str, *args: Any, **kwargs: Any) -> Any:
+    def create(self, name: str, *args: Any, **kwargs: Any) -> T:
         """Create an instance using a factory.
 
         Parameters
@@ -310,7 +314,7 @@ class Registry:
         factory = self.lookup(name)
         return factory(*args, **kwargs)
 
-    def from_config(self, config: Union[str, Dict[str, Any]], *args: Any, **kwargs: Any) -> Any:
+    def from_config(self, config: Union[str, Dict[str, Any]], *args: Any, **kwargs: Any) -> T:
         """Create an instance from a configuration.
 
         Parameters

anemoi_utils-0.4.19/src/anemoi/utils/rules.py

@@ -0,0 +1,218 @@
+# (C) Copyright 2025 Anemoi contributors.
+#
+# This software is licensed under the terms of the Apache Licence Version 2.0
+# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# In applying this licence, ECMWF does not waive the privileges and immunities
+# granted to it by virtue of its status as an intergovernmental organisation
+# nor does it submit to any jurisdiction.
+
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Mapping
+from typing import Optional
+from typing import Union
+
+
+class Rule:
+
+    def __init__(self, match: Dict[str, Any], result: Any):
+        """Initialize a Rule object.
+
+        Parameters
+        ----------
+        match : Dict[str, Any]
+            A dictionary defining the conditions for the rule to match.
+        result : Any
+            The result to return if the rule matches.
+        """
+        self._match = match
+        self._result = result
+
+    def match(self, obj: Mapping[str, Any]) -> bool:
+        """Check if the rule matches the given object.
+
+        Parameters
+        ----------
+        obj : Mapping[str, Any]
+            The object to check against the rule's conditions.
+
+        Returns
+        -------
+        bool
+            True if the rule matches, False otherwise.
+        """
+        for key, value in self._match.items():
+            if key not in obj or obj[key] != value:
+                return False
+
+        return True
+
+    @property
+    def result(self) -> Any:
+        return self._result
+
+    @property
+    def condition(self) -> Dict[str, Any]:
+        return self._match
+
+
+class RuleSet:
+
+    def __init__(self, rules: List[Union[Rule, Dict[str, Any], List[Any]]]):
+        """Initialize a RuleSet object.
+
+        Parameters
+        ----------
+        rules : List[Union[Rule, Dict[str, Any], List[Any]]]
+            A list of rules, where each rule can be a Rule object, a dictionary with
+            'match' and 'result' keys, or a list with two elements (match and result).
+        """
+        assert isinstance(rules, list), "rules must be a list"
+
+        self.rules: List[Rule] = []
+
+        for rule in rules:
+            if isinstance(rule, Rule):
+                self.rules.append(rule)
+                continue
+
+            if isinstance(rule, dict):
+
+                assert len(rule) == 2, "Rule dictionary must contain exactly two key-value pair."
+
+                match = rule.get("match")
+                if match is None:
+                    raise ValueError("Rule dictionary must contain a 'match' key.")
+
+                result = rule.get("result")
+                if result is None:
+                    raise ValueError("Rule dictionary must contain a 'result' key.")
+
+                self.rules.append(Rule(match, result))
+                continue
+
+            if isinstance(rule, list):
+                assert len(rule) == 2, "Rule list must contain exactly two elements."
+                match = rule[0]
+                result = rule[1]
+                self.rules.append(Rule(match, result))
+                continue
+
+            raise ValueError(
+                "Rule must be either a Rule object, a dictionary with 'match' and 'result' keys, or a list with two elements."
+            )
+
+    @classmethod
+    def from_list(cls, rules: List[Any]) -> "RuleSet":
+        """Create a RuleSet from a list of rules.
+
+        Parameters
+        ----------
+        rules : List[Any]
+            A list of rules to initialize the RuleSet.
+
+        Returns
+        -------
+        RuleSet
+            A new RuleSet object.
+        """
+        return cls(rules)
+
+    @classmethod
+    def from_files(cls, path: str) -> "RuleSet":
+        """Create a RuleSet from a file.
+
+        Parameters
+        ----------
+        path : str
+            The path to the file containing the rules. Supported formats are .json and .yaml/.yml.
+
+        Returns
+        -------
+        RuleSet
+            A new RuleSet object.
+
+        Raises
+        ------
+        ValueError
+            If the file format is unsupported.
+        """
+        if path.endswith(".json"):
+            import json
+
+            with open(path, "r") as f:
+                return cls.from_list(json.load(f))
+
+        if path.endswith(".yaml") or path.endswith(".yml"):
+            import yaml
+
+            with open(path, "r") as f:
+                return cls.from_list(yaml.safe_load(f))
+
+        raise ValueError("Unsupported file format. Supported formats are .json and .yaml/.yml.")
+
+    @classmethod
+    def from_any(cls, rules: Union[str, List[Any]]) -> "RuleSet":
+        """Create a RuleSet from a list or a file path.
+
+        Parameters
+        ----------
+        rules : Union[str, List[Any]]
+            The rules to initialize the RuleSet, either as a list or a file path.
+
+        Returns
+        -------
+        RuleSet
+            A new RuleSet object.
+
+        Raises
+        ------
+        ValueError
+            If the rules format is unsupported.
+        """
+        if isinstance(rules, str):
+            return cls.from_files(rules)
+
+        if isinstance(rules, list):
+            return cls.from_list(rules)
+
+        raise ValueError("Unsupported rules format. Must be a list or a file path.")
+
+    def match(self, obj: Mapping[str, Any], strategy: str = "first-match") -> Optional[Rule]:
+        """Match an object against the rules in the RuleSet.
+
+        Parameters
+        ----------
+        obj : Mapping[str, Any]
+            The object to match against the rules.
+        strategy : str, optional
+            The matching strategy to use. Currently, only 'first-match' is supported.
+
+        Returns
+        -------
+        Optional[Rule]
+            The first matching rule, or None if no match is found.
+
+        Raises
+        ------
+        AssertionError
+            If an unsupported strategy is provided.
+        """
+        assert strategy == "first-match", "Only 'first-match' strategy is supported for now."
+        for rule in self.rules:
+            if rule.match(obj):
+                return rule
+
+        return None
+
+    def __iter__(self) -> iter:
+        """Return an iterator over the rules in the RuleSet.
+
+        Returns
+        -------
+        iter
+            An iterator over the Rule objects in the RuleSet.
+        """
+        return iter(self.rules)

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi/utils/testing.py

@@ -13,7 +13,10 @@ import os
 import shutil
 import tempfile
 import threading
+import warnings
+from functools import lru_cache
 
+import pytest
 from multiurl import download
 
 LOG = logging.getLogger(__name__)
@@ -98,6 +101,9 @@ def get_test_data(path: str, gzipped=False) -> str:
     """
     _check_path(path)
 
+    if _offline():
+        raise RuntimeError("Offline mode: cannot download test data, add @pytest.mark.skipif(not offline(),...)")
+
     target = os.path.normpath(os.path.join(_temporary_directory(), path))
     with lock:
         if os.path.exists(target):
@@ -174,9 +180,84 @@ def packages_installed(*names) -> bool:
         Flag indicating if all the packages are installed."
     """
 
+    warnings.warn(
+        "The 'packages_installed' function is deprecated. Use '@skip_if_missing' instead.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     for name in names:
         try:
             __import__(name)
         except ImportError:
             return False
     return True
+
+
+def _missing_packages(*names) -> list[str]:
+    """Check if the given packages are missing.
+
+    Use this function to check if the required packages are missing before running tests.
+
+    >>> @pytest.mark.skipif(missing_packages("foo", "bar"), reason="Packages 'foo' and 'bar' are not installed")
+    >>> def test_foo_bar() -> None:
+    >>>    ...
+
+    Parameters
+    ----------
+    names : str
+        The names of the packages to check.
+
+    Returns
+    -------
+    list[str]:
+        List of missing packages.
+    """
+
+    missing = []
+    for name in names:
+        try:
+            __import__(name)
+        except ImportError:
+            missing.append(name)
+    return missing
+
+
+def _run_slow_tests() -> bool:
+    """Check if the SLOW_TESTS environment variable is set.
+
+    Returns
+    -------
+    bool
+        True if the SLOW_TESTS environment variable is set, False otherwise.
+    """
+    return int(os.environ.get("SLOW_TESTS", 0))
+
+
+@lru_cache(maxsize=None)
+def _offline() -> bool:
+    """Check if we are offline."""
+
+    import socket
+
+    try:
+        socket.create_connection(("anemoi.ecmwf.int", 443), timeout=5)
+    except OSError:
+        return True
+
+    return False
+
+
+skip_if_offline = pytest.mark.skipif(_offline(), reason="No internet connection")
+skip_slow_tests = pytest.mark.skipif(not _run_slow_tests(), reason="Skipping slow tests")
+
+
+def skip_missing_packages(*names):
+    missing = _missing_packages(*names)
+    if len(missing) == 0:
+        return lambda f: f
+
+    if len(missing) == 1:
+        return pytest.mark.skipif(True, reason=f"Package {missing[0]} is not installed")
+
+    return pytest.mark.skipif(True, reason=f"Packages {', '.join(missing)} are not installed")

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: anemoi-utils
-Version: 0.4.17
+Version: 0.4.19
 Summary: A package to hold various functions to support training of ML models on ECMWF data.
 Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
 License:                                  Apache License
@@ -237,6 +237,7 @@ Requires-Dist: anemoi-utils[grib,provenance,s3,text]; extra == "all"
 Provides-Extra: dev
 Requires-Dist: anemoi-utils[all,docs,tests]; extra == "dev"
 Provides-Extra: docs
+Requires-Dist: anemoi-utils[all]; extra == "docs"
 Requires-Dist: nbsphinx; extra == "docs"
 Requires-Dist: pandoc; extra == "docs"
 Requires-Dist: requests; extra == "docs"

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi_utils.egg-info/SOURCES.txt

@@ -31,6 +31,7 @@ docs/installing.rst
 docs/_static/logo.png
 docs/_static/style.css
 docs/_templates/.gitkeep
+docs/_templates/apidoc/package.rst.jinja
 docs/modules/checkpoints.rst
 docs/modules/config.rst
 docs/modules/dates.rst
@@ -40,6 +41,7 @@ docs/modules/provenance.rst
 docs/modules/s3.rst
 docs/modules/testing.rst
 docs/modules/text.rst
+docs/scripts/api_build.sh
 src/anemoi/utils/__init__.py
 src/anemoi/utils/__main__.py
 src/anemoi/utils/_version.py
@@ -57,6 +59,7 @@ src/anemoi/utils/humanize.py
 src/anemoi/utils/logs.py
 src/anemoi/utils/provenance.py
 src/anemoi/utils/registry.py
+src/anemoi/utils/rules.py
 src/anemoi/utils/s3.py
 src/anemoi/utils/sanitise.py
 src/anemoi/utils/sanitize.py

{anemoi_utils-0.4.17 → anemoi_utils-0.4.19}/src/anemoi_utils.egg-info/requires.txt

@@ -18,6 +18,7 @@ anemoi-utils[grib,provenance,s3,text]
 anemoi-utils[all,docs,tests]
 
 [docs]
+anemoi-utils[all]
 nbsphinx
 pandoc
 requests

anemoi_utils-0.4.17/.readthedocs.yaml

@@ -1,16 +0,0 @@
-version: 2
-
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.10"
-
-sphinx:
-  configuration: docs/conf.py
-
-python:
-   install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs

anemoi_utils-0.4.17/.release-please-manifest.json

@@ -1,3 +0,0 @@
-{
-    ".": "0.4.17"
-}