msw-plugin-api 0.2.4__tar.gz → 0.3.0__tar.gz

{msw_plugin_api-0.2.4 → msw_plugin_api-0.3.0}/.gitignore

@@ -10,5 +10,8 @@ build/
 .mypy_cache/
 .ruff_cache/
 
+# library: do not commit the lockfile
+uv.lock
+
 # hatch-vcs generated version file
 src/msw_plugin_api/_version.py

{msw_plugin_api-0.2.4 → msw_plugin_api-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: msw-plugin-api
-Version: 0.2.4
+Version: 0.3.0
 Summary: Minimal structural interfaces for MSW plugin packages
 Project-URL: Homepage, https://github.com/MurineShiftWork/msw-plugin-api
 Project-URL: Issue Tracker, https://github.com/MurineShiftWork/msw-plugin-api/issues

msw_plugin_api-0.3.0/VERSION

@@ -0,0 +1 @@
+0.3.0

{msw_plugin_api-0.2.4 → msw_plugin_api-0.3.0}/pyproject.toml

@@ -52,7 +52,7 @@ dev = [
 [tool.commitizen]
 name = "cz_conventional_commits"
 version_provider = "commitizen"
-version = "0.2.4"
+version = "0.3.0"
 version_files = ["VERSION"]
 tag_format = "v$version"
 update_changelog_on_bump = false

{msw_plugin_api-0.2.4 → msw_plugin_api-0.3.0}/src/msw_plugin_api/__init__.py

@@ -95,3 +95,42 @@ class HostSessionProtocol(Protocol):
     def stop(self) -> None:
         """Stop the recording session on the backend."""
         ...
+
+
+@runtime_checkable
+class MetadataProtocol(Protocol):
+    """Structural protocol for an MSW metadata section.
+
+    A metadata addon owns exactly one top-level subtree of the manifest
+    ``metadata`` key-tree (e.g. ``metadata.probes``, ``metadata.opto``). It
+    keeps its schema in its own package and advertises itself with an entry
+    point::
+
+        [project.entry-points."msw.metadata"]
+        probes = "my_package.metadata:ProbesMetadata"
+
+    MSW core discovers these via ``importlib.metadata`` and checks
+    ``isinstance(obj, MetadataProtocol)``, so any object exposing ``subtree``,
+    ``schema_version``, and ``validate`` satisfies it (no import of this
+    package required). ``validate`` must be non-fatal: it returns a list of
+    human-readable warnings and never raises, because ``metadata`` is optional
+    and legacy/partial trees must still load.
+
+    Attributes:
+        subtree: The reserved top-level metadata key this addon owns.
+        schema_version: The version of this subtree's schema.
+    """
+
+    subtree: str
+    schema_version: int
+
+    def validate(self, block: object) -> list[str]:
+        """Validate this addon's metadata subtree.
+
+        Args:
+            block: The value at ``metadata[self.subtree]``.
+
+        Returns:
+            A list of human-readable warnings (empty when valid). Never raises.
+        """
+        ...

{msw_plugin_api-0.2.4 → msw_plugin_api-0.3.0}/src/msw_plugin_api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.4'
-__version_tuple__ = version_tuple = (0, 2, 4)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
 
 __commit_id__ = commit_id = None

msw_plugin_api-0.2.4/VERSION

@@ -1 +0,0 @@
-0.2.4