:py:mod:`agentic_fabric.runners.registry`
=========================================

.. py:module:: agentic_fabric.runners.registry

.. autodoc2-docstring:: agentic_fabric.runners.registry
   :parser: myst
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`RuntimeSpec <agentic_fabric.runners.registry.RuntimeSpec>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec
          :parser: myst
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`register_runtime <agentic_fabric.runners.registry.register_runtime>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.register_runtime
          :parser: myst
          :summary:
   * - :py:obj:`runtime_specs <agentic_fabric.runners.registry.runtime_specs>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_specs
          :parser: myst
          :summary:
   * - :py:obj:`runtime_names <agentic_fabric.runners.registry.runtime_names>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_names
          :parser: myst
          :summary:
   * - :py:obj:`get_runtime_spec <agentic_fabric.runners.registry.get_runtime_spec>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.get_runtime_spec
          :parser: myst
          :summary:
   * - :py:obj:`clear_runtime_cache <agentic_fabric.runners.registry.clear_runtime_cache>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.clear_runtime_cache
          :parser: myst
          :summary:
   * - :py:obj:`is_runtime_available <agentic_fabric.runners.registry.is_runtime_available>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.is_runtime_available
          :parser: myst
          :summary:
   * - :py:obj:`available_runtimes <agentic_fabric.runners.registry.available_runtimes>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.available_runtimes
          :parser: myst
          :summary:
   * - :py:obj:`runtime_info <agentic_fabric.runners.registry.runtime_info>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_info
          :parser: myst
          :summary:
   * - :py:obj:`require_runtime <agentic_fabric.runners.registry.require_runtime>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.require_runtime
          :parser: myst
          :summary:
   * - :py:obj:`load_runner <agentic_fabric.runners.registry.load_runner>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.load_runner
          :parser: myst
          :summary:
   * - :py:obj:`install_command <agentic_fabric.runners.registry.install_command>`
     - .. autodoc2-docstring:: agentic_fabric.runners.registry.install_command
          :parser: myst
          :summary:

API
~~~

.. py:class:: RuntimeSpec
   :canonical: agentic_fabric.runners.registry.RuntimeSpec

   .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec
      :parser: myst

   .. py:attribute:: name
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.name
      :type: str
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.name
         :parser: myst

   .. py:attribute:: import_name
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.import_name
      :type: str
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.import_name
         :parser: myst

   .. py:attribute:: runner_module
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.runner_module
      :type: str
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.runner_module
         :parser: myst

   .. py:attribute:: runner_class
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.runner_class
      :type: str
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.runner_class
         :parser: myst

   .. py:attribute:: install
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.install
      :type: str
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.install
         :parser: myst

   .. py:attribute:: extra
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.extra
      :type: str | None
      :value: None

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.extra
         :parser: myst

   .. py:attribute:: description
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.description
         :parser: myst

   .. py:method:: as_dict(*, available: bool) -> dict[str, typing.Any]
      :canonical: agentic_fabric.runners.registry.RuntimeSpec.as_dict

      .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeSpec.as_dict
         :parser: myst

.. py:exception:: RuntimeUnavailableError(runtime: str, install: str)
   :canonical: agentic_fabric.runners.registry.RuntimeUnavailableError

   Bases: :py:obj:`RuntimeError`

   .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeUnavailableError
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: agentic_fabric.runners.registry.RuntimeUnavailableError.__init__
      :parser: myst

   .. py:method:: add_note()
      :canonical: agentic_fabric.runners.registry.RuntimeUnavailableError.add_note

   .. py:class:: args
      :canonical: agentic_fabric.runners.registry.RuntimeUnavailableError.args

   .. py:method:: with_traceback()
      :canonical: agentic_fabric.runners.registry.RuntimeUnavailableError.with_traceback

.. py:function:: register_runtime(spec: agentic_fabric.runners.registry.RuntimeSpec) -> None
   :canonical: agentic_fabric.runners.registry.register_runtime

   .. autodoc2-docstring:: agentic_fabric.runners.registry.register_runtime
      :parser: myst

.. py:function:: runtime_specs() -> types.MappingProxyType[str, agentic_fabric.runners.registry.RuntimeSpec]
   :canonical: agentic_fabric.runners.registry.runtime_specs

   .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_specs
      :parser: myst

.. py:function:: runtime_names() -> list[str]
   :canonical: agentic_fabric.runners.registry.runtime_names

   .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_names
      :parser: myst

.. py:function:: get_runtime_spec(runtime: str) -> agentic_fabric.runners.registry.RuntimeSpec
   :canonical: agentic_fabric.runners.registry.get_runtime_spec

   .. autodoc2-docstring:: agentic_fabric.runners.registry.get_runtime_spec
      :parser: myst

.. py:function:: clear_runtime_cache() -> None
   :canonical: agentic_fabric.runners.registry.clear_runtime_cache

   .. autodoc2-docstring:: agentic_fabric.runners.registry.clear_runtime_cache
      :parser: myst

.. py:function:: is_runtime_available(runtime: str) -> bool
   :canonical: agentic_fabric.runners.registry.is_runtime_available

   .. autodoc2-docstring:: agentic_fabric.runners.registry.is_runtime_available
      :parser: myst

.. py:function:: available_runtimes() -> list[str]
   :canonical: agentic_fabric.runners.registry.available_runtimes

   .. autodoc2-docstring:: agentic_fabric.runners.registry.available_runtimes
      :parser: myst

.. py:function:: runtime_info(runtime: str | None = None) -> list[dict[str, typing.Any]] | dict[str, typing.Any]
   :canonical: agentic_fabric.runners.registry.runtime_info

   .. autodoc2-docstring:: agentic_fabric.runners.registry.runtime_info
      :parser: myst

.. py:function:: require_runtime(runtime: str) -> agentic_fabric.runners.registry.RuntimeSpec
   :canonical: agentic_fabric.runners.registry.require_runtime

   .. autodoc2-docstring:: agentic_fabric.runners.registry.require_runtime
      :parser: myst

.. py:function:: load_runner(runtime: str) -> typing.Any
   :canonical: agentic_fabric.runners.registry.load_runner

   .. autodoc2-docstring:: agentic_fabric.runners.registry.load_runner
      :parser: myst

.. py:function:: install_command(runtime: str) -> str
   :canonical: agentic_fabric.runners.registry.install_command

   .. autodoc2-docstring:: agentic_fabric.runners.registry.install_command
      :parser: myst