:py:mod:`gmuse.credentials`
===========================

.. py:module:: gmuse.credentials

.. autodoc2-docstring:: gmuse.credentials
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`CredentialResolution <gmuse.credentials.CredentialResolution>`
     - .. autodoc2-docstring:: gmuse.credentials.CredentialResolution
          :parser: myst
          :summary:
   * - :py:obj:`BackendStatus <gmuse.credentials.BackendStatus>`
     - .. autodoc2-docstring:: gmuse.credentials.BackendStatus
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`normalize_env_value <gmuse.credentials.normalize_env_value>`
     - .. autodoc2-docstring:: gmuse.credentials.normalize_env_value
          :parser: myst
          :summary:
   * - :py:obj:`mask_secret <gmuse.credentials.mask_secret>`
     - .. autodoc2-docstring:: gmuse.credentials.mask_secret
          :parser: myst
          :summary:
   * - :py:obj:`_call_keyring <gmuse.credentials._call_keyring>`
     - .. autodoc2-docstring:: gmuse.credentials._call_keyring
          :parser: myst
          :summary:
   * - :py:obj:`get_backend_status <gmuse.credentials.get_backend_status>`
     - .. autodoc2-docstring:: gmuse.credentials.get_backend_status
          :parser: myst
          :summary:
   * - :py:obj:`ensure_secure_backend <gmuse.credentials.ensure_secure_backend>`
     - .. autodoc2-docstring:: gmuse.credentials.ensure_secure_backend
          :parser: myst
          :summary:
   * - :py:obj:`_read_keyring_value <gmuse.credentials._read_keyring_value>`
     - .. autodoc2-docstring:: gmuse.credentials._read_keyring_value
          :parser: myst
          :summary:
   * - :py:obj:`get_managed_variables <gmuse.credentials.get_managed_variables>`
     - .. autodoc2-docstring:: gmuse.credentials.get_managed_variables
          :parser: myst
          :summary:
   * - :py:obj:`write_managed_variables <gmuse.credentials.write_managed_variables>`
     - .. autodoc2-docstring:: gmuse.credentials.write_managed_variables
          :parser: myst
          :summary:
   * - :py:obj:`add_managed_variable <gmuse.credentials.add_managed_variable>`
     - .. autodoc2-docstring:: gmuse.credentials.add_managed_variable
          :parser: myst
          :summary:
   * - :py:obj:`remove_managed_variable <gmuse.credentials.remove_managed_variable>`
     - .. autodoc2-docstring:: gmuse.credentials.remove_managed_variable
          :parser: myst
          :summary:
   * - :py:obj:`store_credential <gmuse.credentials.store_credential>`
     - .. autodoc2-docstring:: gmuse.credentials.store_credential
          :parser: myst
          :summary:
   * - :py:obj:`delete_credential <gmuse.credentials.delete_credential>`
     - .. autodoc2-docstring:: gmuse.credentials.delete_credential
          :parser: myst
          :summary:
   * - :py:obj:`credential_exists <gmuse.credentials.credential_exists>`
     - .. autodoc2-docstring:: gmuse.credentials.credential_exists
          :parser: myst
          :summary:
   * - :py:obj:`get_provider_credential_variables <gmuse.credentials.get_provider_credential_variables>`
     - .. autodoc2-docstring:: gmuse.credentials.get_provider_credential_variables
          :parser: myst
          :summary:
   * - :py:obj:`resolve_credential <gmuse.credentials.resolve_credential>`
     - .. autodoc2-docstring:: gmuse.credentials.resolve_credential
          :parser: myst
          :summary:
   * - :py:obj:`resolve_provider_credential <gmuse.credentials.resolve_provider_credential>`
     - .. autodoc2-docstring:: gmuse.credentials.resolve_provider_credential
          :parser: myst
          :summary:
   * - :py:obj:`detect_provider_from_credentials <gmuse.credentials.detect_provider_from_credentials>`
     - .. autodoc2-docstring:: gmuse.credentials.detect_provider_from_credentials
          :parser: myst
          :summary:
   * - :py:obj:`build_missing_credential_error <gmuse.credentials.build_missing_credential_error>`
     - .. autodoc2-docstring:: gmuse.credentials.build_missing_credential_error
          :parser: myst
          :summary:
   * - :py:obj:`build_backend_error_message <gmuse.credentials.build_backend_error_message>`
     - .. autodoc2-docstring:: gmuse.credentials.build_backend_error_message
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`SERVICE_NAME <gmuse.credentials.SERVICE_NAME>`
     - .. autodoc2-docstring:: gmuse.credentials.SERVICE_NAME
          :parser: myst
          :summary:
   * - :py:obj:`INDEX_USERNAME <gmuse.credentials.INDEX_USERNAME>`
     - .. autodoc2-docstring:: gmuse.credentials.INDEX_USERNAME
          :parser: myst
          :summary:
   * - :py:obj:`COMPLETION_LOOKUP_TIMEOUT_SECONDS <gmuse.credentials.COMPLETION_LOOKUP_TIMEOUT_SECONDS>`
     - .. autodoc2-docstring:: gmuse.credentials.COMPLETION_LOOKUP_TIMEOUT_SECONDS
          :parser: myst
          :summary:
   * - :py:obj:`_KEYRING_STDERR_LOCK <gmuse.credentials._KEYRING_STDERR_LOCK>`
     - .. autodoc2-docstring:: gmuse.credentials._KEYRING_STDERR_LOCK
          :parser: myst
          :summary:
   * - :py:obj:`_T <gmuse.credentials._T>`
     - .. autodoc2-docstring:: gmuse.credentials._T
          :parser: myst
          :summary:
   * - :py:obj:`CredentialSource <gmuse.credentials.CredentialSource>`
     - .. autodoc2-docstring:: gmuse.credentials.CredentialSource
          :parser: myst
          :summary:
   * - :py:obj:`_PROVIDER_CREDENTIAL_VARIABLES <gmuse.credentials._PROVIDER_CREDENTIAL_VARIABLES>`
     - .. autodoc2-docstring:: gmuse.credentials._PROVIDER_CREDENTIAL_VARIABLES
          :parser: myst
          :summary:

API
~~~

.. py:data:: SERVICE_NAME
   :canonical: gmuse.credentials.SERVICE_NAME
   :type: typing.Final[str]
   :value: 'gmuse'

   .. autodoc2-docstring:: gmuse.credentials.SERVICE_NAME
      :parser: myst

.. py:data:: INDEX_USERNAME
   :canonical: gmuse.credentials.INDEX_USERNAME
   :type: typing.Final[str]
   :value: '__gmuse_index__'

   .. autodoc2-docstring:: gmuse.credentials.INDEX_USERNAME
      :parser: myst

.. py:data:: COMPLETION_LOOKUP_TIMEOUT_SECONDS
   :canonical: gmuse.credentials.COMPLETION_LOOKUP_TIMEOUT_SECONDS
   :type: typing.Final[float]
   :value: 0.2

   .. autodoc2-docstring:: gmuse.credentials.COMPLETION_LOOKUP_TIMEOUT_SECONDS
      :parser: myst

.. py:data:: _KEYRING_STDERR_LOCK
   :canonical: gmuse.credentials._KEYRING_STDERR_LOCK
   :value: 'Lock(...)'

   .. autodoc2-docstring:: gmuse.credentials._KEYRING_STDERR_LOCK
      :parser: myst

.. py:data:: _T
   :canonical: gmuse.credentials._T
   :value: 'TypeVar(...)'

   .. autodoc2-docstring:: gmuse.credentials._T
      :parser: myst

.. py:data:: CredentialSource
   :canonical: gmuse.credentials.CredentialSource
   :value: None

   .. autodoc2-docstring:: gmuse.credentials.CredentialSource
      :parser: myst

.. py:data:: _PROVIDER_CREDENTIAL_VARIABLES
   :canonical: gmuse.credentials._PROVIDER_CREDENTIAL_VARIABLES
   :type: typing.Final[dict[str, tuple[str, ...]]]
   :value: None

   .. autodoc2-docstring:: gmuse.credentials._PROVIDER_CREDENTIAL_VARIABLES
      :parser: myst

.. py:class:: CredentialResolution
   :canonical: gmuse.credentials.CredentialResolution

   .. autodoc2-docstring:: gmuse.credentials.CredentialResolution
      :parser: myst

   .. py:attribute:: variable_name
      :canonical: gmuse.credentials.CredentialResolution.variable_name
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.CredentialResolution.variable_name
         :parser: myst

   .. py:attribute:: source
      :canonical: gmuse.credentials.CredentialResolution.source
      :type: gmuse.credentials.CredentialSource
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.CredentialResolution.source
         :parser: myst

   .. py:attribute:: raw_value
      :canonical: gmuse.credentials.CredentialResolution.raw_value
      :type: str | None
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.CredentialResolution.raw_value
         :parser: myst

   .. py:attribute:: masked_value
      :canonical: gmuse.credentials.CredentialResolution.masked_value
      :type: str | None
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.CredentialResolution.masked_value
         :parser: myst

   .. py:attribute:: is_managed
      :canonical: gmuse.credentials.CredentialResolution.is_managed
      :type: bool
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.CredentialResolution.is_managed
         :parser: myst

.. py:class:: BackendStatus
   :canonical: gmuse.credentials.BackendStatus

   .. autodoc2-docstring:: gmuse.credentials.BackendStatus
      :parser: myst

   .. py:attribute:: backend_name
      :canonical: gmuse.credentials.BackendStatus.backend_name
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.BackendStatus.backend_name
         :parser: myst

   .. py:attribute:: backend_module
      :canonical: gmuse.credentials.BackendStatus.backend_module
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.BackendStatus.backend_module
         :parser: myst

   .. py:attribute:: is_available
      :canonical: gmuse.credentials.BackendStatus.is_available
      :type: bool
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.BackendStatus.is_available
         :parser: myst

   .. py:attribute:: is_secure
      :canonical: gmuse.credentials.BackendStatus.is_secure
      :type: bool
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.BackendStatus.is_secure
         :parser: myst

   .. py:attribute:: failure_reason
      :canonical: gmuse.credentials.BackendStatus.failure_reason
      :type: str | None
      :value: None

      .. autodoc2-docstring:: gmuse.credentials.BackendStatus.failure_reason
         :parser: myst

.. py:function:: normalize_env_value(value: str | None) -> str | None
   :canonical: gmuse.credentials.normalize_env_value

   .. autodoc2-docstring:: gmuse.credentials.normalize_env_value
      :parser: myst

.. py:function:: mask_secret(value: str | None) -> str | None
   :canonical: gmuse.credentials.mask_secret

   .. autodoc2-docstring:: gmuse.credentials.mask_secret
      :parser: myst

.. py:function:: _call_keyring(operation: typing.Callable[[], gmuse.credentials._T]) -> gmuse.credentials._T
   :canonical: gmuse.credentials._call_keyring

   .. autodoc2-docstring:: gmuse.credentials._call_keyring
      :parser: myst

.. py:function:: get_backend_status() -> gmuse.credentials.BackendStatus
   :canonical: gmuse.credentials.get_backend_status

   .. autodoc2-docstring:: gmuse.credentials.get_backend_status
      :parser: myst

.. py:function:: ensure_secure_backend() -> gmuse.credentials.BackendStatus
   :canonical: gmuse.credentials.ensure_secure_backend

   .. autodoc2-docstring:: gmuse.credentials.ensure_secure_backend
      :parser: myst

.. py:function:: _read_keyring_value(variable_name: str, *, timeout: float | None = None) -> str | None
   :canonical: gmuse.credentials._read_keyring_value

   .. autodoc2-docstring:: gmuse.credentials._read_keyring_value
      :parser: myst

.. py:function:: get_managed_variables(*, timeout: float | None = None) -> set[str]
   :canonical: gmuse.credentials.get_managed_variables

   .. autodoc2-docstring:: gmuse.credentials.get_managed_variables
      :parser: myst

.. py:function:: write_managed_variables(variables: set[str]) -> None
   :canonical: gmuse.credentials.write_managed_variables

   .. autodoc2-docstring:: gmuse.credentials.write_managed_variables
      :parser: myst

.. py:function:: add_managed_variable(variable_name: str) -> None
   :canonical: gmuse.credentials.add_managed_variable

   .. autodoc2-docstring:: gmuse.credentials.add_managed_variable
      :parser: myst

.. py:function:: remove_managed_variable(variable_name: str) -> None
   :canonical: gmuse.credentials.remove_managed_variable

   .. autodoc2-docstring:: gmuse.credentials.remove_managed_variable
      :parser: myst

.. py:function:: store_credential(variable_name: str, secret: str) -> None
   :canonical: gmuse.credentials.store_credential

   .. autodoc2-docstring:: gmuse.credentials.store_credential
      :parser: myst

.. py:function:: delete_credential(variable_name: str) -> bool
   :canonical: gmuse.credentials.delete_credential

   .. autodoc2-docstring:: gmuse.credentials.delete_credential
      :parser: myst

.. py:function:: credential_exists(variable_name: str) -> bool
   :canonical: gmuse.credentials.credential_exists

   .. autodoc2-docstring:: gmuse.credentials.credential_exists
      :parser: myst

.. py:function:: get_provider_credential_variables(provider: str) -> tuple[str, ...]
   :canonical: gmuse.credentials.get_provider_credential_variables

   .. autodoc2-docstring:: gmuse.credentials.get_provider_credential_variables
      :parser: myst

.. py:function:: resolve_credential(variable_name: str, *, completion_timeout: float | None = None, managed_index: set[str] | None = None) -> gmuse.credentials.CredentialResolution
   :canonical: gmuse.credentials.resolve_credential

   .. autodoc2-docstring:: gmuse.credentials.resolve_credential
      :parser: myst

.. py:function:: resolve_provider_credential(provider: str, *, completion_timeout: float | None = None) -> gmuse.credentials.CredentialResolution | None
   :canonical: gmuse.credentials.resolve_provider_credential

   .. autodoc2-docstring:: gmuse.credentials.resolve_provider_credential
      :parser: myst

.. py:function:: detect_provider_from_credentials(*, completion_timeout: float | None = None) -> str | None
   :canonical: gmuse.credentials.detect_provider_from_credentials

   .. autodoc2-docstring:: gmuse.credentials.detect_provider_from_credentials
      :parser: myst

.. py:function:: build_missing_credential_error(variable_name: str | None = None) -> str
   :canonical: gmuse.credentials.build_missing_credential_error

   .. autodoc2-docstring:: gmuse.credentials.build_missing_credential_error
      :parser: myst

.. py:function:: build_backend_error_message(status: gmuse.credentials.BackendStatus) -> str
   :canonical: gmuse.credentials.build_backend_error_message

   .. autodoc2-docstring:: gmuse.credentials.build_backend_error_message
      :parser: myst