python-library-registry 0.1.3__tar.gz

python_library_registry-0.1.3/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+.pytest_cache/
+config.yaml
+logs/

python_library_registry-0.1.3/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: python-library-registry
+Version: 0.1.3
+Requires-Python: >=3.10
+Requires-Dist: python-library-tree-model

python_library_registry-0.1.3/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-library-registry"
+version = "0.1.3"
+requires-python = ">=3.10"
+dependencies = [
+    "python-library-tree-model",
+]
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["registry"]

python_library_registry-0.1.3/registry/__init__.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+from difflib import get_close_matches
+from typing import Any
+
+from pydantic import Field
+from tree_model import TreeModel
+
+
+class EntryNode(TreeModel):
+    obj: Any | None = Field(default=None, description="注册对象")
+
+
+class Registry:
+    def __init__(
+        self,
+        namespace: str = "",
+        *,
+        _root: EntryNode | None = None,
+    ) -> None:
+        """
+        Args:
+            namespace: 命名空间
+        Attributes:
+            _namespace: 命名空间
+            _root: 根节点
+        """
+        self._namespace = namespace.strip(".")
+        self._root = EntryNode(name="") if _root is None else _root
+
+    def _full_name(self, name: str) -> str:
+        if not self._namespace:
+            return name
+        return f"{self._namespace}.{name}"
+
+    def _get_or_create_node(self, full_name: str) -> EntryNode:
+        node = self._root
+        for part in filter(None, full_name.split(".")):
+            child = node.find_child(lambda item: item.name == part)
+            if child is None:
+                child = EntryNode(name=part)
+                node.add_child(child)
+            node = child
+        return node
+
+    def _find_node(self, full_name: str) -> EntryNode | None:
+        node: EntryNode = self._root
+        for part in filter(None, full_name.split(".")):
+            found = node.find_child(lambda item: item.name == part)
+            if found is None:
+                return None
+            node = found
+        return node
+
+    def get_registered_names(self) -> list[str]:
+        """获取已注册的名称列表"""
+        names: list[str] = []
+
+        def walk(node: EntryNode) -> None:
+            if node.obj is not None and node.full_name:
+                names.append(node.full_name)
+            for child in node:
+                walk(child)
+
+        for child in self._root:
+            walk(child)
+
+        return names
+
+    def _suggest_name(self, full_name: str) -> str | None:
+        matches = get_close_matches(
+            full_name,
+            self.get_registered_names(),
+            n=1,
+            cutoff=0.6,
+        )
+        return matches[0] if matches else None
+
+    def register(self, name: str, obj: Any) -> Any:
+        """注册对象"""
+        full_name = self._full_name(name)
+
+        node = self._get_or_create_node(full_name)
+        if node.obj is not None:
+            raise ValueError(f"重复注册 {full_name!r}")
+        node.obj = obj
+        return obj
+
+    def __call__(self, name: str, obj: Any | None = None) -> Any:
+        if obj is not None:
+            return self.register(name=name, obj=obj)
+        def decorator(target: Any) -> Any:
+            return self.register(name=name, obj=target)
+        return decorator
+
+    def namespace(self, full_name: str) -> "Registry":
+        """命名空间"""
+        full_name = full_name.strip(".")
+        if not full_name:
+            return self
+        namespace = f"{self._namespace}.{full_name}" if self._namespace else full_name
+        return Registry(namespace=namespace, _root=self._root)
+
+    def get(self, name: str) -> Any:
+        """获取注册对象"""
+        full_name = self._full_name(name)
+        node = self._find_node(full_name)
+        if node is None or node.obj is None:
+            suggested_name = self._suggest_name(full_name)
+            message = f"未找到 {full_name!r}"
+            if suggested_name is not None:
+                message += f"，是否想找 {suggested_name!r}"
+            raise ValueError(message)
+        return node.obj

python_library_registry-0.1.3/test.bat

@@ -0,0 +1,10 @@
+@echo off
+cd /d %~dp0
+
+if not exist .venv (
+    python -m venv .venv
+)
+
+call .venv\Scripts\activate.bat
+python -m pip install -e .
+python -m unittest discover -s tests -p "test_*.py"

python_library_registry-0.1.3/tests/test_registry.py

@@ -0,0 +1,40 @@
+import unittest
+
+from registry import Registry
+
+
+class RegistryTests(unittest.TestCase):
+    def test_decorator_registration(self) -> None:
+        registry = Registry()
+        event = registry.namespace("event")
+        condition = registry.namespace("condition")
+
+        @event("startup")
+        class StartupEvent:
+            pass
+
+        @condition("is_admin")
+        class IsAdmin:
+            pass
+
+        @registry("send_mail")
+        class SendMail:
+            pass
+
+        self.assertIs(registry.get("event.startup"), StartupEvent)
+        self.assertIs(registry.get("condition.is_admin"), IsAdmin)
+        self.assertIs(registry.get("send_mail"), SendMail)
+
+    def test_namespaced_registry_get_local_name(self) -> None:
+        registry = Registry()
+        event = registry.namespace("event")
+        @event("startup")
+        class StartupEvent:
+            pass
+        
+        self.assertIs(event.get("startup"), StartupEvent)
+        self.assertIs(registry.get("event.startup"), StartupEvent)
+
+
+if __name__ == "__main__":
+    unittest.main()