Refactoring

Author: pcisar

python/docs/reference.txt

@@ -1,49 +1,17 @@
+.. currentmodule:: firebird.uuid
 
 #######################
 Firebird-uuid Reference
 #######################
 
-firebird.uuid namespace
-=======================
-
-You can import next components directly from `firebird.uuid` module:
-
-- from `.model`: `.NodeType`, `.Node`, `.IANA_ROOT_NAME`
-- from `.spec`: `.get_specification`, `.get_specifications`, `.parse_specifications`, `.ROOT_SPEC`
-- from `~.firebird.uuid.registry`: `~firebird.uuid.registry.registry`, `.OIDRegistry`
-
-Sub-modules
-===========
-
-.. module:: firebird.uuid.spec
-   :synopsis:
-
 .. autodata:: ROOT_SPEC
-
-.. autoclass:: LocalFileAdapter
+.. autodata:: IANA_ROOT_NAME
+.. autodata:: registry
 
 .. autofunction:: get_specification
 .. autofunction:: get_specifications
 .. autofunction:: parse_specifications
-.. autofunction:: validate_dict
-.. autofunction:: validate_spec
-.. autofunction:: pythonize
-.. autofunction:: pythonize_spec
-
-.. module:: firebird.uuid.model
-   :synopsis:
-
-.. autodata:: IANA_ROOT_NAME
 
 .. autoclass:: NodeType
 .. autoclass:: Node
-
-.. autofunction:: build_tree
-.. autofunction:: validate_parent_child_equality
-
-.. module:: firebird.uuid.registry
-   :synopsis:
-
-.. autodata:: firebird.uuid.registry.registry
-
-.. autoclass:: firebird.uuid.registry.OIDRegistry
+.. autoclass:: OIDRegistry

python/docs/requirements.txt

@@ -1,3 +1,4 @@
 sphinx-bootstrap-theme>=0.8.1
 sphinx-autodoc-typehints>=1.19.4
-./python
+sphinx>=5.3
+.

python/src/firebird/uuid/__init__.py

@@ -35,6 +35,6 @@
 
 """
 
-from .model import NodeType, Node, IANA_ROOT_NAME
-from .spec import get_specification, get_specifications, parse_specifications, ROOT_SPEC
-from .registry import registry, OIDRegistry
+from ._model import NodeType, Node, IANA_ROOT_NAME
+from ._spec import get_specification, get_specifications, parse_specifications, ROOT_SPEC
+from ._registry import registry, OIDRegistry

python/src/firebird/uuid/model.py python/src/firebird/uuid/_model.pypython/src/firebird/uuid/model.py renamed to python/src/firebird/uuid/_model.py

@@ -1,7 +1,7 @@
 #coding:utf-8
 #
 # PROGRAM/MODULE: firebird-uuid
-# FILE:           firebird/uuid/model.py
+# FILE:           firebird/uuid/_model.py
 # DESCRIPTION:    Model for Firebird OID registry
 # CREATED:        11.11.2022
 #
@@ -55,6 +55,20 @@ class NodeType(Enum):
 
 class Node(Distinct):
     """OID node.
+
+    Arguments:
+        parent: Parent node (`None` for root node)
+        oid: Node OID. When `None`, OID is constructed from parent OID and `number` parameter.
+        number: Node order number in parent. Part of node OID for child nodes.
+        name: Node name.
+        description: Node description.
+        contact: Contact person for this node.
+        email: E-mail of contact person.
+        site: URL to home site of node maintainer
+        parent_spec: URL to YAML specification of parent node. If not specified, it's
+          taken from `parent` node.
+        node_spec: URL to node TAML specification
+        node_type: Node type. If not specified, it's derived from `node_spec`.
     """
     def __init__(self, *, parent: Node=None, oid: str=None, number: int=None, name: str=None,
                  description: str=None, contact: str=None, email: str=None, site: str=None,

python/src/firebird/uuid/registry.py python/src/firebird/uuid/_registry.pypython/src/firebird/uuid/registry.py renamed to python/src/firebird/uuid/_registry.py

@@ -42,7 +42,7 @@
 from toml import dumps, loads
 from firebird.base.types import Error, STOP
 from firebird.base.collections import Registry
-from firebird.uuid.model import NodeType, Node, build_tree
+from ._model import NodeType, Node, build_tree
 
 class OIDRegistry(Registry):
     """Firebird OID registry.

python/src/firebird/uuid/spec.py python/src/firebird/uuid/_spec.pypython/src/firebird/uuid/spec.py renamed to python/src/firebird/uuid/_spec.py

@@ -64,13 +64,12 @@
 
 from __future__ import annotations
 from typing import Tuple
+import os
 import re
+from urllib.request import url2pathname
 import requests
 import yaml
 
-from urllib.request import url2pathname
-import os
-
 
 class LocalFileAdapter(requests.adapters.BaseAdapter):
     """Protocol Adapter to allow Requests to GET file:// URLs