Framework for Python

Workflow

configure_global()

Read or update the global settings.

Usage

configure_global(
    settings: dict[str, Any] | None = None,
    *,
    validate: bool = True,
) -> dict[str, Any]

Arguments

Name Type Default Description
settings dict[str, Any] | None None

Values to merge into the global settings, such as {"author": {"name": "Ada Lovelace"}}. Nested mappings merge, except defaults.packages, defaults.connections, defaults.env, and each project type's directories, which are replaced. Without settings, nothing changes.

validate bool True

Check the values before saving. Secrets in defaults.env are refused.

Value

The global settings after the update.