lockss-pybasic 0.1.0.dev23__tar.gz → 0.2.0.dev2__tar.gz

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/CHANGELOG.rst

@@ -3,11 +3,17 @@ Release Notes
 =============
 
 -----
-0.1.0
+0.2.0
 -----
 
 Released: ?
 
+-----
+0.1.0
+-----
+
+Released: 2025-07-01
+
 Initial release, including:
 
 *  ``cliutil``

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lockss-pybasic
-Version: 0.1.0.dev23
+Version: 0.2.0.dev2
 Summary: Basic Python utilities
 License: BSD-3-Clause
 Author: Thib Guicherd-Callin
@@ -12,12 +12,9 @@ Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Framework :: Pydantic :: 2
 Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries
-Classifier: Topic :: System :: Archiving
-Classifier: Topic :: Utilities
 Requires-Dist: pydantic (>=2.11.0,<3.0.0)
 Requires-Dist: pydantic-argparse (>=0.10.0,<0.11.0)
 Requires-Dist: rich-argparse (>=1.7.0,<1.8.0)
@@ -29,8 +26,8 @@ Description-Content-Type: text/x-rst
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.1.0-dev23
-.. |RELEASE_DATE| replace:: ?
+.. |RELEASE| replace:: 0.1.0
+.. |RELEASE_DATE| replace:: 2025-07-01
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)
 

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/README.rst

@@ -2,8 +2,8 @@
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.1.0-dev23
-.. |RELEASE_DATE| replace:: ?
+.. |RELEASE| replace:: 0.1.0
+.. |RELEASE_DATE| replace:: 2025-07-01
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)
 

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/pyproject.toml

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-pybasic"
-version = "0.1.0-dev23" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.2.0-dev2" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
 description = "Basic Python utilities"
 license = { text = "BSD-3-Clause" }
 readme = "README.rst"
@@ -50,12 +50,9 @@ classifiers = [
     "Environment :: Console",
     "Framework :: Pydantic :: 2",
     "Intended Audience :: Developers",
-    "Intended Audience :: System Administrators",
     "License :: OSI Approved :: BSD License",
     "Programming Language :: Python",
     "Topic :: Software Development :: Libraries",
-    "Topic :: System :: Archiving",
-    "Topic :: Utilities",
 ]
 
 [project.urls]

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/src/lockss/pybasic/__init__.py

@@ -36,4 +36,4 @@ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 '''.strip()
 
-__version__ = '0.1.0-dev23'
+__version__ = '0.2.0-dev2'

{lockss_pybasic-0.1.0.dev23 → lockss_pybasic-0.2.0.dev2}/src/lockss/pybasic/cliutil.py

@@ -129,22 +129,25 @@ class BaseCli(Generic[BaseModelT]):
 
     def dispatch(self) -> None:
         """
-        Dispatches from the first field ``x_y_z`` in ``self.args`` that is a
+        Dispatches from the first field ``x_y_z`` in ``self._args`` that is a
         command (i.e. whose value derives from ``BaseModel``) to a method
         called ``_x_y_z``.
         """
-        field_names = self._args.__class__.__fields__.keys()
+        self._dispatch_recursive(self._args, [])
+
+    def _dispatch_recursive(self, base_model: BaseModel, subcommands: list[str]) -> None:
+        field_names = base_model.__class__.__fields__.keys()
         for field_name in field_names:
-            field_value = getattr(self._args, field_name)
+            field_value = getattr(base_model, field_name)
             if issubclass(type(field_value), BaseModel):
-                func = getattr(self, f'_{field_name}')
-                if callable(func):
-                    func(field_value)
-                else:
-                    self._parser.exit(1, f'internal error: no _{field_name} callable for the {field_name} command')
-                break
+                self._dispatch_recursive(field_value, [*subcommands, field_name])
+                return
+        func_name = ''.join(f'_{sub}' for sub in subcommands)
+        func = getattr(self, func_name)
+        if callable(func):
+            func(base_model) # FIXME?
         else:
-            self._parser.error(f'unknown command; expected one of {', '.join(field_names)}')
+            self._parser.exit(1, f'internal error: no {func_name} callable for the {" ".join(sub for sub in subcommands)} command')
 
     def _initialize_rich_argparse(self) -> None:
         """
@@ -176,7 +179,7 @@ class BaseCli(Generic[BaseModelT]):
             })
 
 
-def at_most_one_from_enum(model_cls, values: Dict[str, Any], enum_cls) -> Dict[str, Any]:
+def at_most_one_from_enum(model_cls: type[BaseModel], values: Dict[str, Any], enum_cls) -> Dict[str, Any]:
     """
     Among the fields of a Pydantic-Argparse model whose ``Field`` definition is
     tagged with the ``enum`` keyword set to the given ``Enum`` type, ensures
@@ -192,7 +195,7 @@ def at_most_one_from_enum(model_cls, values: Dict[str, Any], enum_cls) -> Dict[s
     enum_names = [field_name for field_name, model_field in model_cls.__fields__.items() if model_field.field_info.extra.get('enum') == enum_cls]
     ret = [field_name for field_name in enum_names if values.get(field_name)]
     if (length := len(ret)) > 1:
-        raise ValueError(f'at most one of {', '.join([option_name(enum_name) for enum_name in enum_names])} is allowed, got {length} ({', '.join([option_name(enum_name) for enum_name in ret])})')
+        raise ValueError(f'at most one of {', '.join([option_name(model_cls, enum_name) for enum_name in enum_names])} is allowed, got {length} ({', '.join([option_name(enum_name) for enum_name in ret])})')
     return values
 
 
@@ -216,25 +219,29 @@ def get_from_enum(model_inst, enum_cls, default=None):
     return default
 
 
-def at_most_one(values: Dict[str, Any], *names: str):
+def at_most_one(model_cls: type[BaseModel], values: Dict[str, Any], *names: str):
     if (length := _matchy_length(values, *names)) > 1:
-        raise ValueError(f'at most one of {', '.join([option_name(name) for name in names])} is allowed, got {length}')
+        raise ValueError(f'at most one of {', '.join([option_name(model_cls, name) for name in names])} is allowed, got {length}')
     return values
 
 
-def exactly_one(values: Dict[str, Any], *names: str):
+def exactly_one(model_cls: type[BaseModel], values: Dict[str, Any], *names: str):
     if (length := _matchy_length(values, *names)) != 1:
-        raise ValueError(f'exactly one of {', '.join([option_name(name) for name in names])} is required, got {length}')
+        raise ValueError(f'exactly one of {', '.join([option_name(model_cls, name) for name in names])} is required, got {length}')
     return values
 
 
-def one_or_more(values: Dict[str, Any], *names: str):
+def one_or_more(model_cls: type[BaseModel], values: Dict[str, Any], *names: str):
     if _matchy_length(values, *names) == 0:
-        raise ValueError(f'one or more of {', '.join([option_name(name) for name in names])} is required')
+        raise ValueError(f'one or more of {', '.join([option_name(model_cls, name) for name in names])} is required')
     return values
 
 
-def option_name(name: str) -> str:
+def option_name(model_cls: type[BaseModel], name: str) -> str:
+    if (info := model_cls.__fields__.get(name)) is None:
+        raise RuntimeError(f'invalid name: {name}')
+    if alias := info.alias:
+        name = alias
     return f'{('-' if len(name) == 1 else '--')}{name.replace('_', '-')}'