lockss-pybasic 0.2.0.dev6__py3-none-any.whl → 0.2.0.dev8__py3-none-any.whl

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.2.0-dev6'
+__version__ = '0.2.0-dev8'

lockss/pybasic/auidutil.py

@@ -36,7 +36,7 @@ and related utility classes in the LOCKSS lockss-core library.
 """
 
 import urllib.parse
-from typing import Dict, Optional
+from typing import Dict
 
 
 class InvalidAuidError(ValueError):
@@ -60,7 +60,7 @@ class AuidGenerator:
         >>> params = {"base_url": "http://example.com/", "year": "2023"}
         >>> auid = AuidGenerator.generate_auid(plugin_id, params)
         >>> print(auid)
-        org|lockss|plugin|simulated|SimulatedPlugin&base_url~http%3A%2F%2Fexample.com%2F&year~2023
+        org|lockss|plugin|simulated|SimulatedPlugin&base_url~http%3A%2F%2Fexample%2Ecom%2F&year~2023
     """
 
     @staticmethod
@@ -103,6 +103,18 @@ class AuidGenerator:
             raise ValueError("plugin_key cannot be empty")
         return plugin_key.replace("|", ".")
 
+    # Characters that don't need encoding - matches Java PropKeyEncoder exactly
+    # See lockss-core PropKeyEncoder.java lines 46-62
+    _DONT_NEED_ENCODING = set(
+        'abcdefghijklmnopqrstuvwxyz'
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+        '0123456789'
+        ' '  # Space is converted to '+' in encode()
+        '-'
+        '_'
+        '*'
+    )
+
     @staticmethod
     def encode_component(s: str) -> str:
         """
@@ -111,9 +123,13 @@ class AuidGenerator:
         Port of PropKeyEncoder.encode() from lockss-core.
 
         This method encodes strings using URL encoding with the following rules:
-        - Alphanumeric characters, hyphens, underscores, periods, and asterisks are not encoded
+        - Alphanumeric characters (a-z, A-Z, 0-9) are not encoded
+        - Hyphens (-), underscores (_), and asterisks (*) are not encoded
         - Spaces are encoded as '+'
-        - All other characters are percent-encoded with uppercase hex digits
+        - All other characters (including periods) are percent-encoded with uppercase hex digits
+
+        Note: This differs from standard URL encoding (RFC 3986) which treats
+        periods (.) as unreserved. Java's PropKeyEncoder encodes periods.
 
         Args:
             s: String to encode
@@ -123,28 +139,25 @@ class AuidGenerator:
 
         Example:
             >>> AuidGenerator.encode_component("http://example.com/")
-            'http%3A%2F%2Fexample.com%2F'
+            'http%3A%2F%2Fexample%2Ecom%2F'
         """
         if not s:
             return ""
 
-        # Use quote_plus which converts spaces to '+'
-        # safe='-_.~' preserves unreserved characters per RFC 3986
-        # We use safe='' to match Java's PropKeyEncoder behavior more closely
-        encoded = urllib.parse.quote_plus(s, safe='')
-
-        # Convert to uppercase hex (urllib uses lowercase by default)
         result = []
-        i = 0
-        while i < len(encoded):
-            if encoded[i] == '%' and i + 2 < len(encoded):
-                result.append('%')
-                result.append(encoded[i+1].upper())
-                result.append(encoded[i+2].upper())
-                i += 3
+        # Encode string to UTF-8 bytes, matching Java's OutputStreamWriter behavior
+        for char in s:
+            if char in AuidGenerator._DONT_NEED_ENCODING:
+                if char == ' ':
+                    result.append('+')
+                else:
+                    result.append(char)
             else:
-                result.append(encoded[i])
-                i += 1
+                # Encode character to UTF-8 bytes and percent-encode each byte
+                char_bytes = char.encode('utf-8')
+                for byte in char_bytes:
+                    result.append('%')
+                    result.append(format(byte, '02X'))
 
         return ''.join(result)
 
@@ -165,7 +178,7 @@ class AuidGenerator:
         """
         if not s:
             return ""
-        return urllib.parse.unquote_plus(s)
+        return urllib.parse.unquote_plus(s, errors="strict")
 
     @staticmethod
     def props_to_canonical_encoded_string(props: Dict[str, str]) -> str:
@@ -231,8 +244,10 @@ class AuidGenerator:
 
         for pair in pairs:
             if "~" not in pair:
-                continue
+                raise ValueError("Missing tilde in key-value pair")
             key_encoded, val_encoded = pair.split("~", 1)
+            if "~" in val_encoded:
+                raise ValueError("Additional tilde in key-value pair")
             key = AuidGenerator.decode_component(key_encoded)
             val = AuidGenerator.decode_component(val_encoded)
             props[key] = val

lockss/pybasic/cliutil.py

@@ -31,18 +31,21 @@
 """
 Command line utilities.
 """
-
+import pathlib
 from collections.abc import Callable
 import sys
 from typing import Any, Dict, Generic, Optional, TypeVar
 
-from pydantic.v1 import BaseModel
+import click
+from pydantic.v1 import BaseModel as BaseModel1
 from pydantic_argparse import ArgumentParser
 from pydantic_argparse.argparse.actions import SubParsersAction
 from rich_argparse import RichHelpFormatter
 
+from .fileutil import path
+
 
-class ActionCommand(Callable, BaseModel):
+class ActionCommand(Callable, BaseModel1):
     """
     Base class for a pydantic-argparse style command.
     """
@@ -77,7 +80,7 @@ LICENSE_DESCRIPTION = 'print the software license and exit'
 VERSION_DESCRIPTION = 'print the version number and exit'
 
 
-BaseModelT = TypeVar('BaseModelT', bound=BaseModel)
+BaseModelT = TypeVar('BaseModelT', bound=BaseModel1)
 
 
 class BaseCli(Generic[BaseModelT]):
@@ -129,22 +132,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: BaseModel1, subcommands: list[str]) -> None:
+        field_names = base_model.__class__.__fields__.keys()
         for field_name in field_names:
-            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')
-                break
+            field_value = getattr(base_model, field_name)
+            if issubclass(type(field_value), BaseModel1):
+                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:
         """
@@ -234,7 +240,7 @@ def one_or_more(values: Dict[str, Any], *names: str):
     return values
 
 
-def option_name(model_cls: type[BaseModel], name: str) -> str:
+def option_name(model_cls: type[BaseModel1], name: str) -> str:
     if (info := model_cls.__fields__.get(name)) is None:
         raise RuntimeError(f'invalid name: {name}')
     if alias := info.alias:
@@ -244,3 +250,63 @@ def option_name(model_cls: type[BaseModel], name: str) -> str:
 
 def _matchy_length(values: Dict[str, Any], *names: str) -> int:
     return len([name for name in names if values.get(name)])
+
+
+def click_path(spec: Optional[str]) -> click.Path:
+    if spec is None:
+        spec = ''
+    allow_dash = False
+    dir_okay = True
+    executable = False
+    exists = False
+    file_okay = True
+    path_type = path
+    readable = True
+    resolve_path = False
+    writable = False
+    for char in spec:
+        if char == 'd':
+            if 'f' in spec:
+                raise ValueError(f'"d" and "f" are mutually exclusive: {spec}')
+            dir_okay = True
+            file_okay = False
+        elif char == 'e':
+            exists = True
+        elif char == 'f':
+            if 'd' in spec:
+                raise ValueError(f'"f" and "d" are mutually exclusive: {spec}')
+            dir_okay = False
+            file_okay = True
+        elif char == 'p':
+            if 'P' in spec or 's' in spec:
+                raise ValueError(f'"p", "P", and "s" are mutually exclusive: {spec}')
+            path_type = path
+        elif char == 'P':
+            if 'p' in spec or 's' in spec:
+                raise ValueError(f'"P", "p", and "s" are mutually exclusive: {spec}')
+            path_type = pathlib.Path
+        elif char == 'r':
+            readable = True
+        elif char == 's':
+            if 'p' in spec or 'P' in spec:
+                raise ValueError(f'"s", "p", and "P" are mutually exclusive: {spec}')
+            path_type = str
+        elif char == 'w':
+            writable = True
+        elif char == 'x':
+            executable = True
+        elif char == 'z':
+            resolve_path = True
+        elif char == '-':
+            allow_dash = True
+        else:
+            raise ValueError(f'unknown specification character "{char}": {spec}')
+        return click.Path(allow_dash=allow_dash,
+                          dir_okay=dir_okay,
+                          executable=executable,
+                          exists=exists,
+                          file_okay=file_okay,
+                          path_type=path_type,
+                          readable=readable,
+                          resolve_path=resolve_path,
+                          writable=writable)

{lockss_pybasic-0.2.0.dev6.dist-info → lockss_pybasic-0.2.0.dev8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockss-pybasic
-Version: 0.2.0.dev6
+Version: 0.2.0.dev8
 Summary: Basic Python utilities
 License: BSD-3-Clause
 License-File: LICENSE
@@ -8,7 +8,7 @@ Author: Thib Guicherd-Callin
 Author-email: thib@cs.stanford.edu
 Maintainer: Thib Guicherd-Callin
 Maintainer-email: thib@cs.stanford.edu
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Framework :: Pydantic :: 2
@@ -16,7 +16,8 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: pydantic (>=2.11.0,<3.0.0)
+Requires-Dist: click-extra (>=7.5.0,<7.6.0)
+Requires-Dist: pydantic (>=2.11.0,<2.12.0)
 Requires-Dist: pydantic-argparse (>=0.10.0,<0.11.0)
 Requires-Dist: rich-argparse (>=1.7.0,<1.8.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
@@ -27,8 +28,8 @@ Description-Content-Type: text/x-rst
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.1.1
-.. |RELEASE_DATE| replace:: 2025-10-02
+.. |RELEASE| replace:: 0.2.0-dev8
+.. |RELEASE_DATE| replace:: NOT YET RELEASED
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)
 

lockss_pybasic-0.2.0.dev8.dist-info/RECORD

@@ -0,0 +1,10 @@
+lockss/pybasic/__init__.py,sha256=A-Y9xGDnzeI7ZG2J4KT3DCP7lDVCAzlvJ1dJD87420E,1678
+lockss/pybasic/auidutil.py,sha256=o5IsRLEYROXRVS6oTO1VFtdzw7SImYSR5VcqAMHY4To,13921
+lockss/pybasic/cliutil.py,sha256=vf8lxc-m6p6if5D7uWIBynIxvCiG6uZg44pHCMSiSzs,12866
+lockss/pybasic/errorutil.py,sha256=XI84PScZ851_-gfoazivJ8ceieMYWaxQr7qih5ltga0,1951
+lockss/pybasic/fileutil.py,sha256=BpdoPWL70xYTuhyQRBEurScRVnPQg0mX-XW8yyKPGjw,2958
+lockss/pybasic/outpututil.py,sha256=8naQEZ1rM6vOFNL-9mWoK4dMBWokHmzQ0FkHaz8dyuM,2345
+lockss_pybasic-0.2.0.dev8.dist-info/METADATA,sha256=xucIusdQQSQBwgcbNN2uS-6nb4hHDzBMxh_0m1_B7rs,4326
+lockss_pybasic-0.2.0.dev8.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+lockss_pybasic-0.2.0.dev8.dist-info/licenses/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
+lockss_pybasic-0.2.0.dev8.dist-info/RECORD,,

lockss_pybasic-0.2.0.dev6.dist-info/RECORD

@@ -1,10 +0,0 @@
-lockss/pybasic/__init__.py,sha256=36qFj2gOmi2s3h_V6wwYbwaqcj9bSd41ZEes0hGtRFE,1678
-lockss/pybasic/auidutil.py,sha256=Udqompf_F4li3pfzQPgzjfp_A2s_litsZ7uucBQDHEg,13283
-lockss/pybasic/cliutil.py,sha256=tW6ojnvu2B_GNTmWS6ElV2xHJ3E2YGRDnQ4zQ9dU6uY,10533
-lockss/pybasic/errorutil.py,sha256=XI84PScZ851_-gfoazivJ8ceieMYWaxQr7qih5ltga0,1951
-lockss/pybasic/fileutil.py,sha256=BpdoPWL70xYTuhyQRBEurScRVnPQg0mX-XW8yyKPGjw,2958
-lockss/pybasic/outpututil.py,sha256=8naQEZ1rM6vOFNL-9mWoK4dMBWokHmzQ0FkHaz8dyuM,2345
-lockss_pybasic-0.2.0.dev6.dist-info/METADATA,sha256=1R9WSiC304TcXF7EtMxlVqMLFQAU_bvZ9SH1NjMhSmg,4269
-lockss_pybasic-0.2.0.dev6.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-lockss_pybasic-0.2.0.dev6.dist-info/licenses/LICENSE,sha256=O9ONND4uDxY_jucI4jZDf2liAk05ScEJaYu-Al7EOdQ,1506
-lockss_pybasic-0.2.0.dev6.dist-info/RECORD,,