lockss-pybasic 0.1.0.dev14__tar.gz → 0.1.0.dev16__tar.gz

{lockss_pybasic-0.1.0.dev14 → lockss_pybasic-0.1.0.dev16}/PKG-INFO

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

{lockss_pybasic-0.1.0.dev14 → lockss_pybasic-0.1.0.dev16}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lockss-pybasic"
-version = "0.1.0-dev14"
+version = "0.1.0-dev16"
 description = "Basic Python utilities"
 authors = [
     { name = "Thib Guicherd-Callin", email = "thib@cs.stanford.edu" }
@@ -10,7 +10,8 @@ readme = "README.rst"
 requires-python = ">=3.9,<4.0"
 dependencies = [
     "pydantic (>=2.11.0,<3.0.0)",
-    "pydantic-argparse (>=0.10.0,<0.11.0)"
+    "pydantic-argparse (>=0.10.0,<0.11.0)",
+    "tabulate (>=0.9.0,<0.10.0)"
 ]
 
 [tool.poetry]

{lockss_pybasic-0.1.0.dev14 → lockss_pybasic-0.1.0.dev16}/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-dev14'
+__version__ = '0.1.0-dev16'

{lockss_pybasic-0.1.0.dev14 → lockss_pybasic-0.1.0.dev16}/src/lockss/pybasic/cliutil.py

@@ -89,8 +89,8 @@ class BaseCli(Generic[BaseModelT]):
                       the program.
         """
         super().__init__()
-        self.args: Optional[BaseModelT] = None
-        self.parser: Optional[ArgumentParser] = None
+        self._args: Optional[BaseModelT] = None
+        self._parser: Optional[ArgumentParser] = None
         self.extra: Dict[str, Any] = dict(**extra)
 
     def run(self) -> None:
@@ -107,10 +107,10 @@ class BaseCli(Generic[BaseModelT]):
 
         :return: Nothing.
         """
-        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._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()
 
     def dispatch(self) -> None:
@@ -121,18 +121,18 @@ class BaseCli(Generic[BaseModelT]):
 
         :return: Nothing.
         """
-        field_names = self.args.__class__.__fields__.keys()
+        field_names = self._args.__class__.__fields__.keys()
         for field_name in field_names:
-            field_value = getattr(self.args, field_name)
+            field_value = getattr(self._args, 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')
+                    self._parser.exit(1, f'internal error: no _{field_name} callable for the {field_name} command')
                 break
         else:
-            self.parser.error(f'unknown command; expected one of {', '.join(field_names)}')
+            self._parser.error(f'unknown command; expected one of {', '.join(field_names)}')
 
 
 def at_most_one_from_enum(model_cls, values: Dict[str, Any], enum_cls) -> Dict[str, Any]:

lockss_pybasic-0.1.0.dev16/src/lockss/pybasic/outpututil.py

@@ -0,0 +1,59 @@
+#!/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.
+
+"""
+Utilities to work with 'tabulate'.
+"""
+
+
+from enum import Enum
+
+
+from pydantic.v1 import BaseModel, Field, validator
+import tabulate
+from typing import Optional
+
+
+OutputFormat = Enum('OutputFormat', tabulate.tabulate_formats)
+
+
+DEFAULT_OUTPUT_FORMAT = 'simple' # from tabulate
+
+
+class OutputFormatOptions(BaseModel):
+    output_format: Optional[str] = Field(DEFAULT_OUTPUT_FORMAT, description=f'[output] set the output format; choices: {', '.join(OutputFormat.__members__.keys())}')
+
+    @validator('output_format')
+    def _validate_output_format(cls, val: str):
+        try:
+            _ = OutputFormat[val]
+            return val
+        except KeyError:
+            raise ValueError(f'must be one of {', '.join(OutputFormat.__members__.keys())}; got {val}')