:py:mod:`config`
================

.. py:module:: conda.plugins.config

.. autoapi-nested-parse::

   Handles plugin configuration functionality including:
     - Managing plugin-specific settings
     - Processing configuration data from various sources
     - Dynamically adding and removing plugin settings
     - Providing a standardized interface for plugins to access their configurations



Classes
-------

.. autoapisummary::

   conda.plugins.config.PluginConfig




.. py:class:: PluginConfig(data)


   Bases: :py:obj:`conda.common.configuration.Configuration`

   Class used to hold settings for conda plugins.

   The object created by this class should only be accessed via
   :class:`conda.base.context.Context.plugins`.

   When this class is updated via the :func:`add_plugin_setting` function it adds new setting
   properties which can be accessed later via the context object.

   We currently call that function in
   :meth:`conda.plugins.manager.CondaPluginManager.load_settings`.
   because ``CondaPluginManager`` has access to all registered plugin settings via the settings
   plugin hook.

   .. py:property:: raw_data
      :type: dict[pathlib.Path, dict[str, conda.common.configuration.RawParameter]]

      This is used to move everything under the key "plugins" from the provided dictionary
      to the top level of the returned dictionary. The returned dictionary is then passed
      to :class:`PluginConfig`.

   .. py:property:: category_map
      :type: dict[str, tuple[str, Ellipsis]]


   .. py:attribute:: parameter_names
      :type: tuple[str, Ellipsis]
      :value: ()

      

   .. py:attribute:: parameter_names_and_aliases
      :type: tuple[str, Ellipsis]
      :value: ()

      

   .. py:method:: add_plugin_setting(name: str, parameter: conda.common.configuration.Parameter, aliases: tuple[str, Ellipsis] = ())
      :classmethod:

      Adds a setting to the :class:`PluginConfig` class


   .. py:method:: remove_all_plugin_settings() -> None
      :classmethod:

      Removes all attached settings from the :class:`PluginConfig` class


   .. py:method:: get_descriptions() -> dict[str, str]


   .. py:method:: describe_parameter(parameter_name) -> dict[str, Any]

      Returns the description of a parameter.

      We add to this method in order to change the "name" key that is returned to prepend "plugins."
      to it.