Functions

List of functions in the ude.config namespace.

Entity Name	Description
resolve_global_config_paths	Resolves the `cache_root_dir` / `global_templates_dir` keys of a global-config mapping to absolute paths relative to base_dir. All other keys are left untouched.
validate_groups_config	Validates a merged [groups] mapping against GroupsConfig immediately after the 3-tier cascade resolves, raising UdeException on any key outside the schema.
apply_global_cfg_env	Injects cfg.doxygen_path (resolved to an absolute path) into os.environ[‘PATH’].
logging_setup	Configure the root UDE logger. Safe to call multiple times (clears handlers).

Generated with Flude

Directory & Entity Index

Entity Name Summary / Description

apply_global_cfg_env function

Injects cfg.doxygen_path (resolved to an absolute path) into os.environ[‘PATH’].

Methods

apply_global_cfg_env

apply_global_cfg_env(cfg: GlobalConfig)

Injects cfg.doxygen_path (resolved to an absolute path) into os.environ[‘PATH’].

Parameter	Type	Description
cfg	`GlobalConfig`	The active GlobalConfig instance.

Generated with Flude

logging_setup function

Configure the root UDE logger. Safe to call multiple times (clears handlers).

Methods

logging_setup

logging_setup(cfg: GlobalConfig)

Configure the root UDE logger. Safe to call multiple times (clears handlers).

Parameter	Type	Description
cfg	`GlobalConfig`	The active GlobalConfig instance (supplies log_level / log_file).

Generated with Flude

resolve_global_config_paths function

Resolves the cache_root_dir / global_templates_dir keys of a global-config mapping to absolute paths relative to base_dir. All other keys are left untouched.

This is the single implementation of that resolution rule; both GlobalConfig.resolve_paths() and callers holding a raw (unvalidated) global-config dict route through it.

Returns:

A shallow copy of data with cache_root_dir / global_templates_dir

Methods

resolve_global_config_paths

resolve_global_config_paths(data: dict, base_dir: Union) -> dict

Resolves the cache_root_dir / global_templates_dir keys of a global-config mapping to absolute paths relative to base_dir. All other keys are left untouched.

validate_groups_config function

Validates a merged [groups] mapping against GroupsConfig immediately after the 3-tier cascade resolves, raising UdeException on any key outside the schema.

Raises: UdeException: If groups contains a key outside the GroupsConfig schema.

Returns:

The input mapping unchanged on success (validation only — no normalization),

Methods

validate_groups_config

validate_groups_config(groups: dict) -> dict

Validates a merged [groups] mapping against GroupsConfig immediately after the 3-tier cascade resolves, raising UdeException on any key outside the schema.