anemoi-utils 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

anemoi/utils/__main__.py

@@ -8,64 +8,20 @@
 # nor does it submit to any jurisdiction.
 #
 
-
-import argparse
-import logging
-import sys
-import traceback
+from anemoi.utils.cli import cli_main
+from anemoi.utils.cli import make_parser
 
 from . import __version__
 from .commands import COMMANDS
 
-LOG = logging.getLogger(__name__)
-
-
-def main():
-    parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter)
-
-    parser.add_argument(
-        "--version",
-        "-V",
-        action="store_true",
-        help="show the version and exit",
-    )
-    parser.add_argument(
-        "--debug",
-        "-d",
-        action="store_true",
-        help="Debug mode",
-    )
 
-    subparsers = parser.add_subparsers(help="commands:", dest="command")
-    for name, command in COMMANDS.items():
-        command_parser = subparsers.add_parser(name, help=command.__doc__)
-        command.add_arguments(command_parser)
+# For read-the-docs
+def create_parser():
+    return make_parser(__doc__, COMMANDS)
 
-    args = parser.parse_args()
 
-    if args.version:
-        print(__version__)
-        return
-
-    if args.command is None:
-        parser.print_help()
-        return
-
-    cmd = COMMANDS[args.command]
-
-    logging.basicConfig(
-        format="%(asctime)s %(levelname)s %(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S",
-        level=logging.DEBUG if args.debug else logging.INFO,
-    )
-
-    try:
-        cmd.run(args)
-    except ValueError as e:
-        traceback.print_exc()
-        LOG.error("\n💣 %s", str(e).lstrip())
-        LOG.error("💣 Exiting")
-        sys.exit(1)
+def main():
+    cli_main(__version__, __doc__, COMMANDS)
 
 
 if __name__ == "__main__":

anemoi/utils/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)

anemoi/utils/cli.py

@@ -0,0 +1,126 @@
+# (C) Copyright 2024 European Centre for Medium-Range Weather Forecasts.
+# 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.
+
+import argparse
+import importlib
+import logging
+import os
+import sys
+import traceback
+
+LOG = logging.getLogger(__name__)
+
+
+class Command:
+    def run(self, args):
+        raise NotImplementedError(f"Command not implemented: {args.command}")
+
+
+def make_parser(description, commands):
+    parser = argparse.ArgumentParser(
+        description=description,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="store_true",
+        help="show the version and exit",
+    )
+    parser.add_argument(
+        "--debug",
+        "-d",
+        action="store_true",
+        help="Debug mode",
+    )
+
+    subparsers = parser.add_subparsers(help="commands:", dest="command")
+    for name, command in commands.items():
+        command_parser = subparsers.add_parser(name, help=command.__doc__)
+        command.add_arguments(command_parser)
+
+    return parser
+
+
+class Failed(Command):
+    def __init__(self, name, error):
+        self.name = name
+        self.error = error
+
+    def add_arguments(self, command_parser):
+        command_parser.add_argument("x", nargs=argparse.REMAINDER)
+
+    def run(self, args):
+        print(f"Command '{self.name}' not available: {self.error}")
+        sys.exit(1)
+
+
+def register_commands(here, package, select, fail=None):
+    result = {}
+    not_available = {}
+
+    for p in os.listdir(here):
+        full = os.path.join(here, p)
+        if p.startswith("_"):
+            continue
+        if not (p.endswith(".py") or (os.path.isdir(full) and os.path.exists(os.path.join(full, "__init__.py")))):
+            continue
+
+        name, _ = os.path.splitext(p)
+
+        try:
+            imported = importlib.import_module(
+                f".{name}",
+                package=package,
+            )
+        except ImportError as e:
+            not_available[name] = e
+            continue
+
+        obj = select(imported)
+        if obj is not None:
+            result[name] = obj
+
+    for name, e in not_available.items():
+        if fail is None:
+            pass
+        if callable(fail):
+            result[name] = fail(name, e)
+
+    return result
+
+
+def cli_main(version, description, commands):
+    parser = make_parser(description, commands)
+    args = parser.parse_args()
+
+    if args.version:
+        print(version)
+        return
+
+    if args.command is None:
+        parser.print_help()
+        return
+
+    cmd = commands[args.command]
+
+    logging.basicConfig(
+        format="%(asctime)s %(levelname)s %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+        level=logging.DEBUG if args.debug else logging.INFO,
+    )
+
+    try:
+        cmd.run(args)
+    except ValueError as e:
+        traceback.print_exc()
+        LOG.error("\n💣 %s", str(e).lstrip())
+        LOG.error("💣 Exiting")
+        sys.exit(1)
+
+    sys.exit(0)

anemoi/utils/commands/__init__.py

@@ -8,69 +8,15 @@
 # nor does it submit to any jurisdiction.
 #
 
-import argparse
-import importlib
-import logging
 import os
-import sys
 
-LOG = logging.getLogger(__name__)
+from anemoi.utils.cli import Command
+from anemoi.utils.cli import Failed
+from anemoi.utils.cli import register_commands
 
+__all__ = ["Command"]
 
-def register(here, package, select, fail=None):
-    result = {}
-    not_available = {}
-
-    for p in os.listdir(here):
-        full = os.path.join(here, p)
-        if p.startswith("_"):
-            continue
-        if not (p.endswith(".py") or (os.path.isdir(full) and os.path.exists(os.path.join(full, "__init__.py")))):
-            continue
-
-        name, _ = os.path.splitext(p)
-
-        try:
-            imported = importlib.import_module(
-                f".{name}",
-                package=package,
-            )
-        except ImportError as e:
-            not_available[name] = e
-            continue
-
-        obj = select(imported)
-        if obj is not None:
-            result[name] = obj
-
-    for name, e in not_available.items():
-        if fail is None:
-            pass
-        if callable(fail):
-            result[name] = fail(name, e)
-
-    return result
-
-
-class Command:
-    def run(self, args):
-        raise NotImplementedError(f"Command not implemented: {args.command}")
-
-
-class Failed(Command):
-    def __init__(self, name, error):
-        self.name = name
-        self.error = error
-
-    def add_arguments(self, command_parser):
-        command_parser.add_argument("x", nargs=argparse.REMAINDER)
-
-    def run(self, args):
-        print(f"Command '{self.name}' not available: {self.error}")
-        sys.exit(1)
-
-
-COMMANDS = register(
+COMMANDS = register_commands(
     os.path.dirname(__file__),
     __name__,
     lambda x: x.command(),

anemoi/utils/timer.py

@@ -16,6 +16,8 @@ LOGGER = logging.getLogger(__name__)
 
 
 class Timer:
+    """Context manager to measure elapsed time."""
+
     def __init__(self, title, logger=LOGGER):
         self.title = title
         self.start = time.time()

{anemoi_utils-0.2.0.dist-info → anemoi_utils-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: anemoi-utils
-Version: 0.2.0
+Version: 0.3.0
 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
@@ -205,51 +205,54 @@ License: Apache License
            See the License for the specific language governing permissions and
            limitations under the License.
         
-Project-URL: Homepage, https://github.com/ecmwf/anemoi-utils/
 Project-URL: Documentation, https://anemoi-utils.readthedocs.io/
-Project-URL: Repository, https://github.com/ecmwf/anemoi-utils/
+Project-URL: Homepage, https://github.com/ecmwf/anemoi-utils/
 Project-URL: Issues, https://github.com/ecmwf/anemoi-utils/issues
-Keywords: tools,ai
+Project-URL: Repository, https://github.com/ecmwf/anemoi-utils/
+Keywords: ai,tools
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 License-File: LICENSE
-Requires-Dist: tomli
 Requires-Dist: pyyaml
+Requires-Dist: tomli
 Requires-Dist: tqdm
 Provides-Extra: all
-Requires-Dist: tomli ; extra == 'all'
-Requires-Dist: GitPython ; extra == 'all'
+Requires-Dist: gitpython ; extra == 'all'
 Requires-Dist: nvsmi ; extra == 'all'
-Requires-Dist: termcolor ; extra == 'all'
+Requires-Dist: pyyaml ; extra == 'all'
 Requires-Dist: requests ; extra == 'all'
+Requires-Dist: termcolor ; extra == 'all'
+Requires-Dist: tomli ; extra == 'all'
+Requires-Dist: tqdm ; extra == 'all'
 Provides-Extra: dev
-Requires-Dist: tomli ; extra == 'dev'
-Requires-Dist: GitPython ; extra == 'dev'
+Requires-Dist: gitpython ; extra == 'dev'
 Requires-Dist: nvsmi ; extra == 'dev'
-Requires-Dist: termcolor ; extra == 'dev'
 Requires-Dist: requests ; extra == 'dev'
+Requires-Dist: termcolor ; extra == 'dev'
+Requires-Dist: tomli ; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: tomli ; extra == 'docs'
-Requires-Dist: termcolor ; extra == 'docs'
-Requires-Dist: requests ; extra == 'docs'
-Requires-Dist: sphinx ; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Requires-Dist: nbsphinx ; extra == 'docs'
 Requires-Dist: pandoc ; extra == 'docs'
+Requires-Dist: requests ; extra == 'docs'
+Requires-Dist: sphinx ; extra == 'docs'
 Requires-Dist: sphinx-argparse ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
+Requires-Dist: termcolor ; extra == 'docs'
+Requires-Dist: tomli ; extra == 'docs'
 Provides-Extra: grib
 Requires-Dist: requests ; extra == 'grib'
 Provides-Extra: provenance
-Requires-Dist: GitPython ; extra == 'provenance'
+Requires-Dist: gitpython ; extra == 'provenance'
 Requires-Dist: nvsmi ; extra == 'provenance'
 Provides-Extra: text
 Requires-Dist: termcolor ; extra == 'text'

{anemoi_utils-0.2.0.dist-info → anemoi_utils-0.3.0.dist-info}/RECORD

@@ -1,22 +1,23 @@
 anemoi/utils/__init__.py,sha256=zZZpbKIoGWwdCOuo6YSruLR7C0GzvzI1Wzhyqaa0K7M,456
-anemoi/utils/__main__.py,sha256=CGl8WF7rWMx9EoArysla0-ThjUFtEZUEGM58LbdU488,1798
-anemoi/utils/_version.py,sha256=H-qsvrxCpdhaQzyddR-yajEqI71hPxLa4KxzpP3uS1g,411
+anemoi/utils/__main__.py,sha256=cLA2PidDTOUHaDGzd0_E5iioKYNe-PSTv567Y2fuwQk,723
+anemoi/utils/_version.py,sha256=Jk2iAU7m-7Vx9XV1TtdD9ZoJraIncDq_4_Wd-qtUotg,411
 anemoi/utils/caching.py,sha256=HrC9aFHlcCTaM2Z5u0ivGIXz7eFu35UQQhUuwwuG2pk,1743
 anemoi/utils/checkpoints.py,sha256=1_3mg4B-ykTVfIvIUEv7IxGyREx_ZcilVbB3U-V6O6I,5165
+anemoi/utils/cli.py,sha256=39THXs5SVtJ3L4ugemgbRIlK4ivEGraSsu5ns9KUn68,3271
 anemoi/utils/config.py,sha256=XEesqODvkuE3ZA7dnEnZ-ooBRtU6ecPmkfP65FtialA,2147
 anemoi/utils/dates.py,sha256=Ot9OTY1uFvHxW1EU4DPv3oUqmzvkXTwKuwhlfVlY788,8426
 anemoi/utils/grib.py,sha256=gVfo4KYQv31iRyoqRDwk5tiqZDUgOIvhag_kO0qjYD0,3067
 anemoi/utils/humanize.py,sha256=LD6dGnqChxA5j3tMhSybsAGRQzi33d_qS9pUoUHubkc,10330
 anemoi/utils/provenance.py,sha256=v54L9jF1JgYcclOhg3iojRl1v3ajbiWz_oc289xTgO4,9574
 anemoi/utils/text.py,sha256=pGWtDvRFoDxAnSuZJiA-GOGJOJLHsw2dAm0tfVvPKno,8599
-anemoi/utils/timer.py,sha256=5aNdcxVmiCijRmqp0URmsqsDypLUJgME0GSn9bk8zxo,920
-anemoi/utils/commands/__init__.py,sha256=Pc5bhVgW92ox1lMR5WUOLuhiY2HT6PsadSHclyw99Vc,1983
+anemoi/utils/timer.py,sha256=JKOgFkpJxmVRn57DEBolmTGwr25P-ePTWASBd8CLeqM,972
+anemoi/utils/commands/__init__.py,sha256=qAybFZPBBQs0dyx7dZ3X5JsLpE90pwrqt1vSV7cqEIw,706
 anemoi/utils/commands/checkpoint.py,sha256=SEnAizU3WklqMXUjmIh4eNrgBVwmheKG9gEBS90zwYU,1741
 anemoi/utils/mars/__init__.py,sha256=RAeY8gJ7ZvsPlcIvrQ4fy9xVHs3SphTAPw_XJDtNIKo,1750
 anemoi/utils/mars/mars.yaml,sha256=R0dujp75lLA4wCWhPeOQnzJ45WZAYLT8gpx509cBFlc,66
-anemoi_utils-0.2.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-anemoi_utils-0.2.0.dist-info/METADATA,sha256=7IO_KqlBHcAKCmdszjmE5Zxe5G_ox2QOwKn16mgBIa4,15174
-anemoi_utils-0.2.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-anemoi_utils-0.2.0.dist-info/entry_points.txt,sha256=LENOkn88xzFQo-V59AKoA_F_cfYQTJYtrNTtf37YgHY,60
-anemoi_utils-0.2.0.dist-info/top_level.txt,sha256=DYn8VPs-fNwr7fNH9XIBqeXIwiYYd2E2k5-dUFFqUz0,7
-anemoi_utils-0.2.0.dist-info/RECORD,,
+anemoi_utils-0.3.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+anemoi_utils-0.3.0.dist-info/METADATA,sha256=1NyB5Hj8UIpWFzmZdyoAjAPmIEkLabl9AhNBruFLo88,15309
+anemoi_utils-0.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+anemoi_utils-0.3.0.dist-info/entry_points.txt,sha256=LENOkn88xzFQo-V59AKoA_F_cfYQTJYtrNTtf37YgHY,60
+anemoi_utils-0.3.0.dist-info/top_level.txt,sha256=DYn8VPs-fNwr7fNH9XIBqeXIwiYYd2E2k5-dUFFqUz0,7
+anemoi_utils-0.3.0.dist-info/RECORD,,