{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "cf2246a7ad439fa38d57462118e7840e5497a685",
    "tool": "pyref",
    "version": "1.7.3"
  },
  "language": "python",
  "modules": [
    {
      "description": "# Registry API\n\nGeneric thread-safe registry primitives used by the explicit `RegistryContext`.\n\n**Re-exports**\n\n| Name | Source |\n| --- | --- |\n| [RegistryBundle][helia_aot.registry.context.RegistryBundle] | `helia_aot.registry.context.RegistryBundle` |\n| [RegistryContext][helia_aot.registry.context.RegistryContext] | `helia_aot.registry.context.RegistryContext` |\n| [build_default_registry_context][helia_aot.registry.context.build_default_registry_context] | `helia_aot.registry.context.build_default_registry_context` |",
      "name": "registry",
      "path": "helia_aot.registry",
      "submodules": [],
      "summary": "Registry API",
      "symbols": [
        {
          "description": "Thread-safe registry with optional key encoding.",
          "examples": [],
          "id": "helia_aot.registry.Registry",
          "kind": "class",
          "language": "python",
          "members": [
            {
              "description": "Register an item under the given key.",
              "examples": [],
              "id": "helia_aot.registry.Registry.register",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "register",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "register(key: K, item: T, *, overwrite: bool = False) -> None",
              "source": {
                "line": 36,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L36"
              },
              "summary": "Register an item under the given key."
            },
            {
              "description": "Unregister an item if present.",
              "examples": [],
              "id": "helia_aot.registry.Registry.unregister",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "unregister",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "unregister(key: K) -> None",
              "source": {
                "line": 46,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L46"
              },
              "summary": "Unregister an item if present."
            },
            {
              "description": "Get a registered item by key.",
              "examples": [],
              "id": "helia_aot.registry.Registry.get",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "get",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "get(key: K) -> T",
              "source": {
                "line": 54,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L54"
              },
              "summary": "Get a registered item by key."
            },
            {
              "description": "Check if an item is registered.",
              "examples": [],
              "id": "helia_aot.registry.Registry.has",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "has",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "has(key: K) -> bool",
              "source": {
                "line": 58,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L58"
              },
              "summary": "Check if an item is registered."
            },
            {
              "description": "List registered encoded key names.",
              "examples": [],
              "id": "helia_aot.registry.Registry.list",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "list",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "list() -> builtins.list[str]",
              "source": {
                "line": 62,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L62"
              },
              "summary": "List registered encoded key names."
            },
            {
              "description": "Decorator helper to register callables/classes.",
              "examples": [],
              "id": "helia_aot.registry.Registry.decorator",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "decorator",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "decorator(key: K, *, overwrite: bool = False) -> Callable[[T], T]",
              "source": {
                "line": 66,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L66"
              },
              "summary": "Decorator helper to register callables/classes."
            },
            {
              "description": "Prevent modifications; useful after bootstrapping built-ins.",
              "examples": [],
              "id": "helia_aot.registry.Registry.freeze",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "freeze",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "freeze() -> None",
              "source": {
                "line": 75,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L75"
              },
              "summary": "Prevent modifications; useful after bootstrapping built-ins."
            },
            {
              "description": "Allow modifications again.",
              "examples": [],
              "id": "helia_aot.registry.Registry.unfreeze",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "unfreeze",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "unfreeze() -> None",
              "source": {
                "line": 80,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L80"
              },
              "summary": "Allow modifications again."
            },
            {
              "description": "Remove all items from the registry.",
              "examples": [],
              "id": "helia_aot.registry.Registry.clear",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "clear",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "clear() -> None",
              "source": {
                "line": 85,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L85"
              },
              "summary": "Remove all items from the registry."
            },
            {
              "description": "Iterate over encoded key, item pairs.",
              "examples": [],
              "id": "helia_aot.registry.Registry.items",
              "kind": "method",
              "language": "python",
              "members": [],
              "name": "items",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "items() -> Iterable[tuple[str, T]]",
              "source": {
                "line": 92,
                "path": "helia_aot/registry/__init__.py",
                "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L92"
              },
              "summary": "Iterate over encoded key, item pairs."
            }
          ],
          "name": "Registry",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "Registry(*, key_encoder: Callable[[K], str] | None = None)",
          "source": {
            "line": 24,
            "path": "helia_aot/registry/__init__.py",
            "url": "https://github.com/AmbiqAI/helia-aot/blob/cf2246a7ad439fa38d57462118e7840e5497a685/helia_aot/registry/__init__.py#L24"
          },
          "summary": "Thread-safe registry with optional key encoding."
        }
      ]
    }
  ],
  "name": "helia_aot"
}