roborean-plugins-base 0.1.2__py3-none-any.whl

roborean_plugins_base/__init__.py

@@ -0,0 +1,12 @@
+"""Plugin manifests and installed-package discovery."""
+
+from .entry_points import load_bit_type_entry_points
+from .manifest import PluginManifest, TrustTier
+
+__version__ = "0.2.0"
+
+__all__ = [
+    "PluginManifest",
+    "TrustTier",
+    "load_bit_type_entry_points",
+]

roborean_plugins_base/entry_points.py

@@ -0,0 +1,68 @@
+"""Discover bit types advertised through package entry points."""
+
+import logging
+import os
+from importlib.metadata import entry_points
+from typing import Any
+
+from .manifest import PluginManifest, TrustTier
+
+logger = logging.getLogger(__name__)
+
+BIT_TYPES_GROUP = "roborean.bit_types"
+
+
+def load_bit_type_entry_points(
+    *,
+    allow_third_party: bool | None = None,
+) -> list[tuple[PluginManifest, Any]]:
+    """Load bit-type factories from installed entry points.
+
+    Each entry point should resolve to a zero-arg callable that returns
+    ``(BitTypeManifest, BitHandler)`` or an object with ``manifest`` and
+    ``handler`` attributes.
+    """
+    if allow_third_party is None:
+        allow_third_party = os.environ.get(
+            "ROBOREAN_ALLOW_THIRD_PARTY_PLUGINS", ""
+        ) in {"1", "true", "TRUE"}
+
+    selected = entry_points()
+    group = selected.select(group=BIT_TYPES_GROUP)
+    loaded: list[tuple[PluginManifest, Any]] = []
+
+    # Load each advertised factory, skipping disallowed trust tiers.
+    for item in group:
+        try:
+            factory = item.load()
+            payload = factory() if callable(factory) else factory
+            if hasattr(payload, "manifest") and hasattr(payload, "handler"):
+                bit_manifest = payload.manifest
+                handler = payload.handler
+            else:
+                bit_manifest, handler = payload
+            trust = TrustTier.CORE
+            if hasattr(payload, "trust_tier"):
+                trust = TrustTier(payload.trust_tier)
+            if trust == TrustTier.THIRD_PARTY and not allow_third_party:
+                logger.debug(
+                    "Skipping third-party bit type %s",
+                    item.name,
+                )
+                continue
+            plugin = PluginManifest(
+                id=bit_manifest.type_id,
+                version=bit_manifest.version,
+                kind="bit-type",
+                capabilities=frozenset(bit_manifest.capabilities),
+                trust_tier=trust,
+                effect_class=bit_manifest.effect_class,
+            )
+            loaded.append((plugin, (bit_manifest, handler)))
+        except Exception:
+            logger.debug(
+                "Failed loading bit type entry point %s",
+                item.name,
+                exc_info=True,
+            )
+    return loaded

roborean_plugins_base/manifest.py

@@ -0,0 +1,28 @@
+"""Installed plugin manifest types."""
+
+from dataclasses import dataclass
+from enum import Enum
+from typing import Literal
+
+from roborean_spec import EffectClass
+
+
+class TrustTier(str, Enum):
+    """Trust classification for installed plugins."""
+
+    CORE = "core"
+    INTERNAL = "internal"
+    THIRD_PARTY = "third_party"
+    DEV = "dev"
+
+
+@dataclass(frozen=True)
+class PluginManifest:
+    """Describes one installed plugin package contribution."""
+
+    id: str
+    version: str
+    kind: Literal["bit-type", "document-driver"]
+    capabilities: frozenset[str]
+    trust_tier: TrustTier
+    effect_class: EffectClass | None = None

roborean_plugins_base-0.1.2.dist-info/METADATA

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: roborean-plugins-base
+Version: 0.1.2
+Summary: Plugin manifests and entry-point discovery for Roborean
+Project-URL: Homepage, https://github.com/TNick/roborean
+Project-URL: Repository, https://github.com/TNick/roborean
+License-Expression: MIT
+Requires-Python: >=3.11
+Requires-Dist: roborean-spec>=0.1.1
+Provides-Extra: dev
+Requires-Dist: black>=24.0; extra == 'dev'
+Requires-Dist: flake8>=7.0; extra == 'dev'
+Requires-Dist: isort>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# roborean-plugins-base
+
+Plugin manifests and `importlib.metadata` entry-point discovery for installed
+bit types (`roborean.bit_types`).
+
+Third-party entry points are ignored unless
+`ROBOREAN_ALLOW_THIRD_PARTY_PLUGINS=1`.

roborean_plugins_base-0.1.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+roborean_plugins_base/__init__.py,sha256=G4nAW6daMbbADRdjh57uVy7PJXr_HhOYU-y5paS4WEI,269
+roborean_plugins_base/entry_points.py,sha256=tYnUmdL_lejYpBuk8LM3e3fkGfOpHJ6IVwsHtfq0V6M,2346
+roborean_plugins_base/manifest.py,sha256=Qq1xFcKtd1CIYit67STQmFnFVYpnsaYtsWzx8ULXDbU,632
+roborean_plugins_base-0.1.2.dist-info/METADATA,sha256=n7sBUj9et2uNA-h5ENo-jn8mFpPfEmo7BUm6rMbg9y4,784
+roborean_plugins_base-0.1.2.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+roborean_plugins_base-0.1.2.dist-info/RECORD,,

roborean_plugins_base-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any