:py:mod:`gmuse.config`
======================

.. py:module:: gmuse.config

.. autodoc2-docstring:: gmuse.config
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`get_config_path <gmuse.config.get_config_path>`
     - .. autodoc2-docstring:: gmuse.config.get_config_path
          :summary:
   * - :py:obj:`load_config <gmuse.config.load_config>`
     - .. autodoc2-docstring:: gmuse.config.load_config
          :summary:
   * - :py:obj:`load_config_raw <gmuse.config.load_config_raw>`
     - .. autodoc2-docstring:: gmuse.config.load_config_raw
          :summary:
   * - :py:obj:`parse_config_value <gmuse.config.parse_config_value>`
     - .. autodoc2-docstring:: gmuse.config.parse_config_value
          :summary:
   * - :py:obj:`_validate_integer_range <gmuse.config._validate_integer_range>`
     - .. autodoc2-docstring:: gmuse.config._validate_integer_range
          :summary:
   * - :py:obj:`_validate_float_range <gmuse.config._validate_float_range>`
     - .. autodoc2-docstring:: gmuse.config._validate_float_range
          :summary:
   * - :py:obj:`_validate_string_choice <gmuse.config._validate_string_choice>`
     - .. autodoc2-docstring:: gmuse.config._validate_string_choice
          :summary:
   * - :py:obj:`_validate_boolean <gmuse.config._validate_boolean>`
     - .. autodoc2-docstring:: gmuse.config._validate_boolean
          :summary:
   * - :py:obj:`_validate_optional_string <gmuse.config._validate_optional_string>`
     - .. autodoc2-docstring:: gmuse.config._validate_optional_string
          :summary:
   * - :py:obj:`_parse_env_int <gmuse.config._parse_env_int>`
     - .. autodoc2-docstring:: gmuse.config._parse_env_int
          :summary:
   * - :py:obj:`_parse_env_float <gmuse.config._parse_env_float>`
     - .. autodoc2-docstring:: gmuse.config._parse_env_float
          :summary:
   * - :py:obj:`validate_config <gmuse.config.validate_config>`
     - .. autodoc2-docstring:: gmuse.config.validate_config
          :summary:
   * - :py:obj:`merge_config <gmuse.config.merge_config>`
     - .. autodoc2-docstring:: gmuse.config.merge_config
          :summary:
   * - :py:obj:`_load_toml_document <gmuse.config._load_toml_document>`
     - .. autodoc2-docstring:: gmuse.config._load_toml_document
          :summary:
   * - :py:obj:`_atomic_write_text <gmuse.config._atomic_write_text>`
     - .. autodoc2-docstring:: gmuse.config._atomic_write_text
          :summary:
   * - :py:obj:`update_config_key <gmuse.config.update_config_key>`
     - .. autodoc2-docstring:: gmuse.config.update_config_key
          :summary:
   * - :py:obj:`get_env_config <gmuse.config.get_env_config>`
     - .. autodoc2-docstring:: gmuse.config.get_env_config
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <gmuse.config.logger>`
     - .. autodoc2-docstring:: gmuse.config.logger
          :summary:
   * - :py:obj:`ConfigDict <gmuse.config.ConfigDict>`
     - .. autodoc2-docstring:: gmuse.config.ConfigDict
          :summary:
   * - :py:obj:`VALID_FORMATS <gmuse.config.VALID_FORMATS>`
     - .. autodoc2-docstring:: gmuse.config.VALID_FORMATS
          :summary:
   * - :py:obj:`HISTORY_DEPTH_MIN <gmuse.config.HISTORY_DEPTH_MIN>`
     - .. autodoc2-docstring:: gmuse.config.HISTORY_DEPTH_MIN
          :summary:
   * - :py:obj:`HISTORY_DEPTH_MAX <gmuse.config.HISTORY_DEPTH_MAX>`
     - .. autodoc2-docstring:: gmuse.config.HISTORY_DEPTH_MAX
          :summary:
   * - :py:obj:`TIMEOUT_MIN <gmuse.config.TIMEOUT_MIN>`
     - .. autodoc2-docstring:: gmuse.config.TIMEOUT_MIN
          :summary:
   * - :py:obj:`TIMEOUT_MAX <gmuse.config.TIMEOUT_MAX>`
     - .. autodoc2-docstring:: gmuse.config.TIMEOUT_MAX
          :summary:
   * - :py:obj:`TEMPERATURE_MIN <gmuse.config.TEMPERATURE_MIN>`
     - .. autodoc2-docstring:: gmuse.config.TEMPERATURE_MIN
          :summary:
   * - :py:obj:`TEMPERATURE_MAX <gmuse.config.TEMPERATURE_MAX>`
     - .. autodoc2-docstring:: gmuse.config.TEMPERATURE_MAX
          :summary:
   * - :py:obj:`MAX_TOKENS_MIN <gmuse.config.MAX_TOKENS_MIN>`
     - .. autodoc2-docstring:: gmuse.config.MAX_TOKENS_MIN
          :summary:
   * - :py:obj:`MAX_TOKENS_MAX <gmuse.config.MAX_TOKENS_MAX>`
     - .. autodoc2-docstring:: gmuse.config.MAX_TOKENS_MAX
          :summary:
   * - :py:obj:`MAX_DIFF_BYTES_MIN <gmuse.config.MAX_DIFF_BYTES_MIN>`
     - .. autodoc2-docstring:: gmuse.config.MAX_DIFF_BYTES_MIN
          :summary:
   * - :py:obj:`MAX_DIFF_BYTES_MAX <gmuse.config.MAX_DIFF_BYTES_MAX>`
     - .. autodoc2-docstring:: gmuse.config.MAX_DIFF_BYTES_MAX
          :summary:
   * - :py:obj:`MAX_MESSAGE_LENGTH_MIN <gmuse.config.MAX_MESSAGE_LENGTH_MIN>`
     - .. autodoc2-docstring:: gmuse.config.MAX_MESSAGE_LENGTH_MIN
          :summary:
   * - :py:obj:`MAX_MESSAGE_LENGTH_MAX <gmuse.config.MAX_MESSAGE_LENGTH_MAX>`
     - .. autodoc2-docstring:: gmuse.config.MAX_MESSAGE_LENGTH_MAX
          :summary:
   * - :py:obj:`MAX_CHARS_MIN <gmuse.config.MAX_CHARS_MIN>`
     - .. autodoc2-docstring:: gmuse.config.MAX_CHARS_MIN
          :summary:
   * - :py:obj:`MAX_CHARS_MAX <gmuse.config.MAX_CHARS_MAX>`
     - .. autodoc2-docstring:: gmuse.config.MAX_CHARS_MAX
          :summary:
   * - :py:obj:`CHARS_PER_TOKEN_MIN <gmuse.config.CHARS_PER_TOKEN_MIN>`
     - .. autodoc2-docstring:: gmuse.config.CHARS_PER_TOKEN_MIN
          :summary:
   * - :py:obj:`CHARS_PER_TOKEN_MAX <gmuse.config.CHARS_PER_TOKEN_MAX>`
     - .. autodoc2-docstring:: gmuse.config.CHARS_PER_TOKEN_MAX
          :summary:
   * - :py:obj:`BRANCH_MAX_LENGTH_MIN <gmuse.config.BRANCH_MAX_LENGTH_MIN>`
     - .. autodoc2-docstring:: gmuse.config.BRANCH_MAX_LENGTH_MIN
          :summary:
   * - :py:obj:`BRANCH_MAX_LENGTH_MAX <gmuse.config.BRANCH_MAX_LENGTH_MAX>`
     - .. autodoc2-docstring:: gmuse.config.BRANCH_MAX_LENGTH_MAX
          :summary:
   * - :py:obj:`DEFAULTS <gmuse.config.DEFAULTS>`
     - .. autodoc2-docstring:: gmuse.config.DEFAULTS
          :summary:
   * - :py:obj:`ALLOWED_CONFIG_KEYS <gmuse.config.ALLOWED_CONFIG_KEYS>`
     - .. autodoc2-docstring:: gmuse.config.ALLOWED_CONFIG_KEYS
          :summary:
   * - :py:obj:`ENV_VAR_BY_KEY <gmuse.config.ENV_VAR_BY_KEY>`
     - .. autodoc2-docstring:: gmuse.config.ENV_VAR_BY_KEY
          :summary:

API
~~~

.. py:data:: logger
   :canonical: gmuse.config.logger
   :value: 'get_logger(...)'

   .. autodoc2-docstring:: gmuse.config.logger

.. py:data:: ConfigDict
   :canonical: gmuse.config.ConfigDict
   :value: None

   .. autodoc2-docstring:: gmuse.config.ConfigDict

.. py:data:: VALID_FORMATS
   :canonical: gmuse.config.VALID_FORMATS
   :type: typing.Final[frozenset[str]]
   :value: 'frozenset(...)'

   .. autodoc2-docstring:: gmuse.config.VALID_FORMATS

.. py:data:: HISTORY_DEPTH_MIN
   :canonical: gmuse.config.HISTORY_DEPTH_MIN
   :type: typing.Final[int]
   :value: 0

   .. autodoc2-docstring:: gmuse.config.HISTORY_DEPTH_MIN

.. py:data:: HISTORY_DEPTH_MAX
   :canonical: gmuse.config.HISTORY_DEPTH_MAX
   :type: typing.Final[int]
   :value: 50

   .. autodoc2-docstring:: gmuse.config.HISTORY_DEPTH_MAX

.. py:data:: TIMEOUT_MIN
   :canonical: gmuse.config.TIMEOUT_MIN
   :type: typing.Final[int]
   :value: 5

   .. autodoc2-docstring:: gmuse.config.TIMEOUT_MIN

.. py:data:: TIMEOUT_MAX
   :canonical: gmuse.config.TIMEOUT_MAX
   :type: typing.Final[int]
   :value: 300

   .. autodoc2-docstring:: gmuse.config.TIMEOUT_MAX

.. py:data:: TEMPERATURE_MIN
   :canonical: gmuse.config.TEMPERATURE_MIN
   :type: typing.Final[float]
   :value: 0.0

   .. autodoc2-docstring:: gmuse.config.TEMPERATURE_MIN

.. py:data:: TEMPERATURE_MAX
   :canonical: gmuse.config.TEMPERATURE_MAX
   :type: typing.Final[float]
   :value: 2.0

   .. autodoc2-docstring:: gmuse.config.TEMPERATURE_MAX

.. py:data:: MAX_TOKENS_MIN
   :canonical: gmuse.config.MAX_TOKENS_MIN
   :type: typing.Final[int]
   :value: 1

   .. autodoc2-docstring:: gmuse.config.MAX_TOKENS_MIN

.. py:data:: MAX_TOKENS_MAX
   :canonical: gmuse.config.MAX_TOKENS_MAX
   :type: typing.Final[int]
   :value: 100000

   .. autodoc2-docstring:: gmuse.config.MAX_TOKENS_MAX

.. py:data:: MAX_DIFF_BYTES_MIN
   :canonical: gmuse.config.MAX_DIFF_BYTES_MIN
   :type: typing.Final[int]
   :value: 1000

   .. autodoc2-docstring:: gmuse.config.MAX_DIFF_BYTES_MIN

.. py:data:: MAX_DIFF_BYTES_MAX
   :canonical: gmuse.config.MAX_DIFF_BYTES_MAX
   :type: typing.Final[int]
   :value: 10000000

   .. autodoc2-docstring:: gmuse.config.MAX_DIFF_BYTES_MAX

.. py:data:: MAX_MESSAGE_LENGTH_MIN
   :canonical: gmuse.config.MAX_MESSAGE_LENGTH_MIN
   :type: typing.Final[int]
   :value: 10

   .. autodoc2-docstring:: gmuse.config.MAX_MESSAGE_LENGTH_MIN

.. py:data:: MAX_MESSAGE_LENGTH_MAX
   :canonical: gmuse.config.MAX_MESSAGE_LENGTH_MAX
   :type: typing.Final[int]
   :value: 10000

   .. autodoc2-docstring:: gmuse.config.MAX_MESSAGE_LENGTH_MAX

.. py:data:: MAX_CHARS_MIN
   :canonical: gmuse.config.MAX_CHARS_MIN
   :type: typing.Final[int]
   :value: 1

   .. autodoc2-docstring:: gmuse.config.MAX_CHARS_MIN

.. py:data:: MAX_CHARS_MAX
   :canonical: gmuse.config.MAX_CHARS_MAX
   :type: typing.Final[int]
   :value: 500

   .. autodoc2-docstring:: gmuse.config.MAX_CHARS_MAX

.. py:data:: CHARS_PER_TOKEN_MIN
   :canonical: gmuse.config.CHARS_PER_TOKEN_MIN
   :type: typing.Final[int]
   :value: 1

   .. autodoc2-docstring:: gmuse.config.CHARS_PER_TOKEN_MIN

.. py:data:: CHARS_PER_TOKEN_MAX
   :canonical: gmuse.config.CHARS_PER_TOKEN_MAX
   :type: typing.Final[int]
   :value: 10

   .. autodoc2-docstring:: gmuse.config.CHARS_PER_TOKEN_MAX

.. py:data:: BRANCH_MAX_LENGTH_MIN
   :canonical: gmuse.config.BRANCH_MAX_LENGTH_MIN
   :type: typing.Final[int]
   :value: 20

   .. autodoc2-docstring:: gmuse.config.BRANCH_MAX_LENGTH_MIN

.. py:data:: BRANCH_MAX_LENGTH_MAX
   :canonical: gmuse.config.BRANCH_MAX_LENGTH_MAX
   :type: typing.Final[int]
   :value: 200

   .. autodoc2-docstring:: gmuse.config.BRANCH_MAX_LENGTH_MAX

.. py:data:: DEFAULTS
   :canonical: gmuse.config.DEFAULTS
   :type: typing.Final[gmuse.config.ConfigDict]
   :value: None

   .. autodoc2-docstring:: gmuse.config.DEFAULTS

.. py:data:: ALLOWED_CONFIG_KEYS
   :canonical: gmuse.config.ALLOWED_CONFIG_KEYS
   :type: typing.Final[frozenset[str]]
   :value: 'frozenset(...)'

   .. autodoc2-docstring:: gmuse.config.ALLOWED_CONFIG_KEYS

.. py:data:: ENV_VAR_BY_KEY
   :canonical: gmuse.config.ENV_VAR_BY_KEY
   :type: typing.Final[dict[str, str]]
   :value: None

   .. autodoc2-docstring:: gmuse.config.ENV_VAR_BY_KEY

.. py:function:: get_config_path() -> pathlib.Path
   :canonical: gmuse.config.get_config_path

   .. autodoc2-docstring:: gmuse.config.get_config_path

.. py:function:: load_config(config_path: typing.Optional[pathlib.Path] = None) -> gmuse.config.ConfigDict
   :canonical: gmuse.config.load_config

   .. autodoc2-docstring:: gmuse.config.load_config

.. py:function:: load_config_raw(config_path: typing.Optional[pathlib.Path] = None) -> str | None
   :canonical: gmuse.config.load_config_raw

   .. autodoc2-docstring:: gmuse.config.load_config_raw

.. py:function:: parse_config_value(key: str, raw: str) -> typing.Any
   :canonical: gmuse.config.parse_config_value

   .. autodoc2-docstring:: gmuse.config.parse_config_value

.. py:function:: _validate_integer_range(config: gmuse.config.ConfigDict, key: str, min_val: int, max_val: int) -> None
   :canonical: gmuse.config._validate_integer_range

   .. autodoc2-docstring:: gmuse.config._validate_integer_range

.. py:function:: _validate_float_range(config: gmuse.config.ConfigDict, key: str, min_val: float, max_val: float) -> None
   :canonical: gmuse.config._validate_float_range

   .. autodoc2-docstring:: gmuse.config._validate_float_range

.. py:function:: _validate_string_choice(config: gmuse.config.ConfigDict, key: str, valid_choices: frozenset[str], allow_none: bool = False) -> None
   :canonical: gmuse.config._validate_string_choice

   .. autodoc2-docstring:: gmuse.config._validate_string_choice

.. py:function:: _validate_boolean(config: gmuse.config.ConfigDict, key: str) -> None
   :canonical: gmuse.config._validate_boolean

   .. autodoc2-docstring:: gmuse.config._validate_boolean

.. py:function:: _validate_optional_string(config: gmuse.config.ConfigDict, key: str) -> None
   :canonical: gmuse.config._validate_optional_string

   .. autodoc2-docstring:: gmuse.config._validate_optional_string

.. py:function:: _parse_env_int(env_var: str, config_key: str) -> tuple[str, int] | None
   :canonical: gmuse.config._parse_env_int

   .. autodoc2-docstring:: gmuse.config._parse_env_int

.. py:function:: _parse_env_float(env_var: str, config_key: str) -> tuple[str, float] | None
   :canonical: gmuse.config._parse_env_float

   .. autodoc2-docstring:: gmuse.config._parse_env_float

.. py:function:: validate_config(config: gmuse.config.ConfigDict) -> None
   :canonical: gmuse.config.validate_config

   .. autodoc2-docstring:: gmuse.config.validate_config

.. py:function:: merge_config(cli_args: typing.Optional[gmuse.config.ConfigDict] = None, config_file: typing.Optional[gmuse.config.ConfigDict] = None, env_vars: typing.Optional[gmuse.config.ConfigDict] = None) -> gmuse.config.ConfigDict
   :canonical: gmuse.config.merge_config

   .. autodoc2-docstring:: gmuse.config.merge_config

.. py:function:: _load_toml_document(config_path: pathlib.Path)
   :canonical: gmuse.config._load_toml_document

   .. autodoc2-docstring:: gmuse.config._load_toml_document

.. py:function:: _atomic_write_text(path: pathlib.Path, text: str) -> None
   :canonical: gmuse.config._atomic_write_text

   .. autodoc2-docstring:: gmuse.config._atomic_write_text

.. py:function:: update_config_key(key: str, value: typing.Any, config_path: typing.Optional[pathlib.Path] = None) -> pathlib.Path
   :canonical: gmuse.config.update_config_key

   .. autodoc2-docstring:: gmuse.config.update_config_key

.. py:function:: get_env_config() -> gmuse.config.ConfigDict
   :canonical: gmuse.config.get_env_config

   .. autodoc2-docstring:: gmuse.config.get_env_config