unitysvc-data 0.1.2__tar.gz → 0.1.4__tar.gz

{unitysvc_data-0.1.2/src/unitysvc_data.egg-info → unitysvc_data-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-data
-Version: 0.1.2
+Version: 0.1.4
 Summary: Standard examples and presets for UnitySVC data packages
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "unitysvc-data"
-version = "0.1.2"
+version = "0.1.4"
 description = "Standard examples and presets for UnitySVC data packages"
 readme = "README.md"
 authors = [{ name = "Bo Peng", email = "bo.peng@unitysvc.com" }]

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data/__init__.py

@@ -90,6 +90,11 @@ def list_examples() -> list[str]:
 
 # Imported last so presets.py can compute its own _EXAMPLES_ROOT without
 # reaching back into this module while __init__ is still loading.
+# The ``from .presets import ...`` line also runs the ``@preset``
+# decorators that populate :data:`PRESET_FNS` — so downstream consumers
+# (notably ``unitysvc_core.load_data_file``) can enumerate every
+# decorated preset without knowing their names ahead of time.
+from ._registry import PRESET_FNS, preset  # noqa: E402  (placement is deliberate)
 from .presets import (  # noqa: E402  (placement is deliberate)
     ALIASES,
     MANIFEST,
@@ -112,6 +117,10 @@ __all__ = [
     "MANIFEST",
     "OVERRIDABLE",
     "register_jinja_globals",
+    # Decorator-driven registry — downstream tools enumerate these to
+    # discover every preset type without hard-coding function names.
+    "preset",
+    "PRESET_FNS",
     # Low-level path-based API.
     "example_path",
     "read_example",

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data/_manifest.json

@@ -40,7 +40,12 @@
       "example_file": "s3/code-example/code-example-v1.py.j2",
       "is_active": true,
       "is_public": true,
-      "meta": {},
+      "meta": {
+        "output_contains": "connectivity ok",
+        "requirements": [
+          "boto3"
+        ]
+      },
       "mime_type": "python",
       "preset_name": "s3_code_example",
       "source_readme": "s3/code-example/README.md",
@@ -53,7 +58,10 @@
       "is_active": true,
       "is_public": false,
       "meta": {
-        "output_contains": "connectivity ok"
+        "output_contains": "connectivity ok",
+        "requirements": [
+          "boto3"
+        ]
       },
       "mime_type": "python",
       "preset_name": "s3_connectivity",

unitysvc_data-0.1.4/src/unitysvc_data/_registry.py

@@ -0,0 +1,67 @@
+"""Decorator-driven registry for preset sentinel callables.
+
+Any function decorated with :func:`preset` is registered under its
+``__name__`` in :data:`PRESET_FNS`, where downstream consumers
+(notably ``unitysvc-core``'s ``load_data_file``) discover them. Adding
+a new preset type — for example a ``schema_preset`` or
+``policy_preset`` — is then purely a matter of decorating the
+function and releasing a new ``unitysvc-data``; every consumer picks
+it up automatically on the next install.
+
+The decorator wraps each function with the **sentinel calling
+convention**: the value in a ``{"$<name>": value}`` sentinel is
+passed to the wrapped function, with the seller-facing flat form
+
+    {"name": "<preset>", "<override>": ...}
+
+transparently unpacked into ``fn(name, **overrides)``. Any other
+shape (bare string, the internal ``{"$preset": ..., "$with": {...}}``
+form that ``doc_preset`` understands, etc.) is forwarded verbatim.
+
+The original (undecorated) function is returned unchanged so callers
+can keep using it programmatically:
+
+    >>> from unitysvc_data import doc_preset
+    >>> doc_preset("s3_connectivity", is_public=False)
+    {...}
+
+The registry lookup uses the wrapped, sentinel-aware version.
+"""
+
+from __future__ import annotations
+
+import functools
+from collections.abc import Callable
+from typing import Any
+
+#: Registered preset callables keyed by sentinel name (without the
+#: leading ``$``). Populated by :func:`preset` at import time.
+PRESET_FNS: dict[str, Callable[[Any], Any]] = {}
+
+
+def preset(fn: Callable[..., Any]) -> Callable[..., Any]:
+    """Register *fn* in :data:`PRESET_FNS` under its ``__name__``.
+
+    The registered entry is a thin wrapper that unpacks the
+    seller-facing flat sentinel form before delegating::
+
+        {"name": "<preset>", "<override>": ...}   ->   fn("<preset>", **overrides)
+
+    Any other value (bare string, dict without a string ``name`` key,
+    etc.) is forwarded to ``fn`` unchanged — the underlying function
+    is responsible for validating its own input.
+
+    Returns the undecorated function so programmatic callers keep the
+    original signature.
+    """
+
+    @functools.wraps(fn)
+    def _sentinel_entrypoint(source: Any) -> Any:
+        if isinstance(source, dict) and isinstance(source.get("name"), str):
+            name = source["name"]
+            overrides = {k: v for k, v in source.items() if k != "name"}
+            return fn(name, **overrides)
+        return fn(source)
+
+    PRESET_FNS[fn.__name__] = _sentinel_entrypoint
+    return fn

unitysvc_data-0.1.4/src/unitysvc_data/_version.py

@@ -0,0 +1,17 @@
+"""Single source of truth for the package version.
+
+The canonical version lives in ``pyproject.toml``'s ``[project]`` table
+— that's what PyPI, ``pip install``, and ``pip show`` read. This
+module asks ``importlib.metadata`` for the installed distribution's
+version so downstream code can ``from unitysvc_data import __version__``
+without the two values ever drifting apart.
+"""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("unitysvc-data")
+except PackageNotFoundError:  # pragma: no cover
+    # Running from a checkout that hasn't been ``pip install``-ed.
+    __version__ = "0.0.0+unknown"
+

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data/examples/s3/code-example/README.md

@@ -6,6 +6,7 @@ file = "code-example.py.j2"
 description = "Python example: list objects in an S3 bucket via boto3"
 is_active = true
 is_public = true
+meta = { output_contains = "connectivity ok", requirements = ["boto3"] }
 +++
 
 # s3 / code-example — list objects via boto3

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data/examples/s3/connectivity/README.md

@@ -6,7 +6,7 @@ file = "connectivity.py.j2"
 description = "Verify S3 endpoint accepts the configured credentials"
 is_active = true
 is_public = false
-meta = { output_contains = "connectivity ok" }
+meta = { output_contains = "connectivity ok", requirements = ["boto3"] }
 +++
 
 # s3 / connectivity — S3 credential smoke test

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data/presets.py

@@ -36,6 +36,8 @@ from importlib.resources import files as _files
 from pathlib import Path
 from typing import Any
 
+from ._registry import preset
+
 # Resolved once at import time. Duplicated with __init__ rather than
 # imported to avoid a circular import during package load. Use
 # ``__package__`` (the parent package, "unitysvc_data") rather than
@@ -177,6 +179,7 @@ def _lookup(name: str, pool: dict[str, Any], what: str) -> Any:
 # --- Public API ------------------------------------------------------------
 
 
+@preset
 def doc_preset(source: Any, **overrides: Any) -> dict[str, Any]:
     """Return a fully-populated document record for the named preset.
 
@@ -205,6 +208,7 @@ def doc_preset(source: Any, **overrides: Any) -> dict[str, Any]:
     return factory(**(sentinel_overrides or overrides))
 
 
+@preset
 def file_preset(source: Any) -> str:
     """Return the raw UTF-8 content of the preset's bundled file.
 

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4/src/unitysvc_data.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unitysvc-data
-Version: 0.1.2
+Version: 0.1.4
 Summary: Standard examples and presets for UnitySVC data packages
 Author-email: Bo Peng <bo.peng@unitysvc.com>
 Maintainer-email: Bo Peng <bo.peng@unitysvc.com>

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/src/unitysvc_data.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 pyproject.toml
 src/unitysvc_data/__init__.py
 src/unitysvc_data/_manifest.json
+src/unitysvc_data/_registry.py
 src/unitysvc_data/_version.py
 src/unitysvc_data/cli.py
 src/unitysvc_data/presets.py

{unitysvc_data-0.1.2 → unitysvc_data-0.1.4}/tests/test_presets.py

@@ -116,7 +116,7 @@ def test_doc_preset_sentinel_versioned():
     record = doc_preset({"$preset": "s3_connectivity_v1"})
     assert record["category"] == "connectivity_test"
     assert record["mime_type"] == "python"
-    assert record["meta"] == {"output_contains": "connectivity ok"}
+    assert record["meta"] == {"output_contains": "connectivity ok", "requirements": ["boto3"]}
     assert Path(record["file_path"]).is_file()
 
 
@@ -308,3 +308,83 @@ def test_manifest_is_up_to_date():
         f"stdout:\n{result.stdout}\n"
         f"stderr:\n{result.stderr}"
     )
+
+
+# ---------------------------------------------------------------------------
+# @preset decorator + PRESET_FNS registry
+# ---------------------------------------------------------------------------
+
+
+def test_preset_fns_registry_contains_doc_and_file():
+    from unitysvc_data import PRESET_FNS
+
+    assert "doc_preset" in PRESET_FNS
+    assert "file_preset" in PRESET_FNS
+    # Each registered entry is callable.
+    assert callable(PRESET_FNS["doc_preset"])
+    assert callable(PRESET_FNS["file_preset"])
+
+
+def test_preset_decorator_unpacks_flat_form():
+    """The wrapper auto-unpacks {"name": "<x>", ...} into fn("<x>", **rest)."""
+    from unitysvc_data import PRESET_FNS
+
+    # Flat form via the registered wrapper should equal direct call.
+    via_registry = PRESET_FNS["doc_preset"](
+        {"name": "s3_connectivity_v1", "is_public": True}
+    )
+    via_direct = doc_preset("s3_connectivity_v1", is_public=True)
+    assert via_registry == via_direct
+
+
+def test_preset_decorator_forwards_bare_string():
+    from unitysvc_data import PRESET_FNS
+
+    via_registry = PRESET_FNS["doc_preset"]("s3_connectivity_v1")
+    via_direct = doc_preset("s3_connectivity_v1")
+    assert via_registry == via_direct
+
+
+def test_preset_decorator_preserves_original_function_signature():
+    """@preset returns the undecorated function so programmatic callers
+    keep the original signature (`**overrides`, etc.)."""
+    import inspect
+
+    sig = inspect.signature(doc_preset)
+    # If @preset had replaced doc_preset with the single-arg wrapper,
+    # we would see just `source` here.
+    assert "overrides" in sig.parameters or any(
+        p.kind is inspect.Parameter.VAR_KEYWORD for p in sig.parameters.values()
+    )
+
+
+def test_preset_decorator_does_not_duplicate_across_reimports():
+    """Re-importing the module must not double-register any preset."""
+    import importlib
+
+    import unitysvc_data._registry as reg
+
+    before = dict(reg.PRESET_FNS)
+    importlib.reload(reg)
+    # After reload, each preset appears at most once in the new registry.
+    # (We can't easily re-decorate here without re-running presets.py, but
+    # we can at least confirm the registry isn't "leaking" entries.)
+    assert set(reg.PRESET_FNS) <= set(before) | {"doc_preset", "file_preset"}
+
+
+def test_preset_decorator_register_custom_function():
+    """Third-party code can register a new sentinel type with @preset."""
+    from unitysvc_data._registry import PRESET_FNS, preset
+
+    try:
+        @preset
+        def _custom_preset(source, **kwargs):
+            return {"source": source, "kwargs": kwargs}
+
+        assert "_custom_preset" in PRESET_FNS
+        assert PRESET_FNS["_custom_preset"]({"name": "x", "flag": True}) == {
+            "source": "x",
+            "kwargs": {"flag": True},
+        }
+    finally:
+        PRESET_FNS.pop("_custom_preset", None)

unitysvc_data-0.1.2/src/unitysvc_data/_version.py

@@ -1 +0,0 @@
-__version__ = "0.1.2"