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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lockss-pybasic
-Version: 0.3.0.dev5
+Version: 0.3.0.dev7
 Summary: Basic Python utilities
 License: BSD-3-Clause
 License-File: LICENSE
@@ -26,7 +26,7 @@ Description-Content-Type: text/x-rst
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.3.0-dev5
+.. |RELEASE| replace:: 0.3.0-dev7
 .. |RELEASE_DATE| replace:: NOT YET RELEASED
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)
@@ -68,3 +68,9 @@ Release Notes
 
 See `<CHANGELOG.rst>`_.
 
+----------
+Unit Tests
+----------
+
+Run ``python -m unittest discover tests`` at the root of the project tree (where there is a directory called ``tests``).
+

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

@@ -2,7 +2,7 @@
 lockss-pybasic
 ==============
 
-.. |RELEASE| replace:: 0.3.0-dev5
+.. |RELEASE| replace:: 0.3.0-dev7
 .. |RELEASE_DATE| replace:: NOT YET RELEASED
 
 **Latest release:** |RELEASE| (|RELEASE_DATE|)
@@ -43,3 +43,9 @@ Release Notes
 -------------
 
 See `<CHANGELOG.rst>`_.
+
+----------
+Unit Tests
+----------
+
+Run ``python -m unittest discover tests`` at the root of the project tree (where there is a directory called ``tests``).

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

@@ -28,7 +28,7 @@
 
 [project]
 name = "lockss-pybasic"
-version = "0.3.0-dev5" # Always change in __init__.py, and at release time in README.rst and CHANGELOG.rst
+version = "0.3.0-dev7" # 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"

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

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

@@ -35,14 +35,14 @@ LOCKSS node utilities.
 from enum import Enum
 from re import Match, Pattern
 import re
-from typing import Annotated, Any, ClassVar, Literal, Optional, Union
+from typing import Annotated, Any, ClassVar, Literal, Optional, TypeAlias, Union
 
 from annotated_types import Ge, Le
 from pydantic import BaseModel, BeforeValidator, Field, TypeAdapter
 
 
 #: An annotated type for port numbers (0-65535)
-PortNumber = Annotated[int, Ge(0), Le(65535)]
+PortNumber: TypeAlias = Annotated[int, Ge(0), Le(65535)]
 
 
 class NodeTypeEnum(Enum):
@@ -61,6 +61,12 @@ class NodeProtocolEnum(Enum):
     HTTPS = 'https'
 
 
+NodeSpecKind: TypeAlias = Literal['NodeSpec']
+
+
+NodeIdentifier: TypeAlias = str
+
+
 class BaseNodeSpec(BaseModel):
 
     DEFAULT_PROTOCOL: ClassVar[NodeProtocolEnum] = NodeProtocolEnum.HTTP
@@ -68,6 +74,13 @@ class BaseNodeSpec(BaseModel):
     TYPE_FIELD: ClassVar[dict[str, str]] = dict(title='Type',
                                                 description="The node's type")
 
+    kind: NodeSpecKind = Field(title='Kind',
+                               description="This object's kind")
+
+    id: NodeIdentifier = Field(default='',
+                               title='Node Identifier',
+                               description='An identifier for the node')
+
     protocol: NodeProtocolEnum = Field(default=DEFAULT_PROTOCOL,
                                        title='Protocol',
                                        description="The protocol for reaching the node")
@@ -86,6 +99,9 @@ class NodeSpec1(BaseNodeSpec):
                            title='UI Port',
                            description="The LOCKSS 1.x node's Web user interface port")
 
+    def __str__(self) -> str:
+        return f'{self.protocol.value}://{self.host}:{self.ui}'
+
 
 class NodeSpec2(BaseNodeSpec):
 
@@ -127,19 +143,22 @@ class NodeSpec2(BaseNodeSpec):
                              title='SOAP Port',
                              description="The node's SOAP Compatibility Service REST API Port")
 
+    def __str__(self) -> str:
+        return f'{self.protocol.value}://{self.host}:{self.repository}:{self.configuration}:{self.poller}:{self.crawler}:{self.metadata}:{self.soap}'
+
 
-_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+))?)?)?)?)?)?')
+_RE_COMPACT_NODE_SPEC: 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
+CompactNodeSpec: TypeAlias = str
 
 
-def _parse_node_spec_string(node_spec_string: NodeSpecStr) -> dict[str, str]:
-    mat: Optional[Match[str]] = _RE_NODE_REFERENCE.fullmatch(node_spec_string)
+def _parse_compact_node_spec(compact_node_spec: CompactNodeSpec) -> dict[str, str]:
+    mat: Optional[Match[str]] = _RE_COMPACT_NODE_SPEC.fullmatch(compact_node_spec)
     if mat is None:
-        raise ValueError(f'Invalid node specification string: {node_spec_string}')
-    d = dict(host=mat.group('host'))
+        raise ValueError(f'Invalid compact node specification: {compact_node_spec}')
+    d = dict(kind='NodeSpec', host=mat.group('host'))
     if prot := mat.group('protocol'):
         d['protocol'] = prot
     five = ('configuration', 'poller', 'crawler', 'metadata', 'soap')
@@ -147,33 +166,33 @@ def _parse_node_spec_string(node_spec_string: NodeSpecStr) -> dict[str, str]:
         if any(mat.group(x) for x in five) or len(repo_or_ui) >= 5:
             # 10000 or larger: assume V2
             d['type'] = NodeTypeEnum.V2.value
-            d['repository'] = repo_or_ui
+            d['repository'] = repo_or_ui # all these strings will be coerced to int
         elif len(repo_or_ui) == 4:
             # 1000 through 9999: assume V1
             d['type'] = NodeTypeEnum.V1.value
             d['ui'] = repo_or_ui
         else:
-            raise ValueError(f'Invalid repository/UI port in node specification string: {repo_or_ui}')
+            raise ValueError(f'Invalid repository/UI port in compact node specification: {repo_or_ui}')
     else:
         # Assume V2
         d['type'] = NodeTypeEnum.V2.value
     for k in five:
         if p := mat.group(k):
-            d[k] = p # string okay, will be coerced to int
+            d[k] = p
     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)
+def _maybe_deserialize_compact_node_spec(value: Any) -> Any:
+    if isinstance(value, CompactNodeSpec) and not value.startswith('{'):
+        return _parse_compact_node_spec(value)
     return value
 
 
 #: A type for LOCKSS node specifications, that also accepts a compact LOCKSS
-#: node specification string.
-NodeSpec = Annotated[
+#: node specification.
+NodeSpec: TypeAlias = Annotated[
     Annotated[Union[NodeSpec1, NodeSpec2], Field(discriminator='type')],
-    BeforeValidator(_maybe_deserialize_node_spec_string)
+    BeforeValidator(_maybe_deserialize_compact_node_spec)
 ]
 
 
@@ -191,13 +210,10 @@ def get_node_spec_adapter() -> TypeAdapter[NodeSpec]:
     return _node_spec_adapter
 
 
-NodeSetKind = Literal['NodeSet']
-
-
-NodeSetIdentifier = str
+NodeSetKind: TypeAlias = Literal['NodeSet']
 
 
-NodeIdentifier = str
+NodeSetIdentifier: TypeAlias = str
 
 
 class NodeSet(BaseModel):
@@ -211,6 +227,6 @@ class NodeSet(BaseModel):
     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')
+    nodes: list[NodeSpec] = Field(min_length=1,
+                                  title='Nodes',
+                                  description='A non-empty list of nodes')