:py:mod:`main_config`
=====================

.. py:module:: conda.cli.main_config

.. autoapi-nested-parse::

   CLI implementation for `conda config`.

   Allows for programmatically interacting with conda's configuration files (e.g., `~/.condarc`).




Functions
---------

.. autoapisummary::

   conda.cli.main_config.configure_parser
   conda.cli.main_config.execute
   conda.cli.main_config.format_dict
   conda.cli.main_config.parameter_description_builder
   conda.cli.main_config.describe_all_parameters
   conda.cli.main_config.print_config_item
   conda.cli.main_config.set_keys
   conda.cli.main_config.execute_config
   conda.cli.main_config._key_exists
   conda.cli.main_config._get_key
   conda.cli.main_config._set_key
   conda.cli.main_config._remove_item
   conda.cli.main_config._remove_key
   conda.cli.main_config._read_rc
   conda.cli.main_config._write_rc
   conda.cli.main_config._validate_provided_parameters



.. py:function:: configure_parser(sub_parsers: argparse._SubParsersAction, **kwargs) -> argparse.ArgumentParser

.. py:function:: execute(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int

.. py:function:: format_dict(d)

.. py:function:: parameter_description_builder(name, context=None, plugins=False)

.. py:function:: describe_all_parameters(context=None, plugins=False) -> str

   Return a string with the descriptions of all available configuration

   When ``context`` has no parameters, this function returns ``""``


.. py:function:: print_config_item(key, value)

.. py:function:: set_keys(*args: tuple[str, Any], path: str | os.PathLike[str] | pathlib.Path) -> None

   Set multiple configuration keys in a file.

   :param args: Variable number of (key, value) tuples to set.
   :param path: Path to the configuration file.


.. py:function:: execute_config(args: argparse.Namespace, parser: argparse.ArgumentParser) -> int | None

   Execute the conda config command based on provided arguments.

   Handles various config subcommands including show, show-sources, describe,
   validate, write-default, and modification operations (add, set, remove, etc.).

   :param args: Parsed command line arguments.
   :param parser: Argument parser instance.


.. py:function:: _key_exists(key: str, warnings: list[str], context=None) -> bool

   Deprecated. Use ConfigurationFile.key_exists() instead.


.. py:function:: _get_key(key: str, warnings: list[str], config: dict[str, Any], context=None) -> tuple[str, Any]

   Deprecated. Use ConfigurationFile.get_key() instead.


.. py:function:: _set_key(key: str, item: Any, config: dict) -> None

   Deprecated. Use ConfigurationFile.set_key() instead.


.. py:function:: _remove_item(key: str, item: Any, config: dict) -> None

   Deprecated. Use ConfigurationFile.remove_item() instead.


.. py:function:: _remove_key(key: str, config: dict) -> None

   Deprecated. Use ConfigurationFile.remove_key() instead.


.. py:function:: _read_rc(path: str | os.PathLike[str] | pathlib.Path) -> dict

   Deprecated. Use ConfigurationFile.read() instead.


.. py:function:: _write_rc(path: str | os.PathLike[str] | pathlib.Path, config: dict) -> None

   Deprecated. Use ConfigurationFile.write() instead.


.. py:function:: _validate_provided_parameters(parameters: collections.abc.Sequence[str], plugin_parameters: collections.abc.Sequence[str], context) -> None

   Deprecated. Use validate_provided_parameters() instead.