:py:mod:`vendor_fabric.capabilities`
====================================

.. py:module:: vendor_fabric.capabilities

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

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

Classes
~~~~~~~

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

   * - :py:obj:`CapabilitySpec <vendor_fabric.capabilities.CapabilitySpec>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec
          :parser: myst
          :summary:
   * - :py:obj:`CapabilityRoute <vendor_fabric.capabilities.CapabilityRoute>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute
          :parser: myst
          :summary:
   * - :py:obj:`CapabilityProviderMixin <vendor_fabric.capabilities.CapabilityProviderMixin>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityProviderMixin
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`capability <vendor_fabric.capabilities.capability>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.capability
          :parser: myst
          :summary:
   * - :py:obj:`capability_routes <vendor_fabric.capabilities.capability_routes>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.capability_routes
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`F <vendor_fabric.capabilities.F>`
     - .. autodoc2-docstring:: vendor_fabric.capabilities.F
          :parser: myst
          :summary:

API
~~~

.. py:data:: F
   :canonical: vendor_fabric.capabilities.F
   :value: 'TypeVar(...)'

   .. autodoc2-docstring:: vendor_fabric.capabilities.F
      :parser: myst

.. py:class:: CapabilitySpec
   :canonical: vendor_fabric.capabilities.CapabilitySpec

   .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec
      :parser: myst

   .. py:attribute:: operation
      :canonical: vendor_fabric.capabilities.CapabilitySpec.operation
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec.operation
         :parser: myst

   .. py:attribute:: kind
      :canonical: vendor_fabric.capabilities.CapabilitySpec.kind
      :type: str
      :value: 'operation'

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec.kind
         :parser: myst

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

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec.aliases
         :parser: myst

   .. py:attribute:: description
      :canonical: vendor_fabric.capabilities.CapabilitySpec.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilitySpec.description
         :parser: myst

.. py:class:: CapabilityRoute
   :canonical: vendor_fabric.capabilities.CapabilityRoute

   .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute
      :parser: myst

   .. py:attribute:: provider
      :canonical: vendor_fabric.capabilities.CapabilityRoute.provider
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.provider
         :parser: myst

   .. py:attribute:: operation
      :canonical: vendor_fabric.capabilities.CapabilityRoute.operation
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.operation
         :parser: myst

   .. py:attribute:: method
      :canonical: vendor_fabric.capabilities.CapabilityRoute.method
      :type: str
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.method
         :parser: myst

   .. py:attribute:: kind
      :canonical: vendor_fabric.capabilities.CapabilityRoute.kind
      :type: str
      :value: 'operation'

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.kind
         :parser: myst

   .. py:attribute:: description
      :canonical: vendor_fabric.capabilities.CapabilityRoute.description
      :type: str
      :value: <Multiline-String>

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.description
         :parser: myst

   .. py:attribute:: source
      :canonical: vendor_fabric.capabilities.CapabilityRoute.source
      :type: str
      :value: 'decorator'

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.source
         :parser: myst

   .. py:method:: as_dict() -> extended_data.containers.ExtendedDict
      :canonical: vendor_fabric.capabilities.CapabilityRoute.as_dict

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityRoute.as_dict
         :parser: myst

.. py:function:: capability(operation: str, *, kind: str = 'operation', aliases: tuple[str, ...] = (), description: str = '') -> collections.abc.Callable[[vendor_fabric.capabilities.F], vendor_fabric.capabilities.F]
   :canonical: vendor_fabric.capabilities.capability

   .. autodoc2-docstring:: vendor_fabric.capabilities.capability
      :parser: myst

.. py:class:: CapabilityProviderMixin
   :canonical: vendor_fabric.capabilities.CapabilityProviderMixin

   .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityProviderMixin
      :parser: myst

   .. py:attribute:: vendor_capabilities
      :canonical: vendor_fabric.capabilities.CapabilityProviderMixin.vendor_capabilities
      :type: typing.ClassVar[dict[str, vendor_fabric.capabilities.CapabilitySpec]]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityProviderMixin.vendor_capabilities
         :parser: myst

   .. py:attribute:: vendor_capability_methods
      :canonical: vendor_fabric.capabilities.CapabilityProviderMixin.vendor_capability_methods
      :type: typing.ClassVar[dict[str, str]]
      :value: None

      .. autodoc2-docstring:: vendor_fabric.capabilities.CapabilityProviderMixin.vendor_capability_methods
         :parser: myst

.. py:function:: capability_routes(provider: str, provider_cls: type[typing.Any]) -> dict[str, vendor_fabric.capabilities.CapabilityRoute]
   :canonical: vendor_fabric.capabilities.capability_routes

   .. autodoc2-docstring:: vendor_fabric.capabilities.capability_routes
      :parser: myst