:py:mod:`vendor_fabric.registry`
================================

.. py:module:: vendor_fabric.registry

.. autodoc2-docstring:: vendor_fabric.registry
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`BuiltinConnectorSpec <vendor_fabric.registry.BuiltinConnectorSpec>`
     - .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec
          :parser: myst
          :summary:
   * - :py:obj:`ConnectorInfo <vendor_fabric.registry.ConnectorInfo>`
     - .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo
          :parser: myst
          :summary:
   * - :py:obj:`ConnectorAdapter <vendor_fabric.registry.ConnectorAdapter>`
     - .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter
          :parser: myst
          :summary:
   * - :py:obj:`BuiltinConnectorAdapter <vendor_fabric.registry.BuiltinConnectorAdapter>`
     - .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter
          :parser: myst
          :summary:
   * - :py:obj:`RegisteredConnectorAdapter <vendor_fabric.registry.RegisteredConnectorAdapter>`
     - .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`list_connectors <vendor_fabric.registry.list_connectors>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connectors
          :parser: myst
          :summary:
   * - :py:obj:`list_available_connectors <vendor_fabric.registry.list_available_connectors>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_available_connectors
          :parser: myst
          :summary:
   * - :py:obj:`get_connector_class <vendor_fabric.registry.get_connector_class>`
     - .. autodoc2-docstring:: vendor_fabric.registry.get_connector_class
          :parser: myst
          :summary:
   * - :py:obj:`get_connector <vendor_fabric.registry.get_connector>`
     - .. autodoc2-docstring:: vendor_fabric.registry.get_connector
          :parser: myst
          :summary:
   * - :py:obj:`clear_cache <vendor_fabric.registry.clear_cache>`
     - .. autodoc2-docstring:: vendor_fabric.registry.clear_cache
          :parser: myst
          :summary:
   * - :py:obj:`get_connector_info <vendor_fabric.registry.get_connector_info>`
     - .. autodoc2-docstring:: vendor_fabric.registry.get_connector_info
          :parser: myst
          :summary:
   * - :py:obj:`get_connector_adapter <vendor_fabric.registry.get_connector_adapter>`
     - .. autodoc2-docstring:: vendor_fabric.registry.get_connector_adapter
          :parser: myst
          :summary:
   * - :py:obj:`list_connector_info <vendor_fabric.registry.list_connector_info>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connector_info
          :parser: myst
          :summary:
   * - :py:obj:`list_connector_categories <vendor_fabric.registry.list_connector_categories>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connector_categories
          :parser: myst
          :summary:
   * - :py:obj:`list_connector_capabilities <vendor_fabric.registry.list_connector_capabilities>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connector_capabilities
          :parser: myst
          :summary:
   * - :py:obj:`list_connectors_by_category <vendor_fabric.registry.list_connectors_by_category>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connectors_by_category
          :parser: myst
          :summary:
   * - :py:obj:`list_connectors_by_capability <vendor_fabric.registry.list_connectors_by_capability>`
     - .. autodoc2-docstring:: vendor_fabric.registry.list_connectors_by_capability
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`BUILTIN_CONNECTORS <vendor_fabric.registry.BUILTIN_CONNECTORS>`
     - .. autodoc2-docstring:: vendor_fabric.registry.BUILTIN_CONNECTORS
          :parser: myst
          :summary:
   * - :py:obj:`BUILTIN_CONNECTOR_ADAPTERS <vendor_fabric.registry.BUILTIN_CONNECTOR_ADAPTERS>`
     - .. autodoc2-docstring:: vendor_fabric.registry.BUILTIN_CONNECTOR_ADAPTERS
          :parser: myst
          :summary:

API
~~~

.. py:class:: BuiltinConnectorSpec
   :canonical: vendor_fabric.registry.BuiltinConnectorSpec

   .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec
      :parser: myst

   .. py:attribute:: module_path
      :canonical: vendor_fabric.registry.BuiltinConnectorSpec.module_path
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec.module_path
         :parser: myst

   .. py:attribute:: class_name
      :canonical: vendor_fabric.registry.BuiltinConnectorSpec.class_name
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec.class_name
         :parser: myst

   .. py:attribute:: extra
      :canonical: vendor_fabric.registry.BuiltinConnectorSpec.extra
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec.extra
         :parser: myst

   .. py:attribute:: category
      :canonical: vendor_fabric.registry.BuiltinConnectorSpec.category
      :type: str
      :value: 'external'

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec.category
         :parser: myst

   .. py:attribute:: capabilities
      :canonical: vendor_fabric.registry.BuiltinConnectorSpec.capabilities
      :type: tuple[str, ...]
      :value: ()

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorSpec.capabilities
         :parser: myst

.. py:class:: ConnectorInfo
   :canonical: vendor_fabric.registry.ConnectorInfo

   .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo
      :parser: myst

   .. py:attribute:: name
      :canonical: vendor_fabric.registry.ConnectorInfo.name
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.name
         :parser: myst

   .. py:attribute:: available
      :canonical: vendor_fabric.registry.ConnectorInfo.available
      :type: bool
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.available
         :parser: myst

   .. py:attribute:: source
      :canonical: vendor_fabric.registry.ConnectorInfo.source
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.source
         :parser: myst

   .. py:attribute:: extra
      :canonical: vendor_fabric.registry.ConnectorInfo.extra
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.extra
         :parser: myst

   .. py:attribute:: category
      :canonical: vendor_fabric.registry.ConnectorInfo.category
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.category
         :parser: myst

   .. py:attribute:: capabilities
      :canonical: vendor_fabric.registry.ConnectorInfo.capabilities
      :type: tuple[str, ...]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.capabilities
         :parser: myst

   .. py:attribute:: install
      :canonical: vendor_fabric.registry.ConnectorInfo.install
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.install
         :parser: myst

   .. py:attribute:: requirements
      :canonical: vendor_fabric.registry.ConnectorInfo.requirements
      :type: tuple[str, ...]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.requirements
         :parser: myst

   .. py:attribute:: missing
      :canonical: vendor_fabric.registry.ConnectorInfo.missing
      :type: tuple[str, ...]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.missing
         :parser: myst

   .. py:attribute:: class_name
      :canonical: vendor_fabric.registry.ConnectorInfo.class_name
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.class_name
         :parser: myst

   .. py:attribute:: module
      :canonical: vendor_fabric.registry.ConnectorInfo.module
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.module
         :parser: myst

   .. py:attribute:: base_url
      :canonical: vendor_fabric.registry.ConnectorInfo.base_url
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.base_url
         :parser: myst

   .. py:attribute:: description
      :canonical: vendor_fabric.registry.ConnectorInfo.description
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.description
         :parser: myst

   .. py:attribute:: error
      :canonical: vendor_fabric.registry.ConnectorInfo.error
      :type: str | None
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.error
         :parser: myst

   .. py:method:: as_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.registry.ConnectorInfo.as_dict

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorInfo.as_dict
         :parser: myst

.. py:class:: ConnectorAdapter
   :canonical: vendor_fabric.registry.ConnectorAdapter

   Bases: :py:obj:`abc.ABC`

   .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter
      :parser: myst

   .. py:attribute:: name
      :canonical: vendor_fabric.registry.ConnectorAdapter.name
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.name
         :parser: myst

   .. py:method:: load_class() -> type[vendor_fabric.base.ConnectorBase]
      :canonical: vendor_fabric.registry.ConnectorAdapter.load_class
      :abstractmethod:

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.load_class
         :parser: myst

   .. py:method:: validate_dependencies() -> None
      :canonical: vendor_fabric.registry.ConnectorAdapter.validate_dependencies
      :abstractmethod:

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.validate_dependencies
         :parser: myst

   .. py:method:: info(error: ImportError | None = None) -> vendor_fabric.registry.ConnectorInfo
      :canonical: vendor_fabric.registry.ConnectorAdapter.info
      :abstractmethod:

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.info
         :parser: myst

   .. py:method:: create(**kwargs: typing.Any) -> vendor_fabric.base.ConnectorBase
      :canonical: vendor_fabric.registry.ConnectorAdapter.create

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.create
         :parser: myst

   .. py:method:: as_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.registry.ConnectorAdapter.as_dict

      .. autodoc2-docstring:: vendor_fabric.registry.ConnectorAdapter.as_dict
         :parser: myst

.. py:data:: BUILTIN_CONNECTORS
   :canonical: vendor_fabric.registry.BUILTIN_CONNECTORS
   :type: dict[str, vendor_fabric.registry.BuiltinConnectorSpec]
   :value: None

   .. autodoc2-docstring:: vendor_fabric.registry.BUILTIN_CONNECTORS
      :parser: myst

.. py:class:: BuiltinConnectorAdapter
   :canonical: vendor_fabric.registry.BuiltinConnectorAdapter

   Bases: :py:obj:`vendor_fabric.registry.ConnectorAdapter`

   .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter
      :parser: myst

   .. py:attribute:: name
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.name
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.name
         :parser: myst

   .. py:attribute:: spec
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.spec
      :type: vendor_fabric.registry.BuiltinConnectorSpec
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.spec
         :parser: myst

   .. py:property:: extra
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.extra
      :type: str

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.extra
         :parser: myst

   .. py:property:: requirements
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.requirements
      :type: extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.requirements
         :parser: myst

   .. py:property:: missing
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.missing
      :type: extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.missing
         :parser: myst

   .. py:property:: install
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.install
      :type: str

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.install
         :parser: myst

   .. py:property:: available
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.available
      :type: bool

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.available
         :parser: myst

   .. py:method:: unavailable_error(error: ImportError | None = None) -> ImportError
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.unavailable_error

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.unavailable_error
         :parser: myst

   .. py:method:: validate_dependencies() -> None
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.validate_dependencies

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.validate_dependencies
         :parser: myst

   .. py:method:: load_class() -> type[vendor_fabric.base.ConnectorBase]
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.load_class

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.load_class
         :parser: myst

   .. py:method:: info(error: ImportError | None = None) -> vendor_fabric.registry.ConnectorInfo
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.info

      .. autodoc2-docstring:: vendor_fabric.registry.BuiltinConnectorAdapter.info
         :parser: myst

   .. py:method:: create(**kwargs: typing.Any) -> vendor_fabric.base.ConnectorBase
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.create

   .. py:method:: as_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.registry.BuiltinConnectorAdapter.as_dict

.. py:class:: RegisteredConnectorAdapter
   :canonical: vendor_fabric.registry.RegisteredConnectorAdapter

   Bases: :py:obj:`vendor_fabric.registry.ConnectorAdapter`

   .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter
      :parser: myst

   .. py:attribute:: name
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.name
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter.name
         :parser: myst

   .. py:attribute:: connector_class
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.connector_class
      :type: type[vendor_fabric.base.ConnectorBase]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter.connector_class
         :parser: myst

   .. py:method:: load_class() -> type[vendor_fabric.base.ConnectorBase]
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.load_class

      .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter.load_class
         :parser: myst

   .. py:method:: validate_dependencies() -> None
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.validate_dependencies

      .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter.validate_dependencies
         :parser: myst

   .. py:method:: info(error: ImportError | None = None) -> vendor_fabric.registry.ConnectorInfo
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.info

      .. autodoc2-docstring:: vendor_fabric.registry.RegisteredConnectorAdapter.info
         :parser: myst

   .. py:method:: create(**kwargs: typing.Any) -> vendor_fabric.base.ConnectorBase
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.create

   .. py:method:: as_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.registry.RegisteredConnectorAdapter.as_dict

.. py:data:: BUILTIN_CONNECTOR_ADAPTERS
   :canonical: vendor_fabric.registry.BUILTIN_CONNECTOR_ADAPTERS
   :type: dict[str, vendor_fabric.registry.BuiltinConnectorAdapter]
   :value: None

   .. autodoc2-docstring:: vendor_fabric.registry.BUILTIN_CONNECTOR_ADAPTERS
      :parser: myst

.. py:function:: list_connectors(*, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric.registry.list_connectors

   .. autodoc2-docstring:: vendor_fabric.registry.list_connectors
      :parser: myst

.. py:function:: list_available_connectors() -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric.registry.list_available_connectors

   .. autodoc2-docstring:: vendor_fabric.registry.list_available_connectors
      :parser: myst

.. py:function:: get_connector_class(name: str) -> type[vendor_fabric.base.ConnectorBase]
   :canonical: vendor_fabric.registry.get_connector_class

   .. autodoc2-docstring:: vendor_fabric.registry.get_connector_class
      :parser: myst

.. py:function:: get_connector(name: str, **kwargs: typing.Any) -> vendor_fabric.base.ConnectorBase
   :canonical: vendor_fabric.registry.get_connector

   .. autodoc2-docstring:: vendor_fabric.registry.get_connector
      :parser: myst

.. py:function:: clear_cache() -> None
   :canonical: vendor_fabric.registry.clear_cache

   .. autodoc2-docstring:: vendor_fabric.registry.clear_cache
      :parser: myst

.. py:function:: get_connector_info(name: str, *, include_unavailable: bool = True) -> extended_data.containers.ExtendedDict
   :canonical: vendor_fabric.registry.get_connector_info

   .. autodoc2-docstring:: vendor_fabric.registry.get_connector_info
      :parser: myst

.. py:function:: get_connector_adapter(name: str, *, include_unavailable: bool = True) -> vendor_fabric.registry.ConnectorAdapter
   :canonical: vendor_fabric.registry.get_connector_adapter

   .. autodoc2-docstring:: vendor_fabric.registry.get_connector_adapter
      :parser: myst

.. py:function:: list_connector_info(*, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
   :canonical: vendor_fabric.registry.list_connector_info

   .. autodoc2-docstring:: vendor_fabric.registry.list_connector_info
      :parser: myst

.. py:function:: list_connector_categories(*, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric.registry.list_connector_categories

   .. autodoc2-docstring:: vendor_fabric.registry.list_connector_categories
      :parser: myst

.. py:function:: list_connector_capabilities(*, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric.registry.list_connector_capabilities

   .. autodoc2-docstring:: vendor_fabric.registry.list_connector_capabilities
      :parser: myst

.. py:function:: list_connectors_by_category(category: str, *, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
   :canonical: vendor_fabric.registry.list_connectors_by_category

   .. autodoc2-docstring:: vendor_fabric.registry.list_connectors_by_category
      :parser: myst

.. py:function:: list_connectors_by_capability(capability: str, *, include_unavailable: bool = True) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedDict]
   :canonical: vendor_fabric.registry.list_connectors_by_capability

   .. autodoc2-docstring:: vendor_fabric.registry.list_connectors_by_capability
      :parser: myst