anemoi-utils 0.4.29__py3-none-any.whl → 0.4.30__py3-none-any.whl

anemoi/utils/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.4.29'
-__version_tuple__ = version_tuple = (0, 4, 29)
+__version__ = version = '0.4.30'
+__version_tuple__ = version_tuple = (0, 4, 30)

anemoi/utils/caching.py

@@ -12,10 +12,9 @@ import hashlib
 import json
 import os
 import time
+from collections.abc import Callable
 from threading import Lock
 from typing import Any
-from typing import Callable
-from typing import Optional
 
 import numpy as np
 
@@ -61,7 +60,7 @@ class Cacher:
     Private class, do not use directly.
     """
 
-    def __init__(self, collection: str, expires: Optional[int]):
+    def __init__(self, collection: str, expires: int | None):
         """Initialize the Cacher.
 
         Parameters
@@ -181,7 +180,7 @@ class JsonCacher(Cacher):
         dict
             The loaded data
         """
-        with open(path, "r") as f:
+        with open(path) as f:
             return json.load(f)
 
 
@@ -226,7 +225,7 @@ class NpzCacher(Cacher):
 
 
 # This function is the main entry point for the caching mechanism for the other anemoi packages
-def cached(collection: str = "default", expires: Optional[int] = None, encoding: str = "json") -> Callable:
+def cached(collection: str = "default", expires: int | None = None, encoding: str = "json") -> Callable:
     """Decorator to cache the result of a function.
 
     Default is to use a json file to store the cache, but you can also use npz files

anemoi/utils/checkpoints.py

@@ -17,8 +17,8 @@ import logging
 import os
 import time
 import zipfile
+from collections.abc import Callable
 from tempfile import TemporaryDirectory
-from typing import Callable
 
 import tqdm
 

anemoi/utils/cli.py

@@ -14,8 +14,7 @@ import logging
 import os
 import sys
 import traceback
-from typing import Callable
-from typing import Optional
+from collections.abc import Callable
 
 try:
     import argcomplete
@@ -187,7 +186,7 @@ def register_commands(here: str, package: str, select: Callable, fail: Callable
 
 
 def cli_main(
-    version: str, description: str, commands: dict[str, Command], test_arguments: Optional[list[str]] = None
+    version: str, description: str, commands: dict[str, Command], test_arguments: list[str] | None = None
 ) -> None:
     """Main entry point for the CLI.
 

anemoi/utils/commands/metadata.py

@@ -17,7 +17,6 @@ from argparse import ArgumentParser
 from argparse import Namespace
 from tempfile import TemporaryDirectory
 from typing import Any
-from typing import Dict
 
 import yaml
 
@@ -213,7 +212,7 @@ class Metadata(Command):
         from anemoi.utils.checkpoints import load_metadata
         from anemoi.utils.checkpoints import replace_metadata
 
-        kwargs: Dict[str, Any] = {}
+        kwargs: dict[str, Any] = {}
 
         if args.json:
             ext = "json"

anemoi/utils/compatibility.py

@@ -10,15 +10,11 @@
 from __future__ import annotations
 
 import functools
+from collections.abc import Callable
 from typing import Any
-from typing import Callable
-from typing import Optional
-from typing import Union
 
 
-def aliases(
-    aliases: Optional[dict[str, Union[str, list[str]]]] = None, **kwargs: Any
-) -> Callable[[Callable], Callable]:
+def aliases(aliases: dict[str, str | list[str]] | None = None, **kwargs: Any) -> Callable[[Callable], Callable]:
     """Alias keyword arguments in a function call.
 
     Allows for dynamically renaming keyword arguments in a function call.

anemoi/utils/config.py

@@ -16,8 +16,6 @@ import logging
 import os
 import threading
 from typing import Any
-from typing import Optional
-from typing import Union
 
 import yaml
 
@@ -62,14 +60,20 @@ class DotDict(dict):
         super().__init__(*args, **kwargs)
 
         for k, v in self.items():
-            if isinstance(v, dict) or is_omegaconf_dict(v):
-                self[k] = DotDict(v)
+            self[k] = self.convert_to_nested_dot_dict(v)
 
-            if isinstance(v, list) or is_omegaconf_list(v):
-                self[k] = [DotDict(i) if isinstance(i, dict) or is_omegaconf_dict(i) else i for i in v]
+    @staticmethod
+    def convert_to_nested_dot_dict(value):
+        if isinstance(value, dict) or is_omegaconf_dict(value):
+            return DotDict(value)
 
-            if isinstance(v, tuple):
-                self[k] = [DotDict(i) if isinstance(i, dict) or is_omegaconf_dict(i) else i for i in v]
+        if isinstance(value, list) or is_omegaconf_list(value):
+            return [DotDict(i) if isinstance(i, dict) or is_omegaconf_dict(i) else i for i in value]
+
+        if isinstance(value, tuple):
+            return [DotDict(i) if isinstance(i, dict) or is_omegaconf_dict(i) else i for i in value]
+
+        return value
 
     @classmethod
     def from_file(cls, path: str) -> DotDict:
@@ -109,7 +113,7 @@ class DotDict(dict):
         DotDict
             The created DotDict.
         """
-        with open(path, "r") as file:
+        with open(path) as file:
             data = yaml.safe_load(file)
 
         return cls(data)
@@ -128,7 +132,7 @@ class DotDict(dict):
         DotDict
             The created DotDict.
         """
-        with open(path, "r") as file:
+        with open(path) as file:
             data = json.load(file)
 
         return cls(data)
@@ -147,7 +151,7 @@ class DotDict(dict):
         DotDict
             The created DotDict.
         """
-        with open(path, "r") as file:
+        with open(path) as file:
             data = tomllib.load(file)
         return cls(data)
 
@@ -179,9 +183,31 @@ class DotDict(dict):
         value : Any
             The attribute value.
         """
-        if isinstance(value, dict):
-            value = DotDict(value)
-        self[attr] = value
+
+        self.warn_on_mutation(attr)
+        value = self.convert_to_nested_dot_dict(value)
+        super().__setitem__(attr, value)
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        """Set an item in the dictionary.
+
+        Parameters
+        ----------
+        key : str
+            The key to set.
+        value : Any
+            The value to set.
+        """
+        self.warn_on_mutation(key)
+        value = self.convert_to_nested_dot_dict(value)
+        super().__setitem__(key, value)
+
+    @staticmethod
+    def warn_on_mutation(key):
+        LOG.warning(
+            f"Config key '{key}' was modified after instantiation. "
+            "This is bad practice — configs are intended to be immutable. "
+        )
 
     def __repr__(self) -> str:
         """Return a string representation of the DotDict.
@@ -243,7 +269,7 @@ QUIET = False
 CONFIG_PATCH = None
 
 
-def _find(config: Union[dict, list], what: str, result: list = None) -> list:
+def _find(config: dict | list, what: str, result: list = None) -> list:
     """Find all occurrences of a key in a nested dictionary or list.
 
     Parameters
@@ -408,8 +434,8 @@ def load_any_dict_format(path: str) -> dict:
 
 def _load_config(
     name: str = "settings.toml",
-    secrets: Optional[Union[str, list[str]]] = None,
-    defaults: Optional[Union[str, dict]] = None,
+    secrets: str | list[str] | None = None,
+    defaults: str | dict | None = None,
 ) -> DotDict:
     """Load a configuration file.
 
@@ -531,8 +557,8 @@ def save_config(name: str, data: Any) -> None:
 
 def load_config(
     name: str = "settings.toml",
-    secrets: Optional[Union[str, list[str]]] = None,
-    defaults: Optional[Union[str, dict]] = None,
+    secrets: str | list[str] | None = None,
+    defaults: str | dict | None = None,
 ) -> DotDict | str:
     """Read a configuration file.
 
@@ -558,7 +584,7 @@ def load_config(
         return config
 
 
-def load_raw_config(name: str, default: Any = None) -> Union[DotDict, str]:
+def load_raw_config(name: str, default: Any = None) -> DotDict | str:
     """Load a raw configuration file.
 
     Parameters
@@ -617,7 +643,7 @@ def check_config_mode(name: str = "settings.toml", secrets_name: str = None, sec
         CHECKED[name] = True
 
 
-def find(metadata: Union[dict, list], what: str, result: list = None, *, select: callable = None) -> list:
+def find(metadata: dict | list, what: str, result: list = None, *, select: callable = None) -> list:
     """Find all occurrences of a key in a nested dictionary or list with an optional selector.
 
     Parameters

anemoi/utils/dates.py

@@ -12,16 +12,11 @@ import calendar
 import datetime
 import re
 from typing import Any
-from typing import List
-from typing import Optional
-from typing import Set
-from typing import Tuple
-from typing import Union
 
 import aniso8601
 
 
-def normalise_frequency(frequency: Union[int, str]) -> int:
+def normalise_frequency(frequency: int | str) -> int:
     """Normalise frequency to hours.
 
     Parameters
@@ -61,7 +56,7 @@ def _no_time_zone(date: datetime.datetime) -> datetime.datetime:
 
 
 # this function is use in anemoi-datasets
-def as_datetime(date: Union[datetime.date, datetime.datetime, str], keep_time_zone: bool = False) -> datetime.datetime:
+def as_datetime(date: datetime.date | datetime.datetime | str, keep_time_zone: bool = False) -> datetime.datetime:
     """Convert a date to a datetime object, removing any time zone information.
 
     Parameters
@@ -91,9 +86,7 @@ def as_datetime(date: Union[datetime.date, datetime.datetime, str], keep_time_zo
     raise ValueError(f"Invalid date type: {type(date)}")
 
 
-def _as_datetime_list(
-    date: Union[datetime.date, datetime.datetime, str], default_increment: datetime.timedelta
-) -> iter:
+def _as_datetime_list(date: datetime.date | datetime.datetime | str, default_increment: datetime.timedelta) -> iter:
     """Convert a date to a list of datetime objects.
 
     Parameters
@@ -137,7 +130,7 @@ def _as_datetime_list(
 
 
 def as_datetime_list(
-    date: Union[datetime.date, datetime.datetime, str], default_increment: int = 1
+    date: datetime.date | datetime.datetime | str, default_increment: int = 1
 ) -> list[datetime.datetime]:
     """Convert a date to a list of datetime objects.
 
@@ -157,7 +150,7 @@ def as_datetime_list(
     return list(_as_datetime_list(date, default_increment))
 
 
-def as_timedelta(frequency: Union[int, str, datetime.timedelta]) -> datetime.timedelta:
+def as_timedelta(frequency: int | str | datetime.timedelta) -> datetime.timedelta:
     """Convert anything to a timedelta object.
 
     Parameters
@@ -237,7 +230,7 @@ def as_timedelta(frequency: Union[int, str, datetime.timedelta]) -> datetime.tim
     raise ValueError(f"Cannot convert frequency {frequency} to timedelta")
 
 
-def frequency_to_timedelta(frequency: Union[int, str, datetime.timedelta]) -> datetime.timedelta:
+def frequency_to_timedelta(frequency: int | str | datetime.timedelta) -> datetime.timedelta:
     """Convert a frequency to a timedelta object.
 
     Parameters
@@ -302,7 +295,7 @@ def frequency_to_string(frequency: datetime.timedelta) -> str:
     return str(frequency)
 
 
-def frequency_to_seconds(frequency: Union[int, str, datetime.timedelta]) -> int:
+def frequency_to_seconds(frequency: int | str | datetime.timedelta) -> int:
     """Convert a frequency to seconds.
 
     Parameters
@@ -347,7 +340,7 @@ MONTH = {
 }
 
 
-def _make_day(day: Optional[Tuple[int, List[int]]]) -> Set[int]:
+def _make_day(day: tuple[int, list[int]] | None) -> set[int]:
     """Create a set of days.
 
     Parameters
@@ -367,7 +360,7 @@ def _make_day(day: Optional[Tuple[int, List[int]]]) -> Set[int]:
     return {int(d) for d in day}
 
 
-def _make_week(week: Optional[Tuple[str, List[str]]]) -> Set[int]:
+def _make_week(week: tuple[str, list[str]] | None) -> set[int]:
     """Create a set of weekdays.
 
     Parameters
@@ -387,7 +380,7 @@ def _make_week(week: Optional[Tuple[str, List[str]]]) -> Set[int]:
     return {DOW[w.lower()] for w in week}
 
 
-def _make_months(months: Optional[Union[int, str, List[Union[int, str]]]]) -> Set[int]:
+def _make_months(months: int | str | list[int | str] | None) -> set[int]:
     """Create a set of months.
 
     Parameters
@@ -414,13 +407,13 @@ class DateTimes:
 
     def __init__(
         self,
-        start: Union[datetime.date, datetime.datetime, str],
-        end: Union[datetime.date, datetime.datetime, str],
+        start: datetime.date | datetime.datetime | str,
+        end: datetime.date | datetime.datetime | str,
         increment: int = 24,
         *,
-        day_of_month: Optional[Tuple[int, List[int]]] = None,
-        day_of_week: Optional[Tuple[str, List[str]]] = None,
-        calendar_months: Optional[Union[int, str, List[Union[int, str]]]] = None,
+        day_of_month: tuple[int, list[int]] | None = None,
+        day_of_week: tuple[str, list[str]] | None = None,
+        calendar_months: int | str | list[int | str] | None = None,
     ):
         """Initialize the DateTimes iterator.
 
@@ -571,7 +564,7 @@ class ConcatDateTimes:
 class EnumDateTimes:
     """EnumDateTimes is an iterator that generates datetime objects from a list of dates."""
 
-    def __init__(self, dates: list[Union[datetime.date, datetime.datetime, str]]):
+    def __init__(self, dates: list[datetime.date | datetime.datetime | str]):
         """Initialize the EnumDateTimes iterator.
 
         Parameters
@@ -593,7 +586,7 @@ class EnumDateTimes:
             yield as_datetime(date)
 
 
-def datetimes_factory(*args: Any, **kwargs: Any) -> Union[DateTimes, ConcatDateTimes, EnumDateTimes]:
+def datetimes_factory(*args: Any, **kwargs: Any) -> DateTimes | ConcatDateTimes | EnumDateTimes:
     """Create a DateTimes, ConcatDateTimes, or EnumDateTimes object.
 
     Parameters

anemoi/utils/grib.py

@@ -15,8 +15,6 @@ See https://codes.ecmwf.int/grib/param-db/ for more information.
 
 import logging
 import re
-from typing import Dict
-from typing import Union
 
 import requests
 
@@ -26,7 +24,7 @@ LOG = logging.getLogger(__name__)
 
 
 @cached(collection="grib", expires=30 * 24 * 60 * 60)
-def _units() -> Dict[str, str]:
+def _units() -> dict[str, str]:
     """Fetch and cache GRIB parameter units.
 
     Returns
@@ -41,7 +39,7 @@ def _units() -> Dict[str, str]:
 
 
 @cached(collection="grib", expires=30 * 24 * 60 * 60)
-def _search_param(name: str) -> Dict[str, Union[str, int]]:
+def _search_param(name: str) -> dict[str, str | int]:
     """Search for a GRIB parameter by name.
 
     Parameters
@@ -116,7 +114,7 @@ def paramid_to_shortname(paramid: int) -> str:
     return _search_param(str(paramid))["shortname"]
 
 
-def units(param: Union[int, str]) -> str:
+def units(param: int | str) -> str:
     """Return the units of a GRIB parameter given its name or id.
 
     Parameters
@@ -137,7 +135,7 @@ def units(param: Union[int, str]) -> str:
     return _units()[unit_id]
 
 
-def must_be_positive(param: Union[int, str]) -> bool:
+def must_be_positive(param: int | str) -> bool:
     """Check if a parameter must be positive.
 
     Parameters

anemoi/utils/grids.py

@@ -13,9 +13,6 @@
 import logging
 import os
 from io import BytesIO
-from typing import List
-from typing import Tuple
-from typing import Union
 
 import deprecation
 import numpy as np
@@ -145,7 +142,7 @@ def nearest_grid_points(
 
 
 @cached(collection="grids", encoding="npz")
-def _grids(name: Union[str, List[float], Tuple[float, ...]]) -> bytes:
+def _grids(name: str | list[float] | tuple[float, ...]) -> bytes:
     """Get grid data by name.
 
     Parameters
@@ -196,7 +193,7 @@ def _grids(name: Union[str, List[float], Tuple[float, ...]]) -> bytes:
     current_version=__version__,
     details="Use anemoi.transform.grids.named.lookup instead.",
 )
-def grids(name: Union[str, List[float], Tuple[float, ...]]) -> dict:
+def grids(name: str | list[float] | tuple[float, ...]) -> dict:
     """Load grid data by name.
 
     Parameters

anemoi/utils/hindcasts.py

@@ -9,9 +9,7 @@
 
 
 import datetime
-from typing import Iterator
-from typing import List
-from typing import Tuple
+from collections.abc import Iterator
 
 
 class HindcastDatesTimes:
@@ -25,7 +23,7 @@ class HindcastDatesTimes:
         Number of years to go back from each reference date.
     """
 
-    def __init__(self, reference_dates: List[datetime.datetime], years: int = 20):
+    def __init__(self, reference_dates: list[datetime.datetime], years: int = 20):
         """Initialize the HindcastDatesTimes iterator.
 
         Parameters
@@ -41,7 +39,7 @@ class HindcastDatesTimes:
         assert years > 0, f"years must be greater than 0, got {years}"
         self.years = years
 
-    def __iter__(self) -> Iterator[Tuple[datetime.datetime, datetime.datetime]]:
+    def __iter__(self) -> Iterator[tuple[datetime.datetime, datetime.datetime]]:
         """Generate tuples of past dates and their corresponding reference dates.
 
         Yields