lockss-pybasic 0.1.0.dev6__tar.gz → 0.1.0.dev8__tar.gz

{lockss_pybasic-0.1.0.dev6 → lockss_pybasic-0.1.0.dev8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: lockss-pybasic
-Version: 0.1.0.dev6
+Version: 0.1.0.dev8
 Summary: Basic Python utilities
 License: BSD-3-Clause
 Author: Thib Guicherd-Callin
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: pydantic (>=2.11.3,<3.0.0)
+Requires-Dist: pydantic-argparse (>=0.10.0,<0.11.0)
 Description-Content-Type: text/x-rst
 
 

{lockss_pybasic-0.1.0.dev6 → lockss_pybasic-0.1.0.dev8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lockss-pybasic"
-version = "0.1.0-dev6"
+version = "0.1.0-dev8"
 description = "Basic Python utilities"
 authors = [
     { name = "Thib Guicherd-Callin", email = "thib@cs.stanford.edu" }
@@ -9,7 +9,8 @@ license = { text = "BSD-3-Clause" }
 readme = "README.rst"
 requires-python = ">=3.9,<4.0"
 dependencies = [
-    "pydantic (>=2.11.3,<3.0.0)"
+    "pydantic (>=2.11.3,<3.0.0)",
+    "pydantic-argparse (>=0.10.0,<0.11.0)"
 ]
 
 [tool.poetry]

{lockss_pybasic-0.1.0.dev6 → lockss_pybasic-0.1.0.dev8}/src/lockss/pybasic/__init__.py

@@ -32,4 +32,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-dev6'
+__version__ = '0.1.0-dev8'

lockss_pybasic-0.1.0.dev8/src/lockss/pybasic/cliutil.py

@@ -0,0 +1,125 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+'''
+Command line utilities.
+'''
+
+from abc import ABC, abstractmethod
+import sys
+from typing import Any, Dict, Generic, List, TypeVar
+
+from pydantic.v1 import BaseModel, Field
+from pydantic_argparse import ArgumentParser
+
+
+class Printable(ABC):
+
+    def print(self, file=sys.stdout):
+        print(self.get_display(), file=file)
+
+    @abstractmethod
+    def get_display(self):
+        pass
+
+
+class CopyrightCommand:
+
+    @staticmethod
+    def make(copyright):
+        class CopyrightModel(Printable, BaseModel):
+            def get_display(self):
+                return copyright
+        return CopyrightModel
+
+    @staticmethod
+    def field():
+        return Field(description='print the copyright and exit')
+
+
+class LicenseCommand:
+
+    @staticmethod
+    def make(license):
+        class LicenseModel(Printable, BaseModel):
+            def get_display(self):
+                return license
+        return LicenseModel
+
+    @staticmethod
+    def field():
+        return Field(description='print the software license and exit')
+
+
+class VersionCommand:
+
+    @staticmethod
+    def make(version):
+        class VersionModel(Printable, BaseModel):
+            def get_display(self):
+                return version
+        return VersionModel
+
+    @staticmethod
+    def field():
+        return Field(description='print the version number and exit')
+
+
+ModelT = TypeVar('ModelT')
+
+
+class BaseCli(Generic[ModelT], ABC):
+    args: ModelT
+    extra: Dict[str, Any]
+    parser: ArgumentParser
+
+    def __init__(self, **extra):
+        super().__init__()
+        self.extra = dict(**extra)
+
+    def run(self):
+        self.parser: ArgumentParser = ArgumentParser(model=self.extra.get('model'),
+                                                     prog=self.extra.get('prog'),
+                                                     description=self.extra.get('description'))
+        self.args = self.parser.parse_typed_args()
+        self.dispatch()
+
+    @abstractmethod
+    def dispatch(self):
+        pass
+
+
+def exactly_one(values: Dict[str, Any], *names: List[str]):
+    if (length := len([values[name] for name in names if values[name]])) != 1:
+        raise ValueError(f'exactly one of {', '.join([option_name(name) for name in names])} is required, got {length}')
+    return values
+
+def option_name(name: str):
+    return f'{('-' if len(name) == 1 else '--')}{name.replace('_', '-')}'

lockss_pybasic-0.1.0.dev6/src/lockss/pybasic/cliutil.py → lockss_pybasic-0.1.0.dev8/src/lockss/pybasic/errorutil.py

@@ -28,22 +28,11 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-import sys
+'''
+Error and exception utilities.
+'''
 
-from pydantic.v1 import BaseModel, Field
+class InternalError(RuntimeError):
 
-class VersionCommand:
-
-    @staticmethod
-    def make(version):
-        class VersionModel(BaseModel):
-
-            def print_version(self, file=sys.stdout):
-                print(version, file=file)
-                sys.exit(0)
-
-        return VersionModel
-
-    @staticmethod
-    def field():
-        return Field(description='print the version number and exit')
+    def __init__(self, *args: object) -> None:
+        super().__init__('internal error')

lockss_pybasic-0.1.0.dev8/src/lockss/pybasic/fileutil.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+
+# Copyright (c) 2000-2025, Board of Trustees of Leland Stanford Jr. University
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+'''
+File and path utilities.
+'''
+
+from pathlib import Path, PurePath
+import sys
+from typing import Union
+
+
+def file_lines(fpath: Path):
+    f = None
+    try:
+        f = open(path(fpath), 'r') if fpath != '-' else sys.stdin
+        return [line for line in [line.partition('#')[0].strip() for line in f] if len(line) > 0]
+    finally:
+        if f is not None and path != '-':
+            f.close()
+
+
+def path(purepath_or_string: Union[PurePath, str]):
+    if not issubclass(type(purepath_or_string), PurePath):
+        purepath_or_string = Path(purepath_or_string)
+    return purepath_or_string.expanduser().resolve()