core.configuration

Parse configuration options and set them to be used throughout the Jobmon Architecture.

Attributes

DEFAULTS_FILE_NAME
DEFAULTS_FILE
ENV_VAR_PREFIX

Classes

JobmonConfig	Default config setup using YAML.
ConfigCLI	Client command line interface for update the config.

Functions

main(→ None)

Create CLI.

Module Contents

core.configuration.DEFAULTS_FILE_NAME = 'defaults.yaml'

core.configuration.DEFAULTS_FILE

core.configuration.ENV_VAR_PREFIX = 'JOBMON__'

class core.configuration.JobmonConfig(filepath: str = '', dict_config: Dict | None = None)

Default config setup using YAML.

_dict_config

_merge_dicts(base: Dict, override: Dict) → Dict

Utility function to merge two dictionaries.

_get_env_var_name(section: str, key: str) → str

_get_environment_variable(section: str, key: str) → str | None

_interpolate_env_vars(value: Any) → Any

_get_yaml_variable(section: str, key: str) → str | None

_get_dict_config_variable(section: str, key: str) → str | None

_wrapped_get(section: str, key: str) → str

get(section: str, key: str) → str

Get the configuration value for the section and key. Raise if key not found.

Parameters:

• section – the section of the yaml to search.

• key – the key within the section to retrieve

Raises: ConfigError

get_section(section: str) → Dict[str, Any]

Returns a dictionary of all key-value pairs in the given section.

The order of precedence: dict_config > Environment Variable > YAML File.

get_boolean(section: str, key: str) → bool

Get the configuration value for the section and key as bool.

Raise if key not found.

get_int(section: str, key: str) → int

Get the configuration value for the section and key as int.

Raise if key not found.

get_float(section: str, key: str) → float

Get the configuration value for the section/key as float. Raise if key not found.

set(section: str, key: str, val: str) → None

Set the configuration value for the section/key.

write(filepath: str | pathlib.Path = '') → None

Persist the current config to disk.

class core.configuration.ConfigCLI

Bases: jobmon.core.cli.CLI

Client command line interface for update the config.

_subparsers

static update_config(args: argparse.Namespace) → None

Update .jobmon.ini.

Parameters:

args – only –web_service_fqdn –web_service_port are expected.

_add_update_config_subparser() → None

core.configuration.main(argstr: str | None = None) → None

Create CLI.