anemoi-utils 0.4.12__py3-none-any.whl → 0.4.14__py3-none-any.whl

anemoi/utils/text.py

@@ -8,16 +8,21 @@
 # nor does it submit to any jurisdiction.
 
 
-"""Text utilities"""
+"""Text utilities."""
 
 import re
 from collections import defaultdict
+from typing import Any
+from typing import List
+from typing import Optional
+from typing import Tuple
+from typing import Union
 
 # https://en.wikipedia.org/wiki/Box-drawing_character
 
 
 def dotted_line(width=84) -> str:
-    """Return a dotted line using '┈'
+    """Return a dotted line using '┈'.
 
     >>> dotted_line(40)
     ┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈┈
@@ -40,12 +45,35 @@ def dotted_line(width=84) -> str:
 _ansi_escape = re.compile(r"\x1b\[([0-9;]*[mGKH])")
 
 
-def _has_ansi_escape(s):
+def _has_ansi_escape(s: str) -> bool:
+    """Check if a string contains ANSI escape codes.
+
+    Parameters
+    ----------
+    s : str
+        The string to check.
+
+    Returns
+    -------
+    bool
+        True if the string contains ANSI escape codes, False otherwise.
+    """
     return _ansi_escape.search(s) is not None
 
 
-def _split_tokens(s):
-    """Split a string into a list of visual characters with their lenghts."""
+def _split_tokens(s: str) -> List[Tuple[str, int]]:
+    """Split a string into a list of visual characters with their lengths.
+
+    Parameters
+    ----------
+    s : str
+        The string to split.
+
+    Returns
+    -------
+    list of tuple
+        A list of tuples where each tuple contains a visual character and its length.
+    """
     from wcwidth import wcswidth
 
     initial = s
@@ -76,8 +104,19 @@ def _split_tokens(s):
     return out
 
 
-def visual_len(s):
-    """Compute the length of a string as it appears on the terminal."""
+def visual_len(s: Union[str, List[Tuple[str, int]]]) -> int:
+    """Compute the length of a string as it appears on the terminal.
+
+    Parameters
+    ----------
+    s : str or list of tuple
+        The string or list of visual characters with their lengths.
+
+    Returns
+    -------
+    int
+        The visual length of the string.
+    """
     if isinstance(s, str):
         s = _split_tokens(s)
     assert isinstance(s, (tuple, list)), (type(s), s)
@@ -92,8 +131,8 @@ def visual_len(s):
     return n
 
 
-def boxed(text, min_width=80, max_width=80) -> str:
-    """Put a box around a text
+def boxed(text: str, min_width: int = 80, max_width: int = 80) -> str:
+    """Put a box around a text.
 
     >>> boxed("Hello,\\nWorld!", max_width=40)
     ┌──────────────────────────────────────────┐
@@ -114,12 +153,11 @@ def boxed(text, min_width=80, max_width=80) -> str:
     -------
     str
         A boxed version of the input text
-
     """
 
     lines = []
     for line in text.split("\n"):
-        line = line.strip()
+        line = line.rstrip()
         line = _split_tokens(line)
         lines.append(line)
 
@@ -158,68 +196,157 @@ def boxed(text, min_width=80, max_width=80) -> str:
     return "\n".join(box)
 
 
-def bold(text):
+def bold(text: str) -> str:
+    """Make the text bold.
+
+    Parameters
+    ----------
+    text : str
+        The text to make bold.
+
+    Returns
+    -------
+    str
+        The bold text.
+    """
     from termcolor import colored
 
     return colored(text, attrs=["bold"])
 
 
-def red(text):
+def red(text: str) -> str:
+    """Make the text red.
+
+    Parameters
+    ----------
+    text : str
+        The text to make red.
+
+    Returns
+    -------
+    str
+        The red text.
+    """
     from termcolor import colored
 
     return colored(text, "red")
 
 
-def green(text):
+def green(text: str) -> str:
+    """Make the text green.
+
+    Parameters
+    ----------
+    text : str
+        The text to make green.
+
+    Returns
+    -------
+    str
+        The green text.
+    """
     from termcolor import colored
 
     return colored(text, "green")
 
 
-def blue(text):
+def blue(text: str) -> str:
+    """Make the text blue.
+
+    Parameters
+    ----------
+    text : str
+        The text to make blue.
+
+    Returns
+    -------
+    str
+        The blue text.
+    """
     from termcolor import colored
 
     return colored(text, "blue")
 
 
 class Tree:
-    """Tree data structure."""
+    """Tree data structure.
 
-    def __init__(self, actor, parent=None):
+    Parameters
+    ----------
+    actor : Any
+        The actor associated with the tree node.
+    parent : Tree, optional
+        The parent tree node, by default None.
+    """
+
+    def __init__(self, actor: Any, parent: Optional["Tree"] = None):
         self._actor = actor
         self._kids = []
         self._parent = parent
 
-    def adopt(self, kid):
+    def adopt(self, kid: "Tree") -> None:
+        """Adopt a child tree node.
+
+        Parameters
+        ----------
+        kid : Tree
+            The child tree node to adopt.
+        """
         kid._parent._kids.remove(kid)
         self._kids.append(kid)
         kid._parent = self
         # assert False
 
-    def forget(self):
+    def forget(self) -> None:
+        """Forget the current tree node."""
         self._parent._kids.remove(self)
         self._parent = None
 
     @property
-    def is_leaf(self):
+    def is_leaf(self) -> bool:
+        """Bool: True if the tree node is a leaf, False otherwise."""
         return len(self._kids) == 0
 
     @property
-    def key(self):
+    def key(self) -> Tuple:
+        """Tuple: The key of the tree node."""
         return tuple(sorted(self._actor.as_dict().items()))
 
     @property
-    def _text(self):
+    def _text(self) -> str:
+        """Str: The text representation of the tree node."""
         return self._actor.summary
 
     @property
-    def summary(self):
+    def summary(self) -> str:
+        """Str: The summary of the tree node."""
         return self._actor.summary
 
-    def as_dict(self):
+    def as_dict(self) -> dict:
+        """Convert the tree node to a dictionary.
+
+        Returns
+        -------
+        dict
+            The dictionary representation of the tree node.
+        """
         return self._actor.as_dict()
 
-    def node(self, actor, insert=False):
+    def node(self, actor: Any, insert: bool = False) -> "Tree":
+        """Create a new tree node.
+
+        Parameters
+        ----------
+        actor : Any
+            The actor associated with the new tree node.
+        insert : bool, optional
+            Whether to insert the new tree node at the beginning, by default False.
+
+        Returns
+        -------
+        Tree
+            The new tree node.
+        """
         node = Tree(actor, self)
         if insert:
             self._kids.insert(0, node)
@@ -227,7 +354,8 @@ class Tree:
             self._kids.append(node)
         return node
 
-    def print(self):
+    def print(self) -> None:
+        """Print the tree."""
         padding = []
 
         while self._factorise():
@@ -235,14 +363,28 @@ class Tree:
 
         self._print(padding)
 
-    def _leaves(self, result):
+    def _leaves(self, result: List["Tree"]) -> None:
+        """Collect all leaf nodes.
+
+        Parameters
+        ----------
+        result : list of Tree
+            The list to collect the leaf nodes.
+        """
         if self.is_leaf:
             result.append(self)
         else:
             for kid in self._kids:
                 kid._leaves(result)
 
-    def _factorise(self):
+    def _factorise(self) -> bool:
+        """Factorise the tree.
+
+        Returns
+        -------
+        bool
+            True if the tree was factorised, False otherwise.
+        """
         if len(self._kids) == 0:
             return False
 
@@ -290,7 +432,14 @@ class Tree:
 
         return result
 
-    def _print(self, padding):
+    def _print(self, padding: List[str]) -> None:
+        """Print the tree with padding.
+
+        Parameters
+        ----------
+        padding : list of str
+            The padding for each level of the tree.
+        """
         for i, p in enumerate(padding[:-1]):
             if p == " └":
                 padding[i] = "  "
@@ -308,7 +457,19 @@ class Tree:
 
         padding.pop()
 
-    def to_json(self, depth=0):
+    def to_json(self, depth: int = 0) -> dict:
+        """Convert the tree to a JSON serializable dictionary.
+
+        Parameters
+        ----------
+        depth : int, optional
+            The depth of the tree, by default 0.
+
+        Returns
+        -------
+        dict
+            The JSON serializable dictionary representation of the tree.
+        """
         while self._factorise():
             pass
 
@@ -319,20 +480,20 @@ class Tree:
         }
 
 
-def table(rows, header, align, margin=0) -> str:
-    """Format a table
+def table(rows: List[List[Any]], header: List[str], align: List[str], margin: int = 0) -> str:
+    """Format a table.
 
-    >>> table([['Aa', 12, 5],
-               ['B', 120, 1],
-               ['C', 9, 123]],
-               ['C1', 'C2', 'C3'],
-               ['<', '>', '>'])
-        C1 │  C2 │  C3
-        ───┼─────┼────
-        Aa │  12 │   5
-        B  │ 120 │   1
-        C  │   9 │ 123
-        ───┴─────┴────
+        >>> table([['Aa', 12, 5],
+                ['B', 120, 1],
+                ['C', 9, 123]],
+                ['C1', 'C2', 'C3'],
+                ['<', '>', '>'])
+            C1 │  C2 │  C3
+            ───┼─────┼────
+            Aa │  12 │   5
+            B  │ 120 │   1
+            C  │   9 │ 123
+            ───┴─────┴────
 
     Parameters
     ----------
@@ -397,26 +558,29 @@ def table(rows, header, align, margin=0) -> str:
     return "\n".join(result)
 
 
-def progress(done, todo, width=80) -> str:
-    """_summary_
-
-    >>> print(progress(10, 100,width=50))
-    █████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+def progress(done: int, todo: int, width: int = 80) -> str:
+    """Generates a progress bar string.
 
     Parameters
     ----------
-    done : function
-        _description_
-    todo : _type_
-        _description_
+
+    done : int
+        The number of tasks completed.
+    todo : int
+        The total number of tasks.
     width : int, optional
-        _description_, by default 80
+        The width of the progress bar, by default 80.
 
     Returns
     -------
     str
-        _description_
+        A string representing the progress bar.
 
+    Example
+    -------
+
+    >>> print(progress(10, 100,width=50))
+    █████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
     """
     done = min(int(done / todo * width + 0.5), width)
     return green("█" * done) + red("█" * (width - done))

anemoi/utils/timer.py

@@ -13,6 +13,7 @@
 import logging
 import time
 from collections import defaultdict
+from typing import Any
 
 from .humanize import seconds_to_human
 
@@ -20,21 +21,53 @@ LOGGER = logging.getLogger(__name__)
 
 
 class Timer:
-    """Context manager to measure elapsed time."""
-
-    def __init__(self, title, logger=LOGGER):
+    """Context manager to measure elapsed time.
+
+    Parameters
+    ----------
+    title : str
+        The title of the timer.
+    logger : logging.Logger, optional
+        The logger to use for logging the elapsed time, by default LOGGER.
+    """
+
+    def __init__(self, title: str, logger: logging.Logger = LOGGER):
+        """Initialize the Timer.
+
+        Parameters
+        ----------
+        title : str
+            The title of the timer.
+        logger : logging.Logger, optional
+            The logger to use for logging the elapsed time, by default LOGGER.
+        """
         self.title = title
         self.start = time.time()
         self.logger = logger
 
-    def __enter__(self):
+    def __enter__(self) -> "Timer":
+        """Enter the runtime context related to this object.
+
+        Returns
+        -------
+        Timer
+            The Timer object itself.
+        """
         return self
 
     @property
-    def elapsed(self):
+    def elapsed(self) -> float:
+        """Float: The elapsed time in seconds."""
         return time.time() - self.start
 
-    def __exit__(self, *args):
+    def __exit__(self, *args: Any) -> None:
+        """Exit the runtime context related to this object.
+
+        Parameters
+        ----------
+        *args : Any
+            Exception information.
+        """
         self.logger.info("%s: %s.", self.title, seconds_to_human(self.elapsed))
 
 
@@ -42,33 +75,76 @@ class _Timer:
     """Internal timer class."""
 
     def __init__(self):
+        """Initialize the _Timer."""
         self.elapsed = 0.0
 
-    def __enter__(self):
+    def __enter__(self) -> "_Timer":
+        """Enter the runtime context related to this object.
+
+        Returns
+        -------
+        _Timer
+            The _Timer object itself.
+        """
         self.start()
         return self
 
-    def __exit__(self, *args):
+    def __exit__(self, *args: Any) -> None:
+        """Exit the runtime context related to this object.
+
+        Parameters
+        ----------
+        *args : Any
+            Exception information.
+        """
         self.stop()
 
-    def start(self):
+    def start(self) -> None:
+        """Start the timer."""
         self._start = time.time()
 
-    def stop(self):
+    def stop(self) -> None:
+        """Stop the timer and accumulate the elapsed time."""
         self.elapsed += time.time() - self._start
 
 
 class Timers:
-    """A collection of timers."""
-
-    def __init__(self, logger=LOGGER):
+    """A collection of timers.
+
+    Parameters
+    ----------
+    logger : logging.Logger, optional
+        The logger to use for logging the elapsed time, by default LOGGER.
+    """
+
+    def __init__(self, logger: logging.Logger = LOGGER):
+        """Initialize the Timers collection.
+
+        Parameters
+        ----------
+        logger : logging.Logger, optional
+            The logger to use for logging the elapsed time, by default LOGGER.
+        """
         self.logger = logger
         self.timers = defaultdict(_Timer)
 
-    def __getitem__(self, name):
+    def __getitem__(self, name: str) -> _Timer:
+        """Get a timer by name.
+
+        Parameters
+        ----------
+        name : str
+            The name of the timer.
+
+        Returns
+        -------
+        _Timer
+            The timer with the given name.
+        """
         return self.timers[name]
 
-    def report(self):
+    def report(self) -> None:
+        """Log the elapsed time for all timers."""
         length = max(len(name) for name in self.timers)
         for name, timer in sorted(self.timers.items()):
             self.logger.info("%s: %s.", f"{name:<{length}}", seconds_to_human(timer.elapsed))

{anemoi_utils-0.4.12.dist-info → anemoi_utils-0.4.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: anemoi-utils
-Version: 0.4.12
+Version: 0.4.14
 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
@@ -226,13 +226,14 @@ Requires-Python: >=3.9
 License-File: LICENSE
 Requires-Dist: aniso8601
 Requires-Dist: importlib-metadata; python_version < "3.10"
+Requires-Dist: multiurl
 Requires-Dist: numpy
 Requires-Dist: python-dateutil
 Requires-Dist: pyyaml
 Requires-Dist: tomli; python_version < "3.11"
 Requires-Dist: tqdm
 Provides-Extra: all
-Requires-Dist: anemoi-utils[grib,provenance,text]; extra == "all"
+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
@@ -240,7 +241,7 @@ Requires-Dist: nbsphinx; extra == "docs"
 Requires-Dist: pandoc; extra == "docs"
 Requires-Dist: requests; extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx-argparse<0.5; extra == "docs"
+Requires-Dist: sphinx-argparse; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: termcolor; extra == "docs"
 Provides-Extra: grib
@@ -248,8 +249,11 @@ Requires-Dist: requests; extra == "grib"
 Provides-Extra: provenance
 Requires-Dist: gitpython; extra == "provenance"
 Requires-Dist: nvsmi; extra == "provenance"
+Provides-Extra: s3
+Requires-Dist: boto3<1.36; extra == "s3"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Provides-Extra: text
 Requires-Dist: termcolor; extra == "text"
 Requires-Dist: wcwidth; extra == "text"
+Dynamic: license-file

anemoi_utils-0.4.14.dist-info/RECORD

@@ -0,0 +1,38 @@
+anemoi/utils/__init__.py,sha256=uVhpF-VjIl_4mMywOVtgTutgsdIsqz-xdkwxeMhzuag,730
+anemoi/utils/__main__.py,sha256=6LlE4MYrPvqqrykxXh7XMi50UZteUY59NeM8P9Zs2dU,910
+anemoi/utils/_version.py,sha256=ggKLQlA5gegh3l4LAMWuwHPmL8zgZ4b0pYtFx7quk78,513
+anemoi/utils/caching.py,sha256=rXbeAmpBcMbbfN4EVblaHWKicsrtx1otER84FEBtz98,6183
+anemoi/utils/checkpoints.py,sha256=N4WpAZXa4etrpSEKhHqUUtG2-x9w3FJMHcLO-dDAXPY,9600
+anemoi/utils/cli.py,sha256=IyZfnSw0u0yYnrjOrzvm2RuuKvDk4cVb8pf8BkaChgA,6209
+anemoi/utils/compatibility.py,sha256=wRBRMmxQP88rNcWiP5gqXliwYQbBv1iCAsDjcCRi5UY,2234
+anemoi/utils/config.py,sha256=4K4_ePeuUPyIMsE7-r77OC87ntFGdVLskB0ow9XNzXI,16353
+anemoi/utils/dates.py,sha256=CnY6JOdpk0T-waPEowMRTkcMzxcN0GcjPVtLkwH_byw,17196
+anemoi/utils/devtools.py,sha256=vivYRQ1l2aMAkggqhpMJcJedfCrRfpy5XMQjZIsMJS0,3596
+anemoi/utils/grib.py,sha256=201WcxjjAl92Y2HX2kZ2S8Qr5dN-oG7nV-vQLaybzP4,3610
+anemoi/utils/grids.py,sha256=edTrMK8hpE9ZBzSfwcRftgk0jljNAK3i8CraadILQoM,4427
+anemoi/utils/hindcasts.py,sha256=iYVIxSNFL2HJcc_k1abCFLkpJFGHT8WKRIR4wcAwA3s,2144
+anemoi/utils/humanize.py,sha256=hCrHr5ppREuJR-tBqRqynqe58BHR6Ga_gCQqgEmmrfU,25301
+anemoi/utils/logs.py,sha256=naTgrmPwWHD4eekFttXftS4gtcAGYHpCqG4iwYprNDA,1804
+anemoi/utils/provenance.py,sha256=tIIgweS0EJyaYzgKwuv3iWny-Gz7N5e5CNWH5MeSYWU,14615
+anemoi/utils/registry.py,sha256=zTnVSCecmrI6SkZhF4ipV7WKiZYHEBJ_5ZwqhRGM4T0,9287
+anemoi/utils/s3.py,sha256=xMT48kbcelcjjqsaU567WI3oZ5eqo88Rlgyx5ECszAU,4074
+anemoi/utils/sanitise.py,sha256=ZYGdSX6qihQANr3pHZjbKnoapnzP1KcrWdW1Ul1mOGk,3668
+anemoi/utils/sanitize.py,sha256=43ZKDcfVpeXSsJ9TFEc9aZnD6oe2cUh151XnDspM98M,462
+anemoi/utils/testing.py,sha256=N1y4dfZLE9zqOhIR3o-933fdAdd9BxDvjcJx7SwFC9A,4803
+anemoi/utils/text.py,sha256=HkzIvi24obDceFLpJEwBJ9PmPrJUkQN2TrElJ-A87gU,14441
+anemoi/utils/timer.py,sha256=_leKMYza2faM7JKlGE7LCNy13rbdPnwaCF7PSrI_NmI,3895
+anemoi/utils/commands/__init__.py,sha256=5u_6EwdqYczIAgJfCwRSyQAYFEqh2ZuHHT57g9g7sdI,808
+anemoi/utils/commands/config.py,sha256=nYvYbjcum9uumRa3gzPfmQCjNZKURXMA2XOUwz9b7ls,1369
+anemoi/utils/commands/requests.py,sha256=AEbssF1OlpbmSwrV5Lj6amCCn0w_-nbajBWTwYV15vA,2059
+anemoi/utils/mars/__init__.py,sha256=b-Lc3L1TAQd9ODs0Z1YSJzgZCO1K_M3DSgx_yd2qXvM,2724
+anemoi/utils/mars/mars.yaml,sha256=R0dujp75lLA4wCWhPeOQnzJ45WZAYLT8gpx509cBFlc,66
+anemoi/utils/mars/requests.py,sha256=VFMHBVAAl0_2lOcMBa1lvaKHctN0lDJsI6_U4BucGew,1142
+anemoi/utils/remote/__init__.py,sha256=-uaYFi4yRYFRf46ubQbJo86GCn6HE5VQrcaoyrmyW28,20704
+anemoi/utils/remote/s3.py,sha256=spQ8l0rwQjLZh9dZu5cOsYIvNwKihQfCJ6YsFYegeqI,17339
+anemoi/utils/remote/ssh.py,sha256=xNtsawh8okytCKRehkRCVExbHZj-CRUQNormEHglfuw,8088
+anemoi_utils-0.4.14.dist-info/licenses/LICENSE,sha256=8HznKF1Vi2IvfLsKNE5A2iVyiri3pRjRPvPC9kxs6qk,11354
+anemoi_utils-0.4.14.dist-info/METADATA,sha256=VLuh3lxCAuACOrJRnE_Dm0zX_pVfIHoppmRrP505pkY,15360
+anemoi_utils-0.4.14.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+anemoi_utils-0.4.14.dist-info/entry_points.txt,sha256=LENOkn88xzFQo-V59AKoA_F_cfYQTJYtrNTtf37YgHY,60
+anemoi_utils-0.4.14.dist-info/top_level.txt,sha256=DYn8VPs-fNwr7fNH9XIBqeXIwiYYd2E2k5-dUFFqUz0,7
+anemoi_utils-0.4.14.dist-info/RECORD,,

{anemoi_utils-0.4.12.dist-info → anemoi_utils-0.4.14.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (77.0.3)
 Root-Is-Purelib: true
 Tag: py3-none-any