:orphan:

:py:mod:`vendor_fabric._optional`
=================================

.. py:module:: vendor_fabric._optional

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`is_available <vendor_fabric._optional.is_available>`
     - .. autodoc2-docstring:: vendor_fabric._optional.is_available
          :parser: myst
          :summary:
   * - :py:obj:`get_extra_for_package <vendor_fabric._optional.get_extra_for_package>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_extra_for_package
          :parser: myst
          :summary:
   * - :py:obj:`require_extra <vendor_fabric._optional.require_extra>`
     - .. autodoc2-docstring:: vendor_fabric._optional.require_extra
          :parser: myst
          :summary:
   * - :py:obj:`require_any <vendor_fabric._optional.require_any>`
     - .. autodoc2-docstring:: vendor_fabric._optional.require_any
          :parser: myst
          :summary:
   * - :py:obj:`get_extra_for_connector <vendor_fabric._optional.get_extra_for_connector>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_extra_for_connector
          :parser: myst
          :summary:
   * - :py:obj:`get_connector_requirements <vendor_fabric._optional.get_connector_requirements>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_connector_requirements
          :parser: myst
          :summary:
   * - :py:obj:`get_missing_connector_requirements <vendor_fabric._optional.get_missing_connector_requirements>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_missing_connector_requirements
          :parser: myst
          :summary:
   * - :py:obj:`get_connector_install_command <vendor_fabric._optional.get_connector_install_command>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_connector_install_command
          :parser: myst
          :summary:
   * - :py:obj:`is_connector_available <vendor_fabric._optional.is_connector_available>`
     - .. autodoc2-docstring:: vendor_fabric._optional.is_connector_available
          :parser: myst
          :summary:
   * - :py:obj:`get_available_connectors <vendor_fabric._optional.get_available_connectors>`
     - .. autodoc2-docstring:: vendor_fabric._optional.get_available_connectors
          :parser: myst
          :summary:
   * - :py:obj:`require_connector <vendor_fabric._optional.require_connector>`
     - .. autodoc2-docstring:: vendor_fabric._optional.require_connector
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`PACKAGE_TO_EXTRA <vendor_fabric._optional.PACKAGE_TO_EXTRA>`
     - .. autodoc2-docstring:: vendor_fabric._optional.PACKAGE_TO_EXTRA
          :parser: myst
          :summary:
   * - :py:obj:`PACKAGE_INSTALL_HINTS <vendor_fabric._optional.PACKAGE_INSTALL_HINTS>`
     - .. autodoc2-docstring:: vendor_fabric._optional.PACKAGE_INSTALL_HINTS
          :parser: myst
          :summary:
   * - :py:obj:`CONNECTOR_REQUIREMENTS <vendor_fabric._optional.CONNECTOR_REQUIREMENTS>`
     - .. autodoc2-docstring:: vendor_fabric._optional.CONNECTOR_REQUIREMENTS
          :parser: myst
          :summary:
   * - :py:obj:`CONNECTOR_EXTRAS <vendor_fabric._optional.CONNECTOR_EXTRAS>`
     - .. autodoc2-docstring:: vendor_fabric._optional.CONNECTOR_EXTRAS
          :parser: myst
          :summary:

API
~~~

.. py:data:: PACKAGE_TO_EXTRA
   :canonical: vendor_fabric._optional.PACKAGE_TO_EXTRA
   :type: dict[str, str]
   :value: None

   .. autodoc2-docstring:: vendor_fabric._optional.PACKAGE_TO_EXTRA
      :parser: myst

.. py:data:: PACKAGE_INSTALL_HINTS
   :canonical: vendor_fabric._optional.PACKAGE_INSTALL_HINTS
   :type: dict[str, str]
   :value: None

   .. autodoc2-docstring:: vendor_fabric._optional.PACKAGE_INSTALL_HINTS
      :parser: myst

.. py:function:: is_available(package: str) -> bool
   :canonical: vendor_fabric._optional.is_available

   .. autodoc2-docstring:: vendor_fabric._optional.is_available
      :parser: myst

.. py:function:: get_extra_for_package(package: str) -> extended_data.containers.ExtendedString | None
   :canonical: vendor_fabric._optional.get_extra_for_package

   .. autodoc2-docstring:: vendor_fabric._optional.get_extra_for_package
      :parser: myst

.. py:function:: require_extra(package: str, extra: str | None = None) -> typing.Any
   :canonical: vendor_fabric._optional.require_extra

   .. autodoc2-docstring:: vendor_fabric._optional.require_extra
      :parser: myst

.. py:function:: require_any(*packages: str, extra: str) -> typing.Any
   :canonical: vendor_fabric._optional.require_any

   .. autodoc2-docstring:: vendor_fabric._optional.require_any
      :parser: myst

.. py:data:: CONNECTOR_REQUIREMENTS
   :canonical: vendor_fabric._optional.CONNECTOR_REQUIREMENTS
   :type: dict[str, list[str]]
   :value: None

   .. autodoc2-docstring:: vendor_fabric._optional.CONNECTOR_REQUIREMENTS
      :parser: myst

.. py:data:: CONNECTOR_EXTRAS
   :canonical: vendor_fabric._optional.CONNECTOR_EXTRAS
   :type: dict[str, str]
   :value: None

   .. autodoc2-docstring:: vendor_fabric._optional.CONNECTOR_EXTRAS
      :parser: myst

.. py:function:: get_extra_for_connector(connector: str) -> extended_data.containers.ExtendedString | None
   :canonical: vendor_fabric._optional.get_extra_for_connector

   .. autodoc2-docstring:: vendor_fabric._optional.get_extra_for_connector
      :parser: myst

.. py:function:: get_connector_requirements(connector: str) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric._optional.get_connector_requirements

   .. autodoc2-docstring:: vendor_fabric._optional.get_connector_requirements
      :parser: myst

.. py:function:: get_missing_connector_requirements(connector: str) -> extended_data.containers.ExtendedList[extended_data.containers.ExtendedString]
   :canonical: vendor_fabric._optional.get_missing_connector_requirements

   .. autodoc2-docstring:: vendor_fabric._optional.get_missing_connector_requirements
      :parser: myst

.. py:function:: get_connector_install_command(connector: str) -> extended_data.containers.ExtendedString | None
   :canonical: vendor_fabric._optional.get_connector_install_command

   .. autodoc2-docstring:: vendor_fabric._optional.get_connector_install_command
      :parser: myst

.. py:function:: is_connector_available(connector: str) -> bool
   :canonical: vendor_fabric._optional.is_connector_available

   .. autodoc2-docstring:: vendor_fabric._optional.is_connector_available
      :parser: myst

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

   .. autodoc2-docstring:: vendor_fabric._optional.get_available_connectors
      :parser: myst

.. py:function:: require_connector(connector: str) -> None
   :canonical: vendor_fabric._optional.require_connector

   .. autodoc2-docstring:: vendor_fabric._optional.require_connector
      :parser: myst