lockss-pybasic 0.3.0.dev3__tar.gz → 0.3.0.dev5__tar.gz

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockss-pybasic
-Version: 0.3.0.dev3
+Version: 0.3.0.dev5
 Summary: Basic Python utilities
 License: BSD-3-Clause
 License-File: LICENSE
@@ -17,7 +17,7 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Programming Language :: Python
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: annotated-types (>=0.7.0,<0.8.0)
-Requires-Dist: click-extra (>=7.17.0,<7.18.0)
+Requires-Dist: click-extra (>=7.18.0,<7.19.0)
 Requires-Dist: pydantic (>=2.13.0,<2.14.0)
 Project-URL: Repository, https://github.com/lockss/lockss-pybasic
 Description-Content-Type: text/x-rst
@@ -26,7 +26,7 @@ Description-Content-Type: text/x-rst
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.3.0-dev3
+.. |RELEASE| replace:: 0.3.0-dev5
 .. |RELEASE_DATE| replace:: NOT YET RELEASED
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/README.rst

@@ -2,7 +2,7 @@
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.3.0-dev3
+.. |RELEASE| replace:: 0.3.0-dev5
 .. |RELEASE_DATE| replace:: NOT YET RELEASED
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/pyproject.toml

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-pybasic"
-version = "0.3.0-dev3" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.3.0-dev5" # 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"
@@ -41,7 +41,7 @@ maintainers = [
 ]
 dependencies = [
     "annotated-types (>=0.7.0,<0.8.0)", # from Pydantic
-    "click-extra (>=7.17.0,<7.18.0)",
+    "click-extra (>=7.18.0,<7.19.0)",
     "pydantic (>=2.13.0,<2.14.0)",
 ]
 classifiers = [

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/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.3.0-dev3'
+__version__ = '0.3.0-dev5'

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/src/lockss/pybasic/cliutil.py

@@ -33,17 +33,18 @@ Command line utilities.
 """
 
 from pathlib import Path
-from typing import Any, Optional, Union
+from typing import Any, Optional, TypeAlias, Union
 
-import click
-from click.types import ParamType, IntRange
-from click_extra import ChoiceSource, EnumChoice, ExtraContext, HelpExtraFormatter, Style, TableFormat, option
-from click_extra.colorize import default_theme
+from click_extra import ChoiceSource, EnumChoice, ExtraContext, HelpExtraFormatter, IntRange, ParamType, Path, Style, TableFormat, option
+from click_extra.theme import get_default_theme
 
 
-def click_path(spec: Optional[str]) -> click.Path:
+ClickPath: TypeAlias = Path
+
+
+def click_path(spec: Optional[str]) -> ClickPath:
     """
-    Generates a ``click.Path`` based on a specification string.
+    Generates a ``ClickPath`` (``click.Path``) based on a specification string.
 
     The specification string can contain the following specifier characters:
 
@@ -147,15 +148,15 @@ def click_path(spec: Optional[str]) -> click.Path:
             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)
+    return ClickPath(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)
 
 
 #: Composes the given decorators, so that
@@ -209,7 +210,7 @@ def make_extra_context_settings() -> dict[str, Any]:
     """
     return ExtraContext.settings(
         formatter_settings=HelpExtraFormatter.settings(
-            theme=default_theme.with_(
+            theme=get_default_theme().with_(
                 invoked_command=Style(bold=True)
             )
         )

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/src/lockss/pybasic/fileutil.py

@@ -32,9 +32,12 @@
 File and path utilities.
 """
 
-from pathlib import Path, PurePath
+from pathlib import Path
 import sys
-from typing import List, Union
+from typing import List, TypeAlias, Union
+
+
+PathOrStr: TypeAlias = Union[Path, str]
 
 
 def file_lines(fpath: Path) -> List[str]:
@@ -56,7 +59,7 @@ def file_lines(fpath: Path) -> List[str]:
             f.close()
 
 
-def path(purepath_or_string: Union[PurePath, str]) -> Path:
+def path(path_or_string: PathOrStr) -> Path:
     """
     Returns the given ``PurePath`` (or if given a string, the ``Path`` created
     from that string), expanded with ``expanduser()`` and resolved with
@@ -68,6 +71,6 @@ def path(purepath_or_string: Union[PurePath, str]) -> Path:
     :return: An expanded and resolved ``Path``.
     :rtype: Path
     """
-    if not issubclass(type(purepath_or_string), PurePath):
-        purepath_or_string = Path(purepath_or_string)
-    return purepath_or_string.expanduser().resolve()
+    if not issubclass(type(path_or_string), Path):
+        path_or_string = Path(path_or_string)
+    return path_or_string.expanduser().resolve()

{lockss_pybasic-0.3.0.dev3 → lockss_pybasic-0.3.0.dev5}/src/lockss/pybasic/nodeutil.py

@@ -35,33 +35,35 @@ LOCKSS node utilities.
 from enum import Enum
 from re import Match, Pattern
 import re
-from typing import Annotated, ClassVar, Literal, Optional, Union
+from typing import Annotated, Any, ClassVar, Literal, Optional, Union
 
 from annotated_types import Ge, Le
-from pydantic import BaseModel, Field, TypeAdapter
-
-from .errorutil import InternalError
-
-
-RE_NODE_REFERENCE: Pattern[str] = re.compile(r'((?P<protocol>https?)://)?(?P<host>[^:]+)(:(?P<repository>\d+|(?=:))(:(?P<configuration>\d+|(?=:))(:(?P<poller>\d+|(?=:))(:(?P<crawler>\d+|(?=:))(:(?P<metadata>\d+|(?=:))(:(?P<soap>\d+))?)?)?)?)?)?')
+from pydantic import BaseModel, BeforeValidator, Field, TypeAdapter
 
 
+#: An annotated type for port numbers (0-65535)
 PortNumber = Annotated[int, Ge(0), Le(65535)]
 
 
 class NodeTypeEnum(Enum):
+    """An enumerated type representing LOCKSS node types."""
+    #: An enumerated constant representing LOCKSS 1.x nodes.
     V1 = 'v1'
+    #: An enumerated constant representing LOCKSS 2.x nodes.
     V2 = 'v2'
 
 
 class NodeProtocolEnum(Enum):
+    """An enumerated type representing protocols for reaching LOCKSS nodes."""
+    #: An enumerated constant representing HTTP.
     HTTP = 'http'
+    #: An enumerated constant representing HTTPS.
     HTTPS = 'https'
 
 
 class BaseNodeSpec(BaseModel):
 
-    DEFAULT_PROTOCOL: ClassVar[NodeProtocolEnum] = NodeProtocolEnum.HTTPS
+    DEFAULT_PROTOCOL: ClassVar[NodeProtocolEnum] = NodeProtocolEnum.HTTP
 
     TYPE_FIELD: ClassVar[dict[str, str]] = dict(title='Type',
                                                 description="The node's type")
@@ -126,21 +128,15 @@ class NodeSpec2(BaseNodeSpec):
                              description="The node's SOAP Compatibility Service REST API Port")
 
 
-NodeSpec = Annotated[Union[NodeSpec1, NodeSpec2], Field(discriminator='type')]
-
-
-_node_spec_adapter: TypeAdapter[NodeSpec] = TypeAdapter(NodeSpec)
-
-
-def get_node_spec_adapter() -> TypeAdapter[NodeSpec]:
-    return _node_spec_adapter
+_RE_NODE_REFERENCE: Pattern[str] = re.compile(r'((?P<protocol>https?)://)?(?P<host>[^:]+)(:(?P<repository>\d+|(?=:))(:(?P<configuration>\d+|(?=:))(:(?P<poller>\d+|(?=:))(:(?P<crawler>\d+|(?=:))(:(?P<metadata>\d+|(?=:))(:(?P<soap>\d+))?)?)?)?)?)?')
 
 
+#: A type for LOCKSS node specification strings.
 NodeSpecStr = str
 
 
-def make_node_spec(node_spec_string: NodeSpecStr) -> NodeSpec:
-    mat: Optional[Match[str]] = RE_NODE_REFERENCE.fullmatch(node_spec_string)
+def _parse_node_spec_string(node_spec_string: NodeSpecStr) -> dict[str, str]:
+    mat: Optional[Match[str]] = _RE_NODE_REFERENCE.fullmatch(node_spec_string)
     if mat is None:
         raise ValueError(f'Invalid node specification string: {node_spec_string}')
     d = dict(host=mat.group('host'))
@@ -164,4 +160,57 @@ def make_node_spec(node_spec_string: NodeSpecStr) -> NodeSpec:
     for k in five:
         if p := mat.group(k):
             d[k] = p # string okay, will be coerced to int
-    return get_node_spec_adapter().validate_python(d)
+    return d
+
+
+def _maybe_deserialize_node_spec_string(value: Any) -> Any:
+    if isinstance(value, NodeSpecStr) and not value.startswith('{'):
+        return _parse_node_spec_string(value)
+    return value
+
+
+#: A type for LOCKSS node specifications, that also accepts a compact LOCKSS
+#: node specification string.
+NodeSpec = Annotated[
+    Annotated[Union[NodeSpec1, NodeSpec2], Field(discriminator='type')],
+    BeforeValidator(_maybe_deserialize_node_spec_string)
+]
+
+
+#: A type adapter for the NodeSpec type.
+_node_spec_adapter: TypeAdapter[NodeSpec] = TypeAdapter(NodeSpec)
+
+
+def get_node_spec_adapter() -> TypeAdapter[NodeSpec]:
+    """
+    Gets a type adapter for the NodeSpec type, which is a union type and cannot
+    be instantiated directly.
+
+    :return: A type adapter for the NodeSpec type.
+    """
+    return _node_spec_adapter
+
+
+NodeSetKind = Literal['NodeSet']
+
+
+NodeSetIdentifier = str
+
+
+NodeIdentifier = str
+
+
+class NodeSet(BaseModel):
+
+    kind: NodeSetKind = Field(title='Kind',
+                              description="This object's kind")
+
+    id: NodeSetIdentifier = Field(title='Node Set Identifier',
+                                  description='An identifier for the node set')
+
+    name: str = Field(title='Node Set Name',
+                      description='A name for the node set')
+
+    nodes: dict[NodeIdentifier, NodeSpec] = Field(min_length=1,
+                                                  title='Nodes',
+                                                  description='A non-empty list of nodes')