hyrax.config_utils

Attributes

DEFAULT_CONFIG_FILEPATH
DEFAULT_USER_CONFIG_FILEPATH
logger

Classes

ConfigDict	The purpose of this class is to ensure key errors on config dictionaries return something helpful.
ConfigManager	A class to manage the runtime configuration for a Hyrax object. This class

Functions

config_help(config, *args)	A simple config help function. It's a bit difficult to parse through
find_keys(config, key_name)	Recursively find all keys in a nested dictionary that match the given key name.
create_results_dir(→ pathlib.Path)	Creates a results directory for this run.
find_most_recent_results_dir(→ Optional[pathlib.Path])	Find the most recent results directory corresponding to a particular verb
log_runtime_config(runtime_config, output_path[, ...])	Log a runtime configuration.

Module Contents

DEFAULT_CONFIG_FILEPATH

DEFAULT_USER_CONFIG_FILEPATH

logger

class ConfigDict(*args, **kwargs)

Bases: dict

The purpose of this class is to ensure key errors on config dictionaries return something helpful. and to discourage mutation actions on config dictionaries that should not happen at runtime.

Initialize self. See help(type(self)) for accurate signature.

__slots__ = ()

__missing__(key)

get(key, default=None)

Nonfunctional stub of dict.get() which errors always. Overriding this prevents the possibility of defining default values in code that conflict with default values defined in the config file.

__delitem__(key)

Delete self[key].

pop(key, default)

Nonfunctional stub of dict.pop() which errors always

popitem()

Nonfunctional stub of dict.popitem() which errors always

clear()

Nonfunctional stub of dict.clear() which errors always

config_help(config: tomlkit.toml_document.TOMLDocument, *args)

A simple config help function. It’s a bit difficult to parse through the Tomlkit Table to print just one item such that it would include the comments preceding it.

For now, we support the following cases, and generally print out the entire table for the given key.

Cases: - if no args, prints the whole config. - if args[0] is a table name, print the whole table - if args[0] is not a table, assume it’s a key and search – print each one of the tables that it is found in.

Parameters:

• config (TOMLDocument) – A configuration dictionary that will be used to search for specified tables and keys.

• args (str) – A variable number of string arguments that specify the table name or key to search for in the configuration dictionary.

find_keys(config: dict[str, Any], key_name: str)

Recursively find all keys in a nested dictionary that match the given key name.

Parameters:

• config (dict) – The nested dictionary to search.

• key_name (str) – The name of the key to find.

Returns:

A list of matching keys.

Return type:

list

class ConfigManager(runtime_config_filepath: pathlib.Path | str | None = None, default_config_filepath: pathlib.Path | str = DEFAULT_CONFIG_FILEPATH)

A class to manage the runtime configuration for a Hyrax object. This class will contain all the logic and methods for reading, merging, and validating the runtime configuration.

_called_from_test = False

Hardcoded set of config keys which definitionally contain paths, and we resolve to global paths during initialization in ConfigManager._resolve_config_paths().

PATH_CONFIG_KEYS = [['data_set', 'filter_catalog'], ['general', 'data_dir']]

hyrax_default_config: tomlkit.toml_document.TOMLDocument

runtime_config_filepath = None

external_library_config_paths

overall_default_config

config

static read_runtime_config(config_filepath: pathlib.Path | str = DEFAULT_CONFIG_FILEPATH) → tomlkit.toml_document.TOMLDocument

Read a single toml file and return a ConfigDict

Parameters:

config_filepath (Union[Path, str], optional) – The path to the config file, by default DEFAULT_CONFIG_FILEPATH

Returns:

The contents of the toml file as a tomlkit.TOMLDocument

Return type:

TOMLDocument

static _find_external_library_default_config_paths(runtime_config: dict) → set

Search for external libraries in the runtime configuration and gather the libpath specifications so that we can load the default configs for the libraries.

Parameters:

runtime_config (dict) – The runtime configuration as a tomlkit.TOMLDocument.

Returns:

A tuple containing the default configuration Paths for the external libraries that are requested in the users configuration file.

Return type:

set

_merge_defaults()

Merge the default configurations from the hyrax and external libraries.

static merge_configs(default_config: dict, overriding_config: dict) → dict

Merge two ConfigDicts with the overriding_config values overriding the default_config values.

Parameters:

• default_config (dict) – The default configuration.

• overriding_config (dict) – The new configuration values to be merged into default_config.

Returns:

The merged configuration.

Return type:

dict

static _validate_runtime_config(runtime_config: dict, default_config: dict)

Recursive helper to check that all keys in runtime_config have a default in the merged default_config.

The two arguments passed in must represent the same nesting level of the runtime config and all default config parameters respectively.

Parameters:

• runtime_config (ConfigDict) – Nested config dictionary representing the runtime config.

• default_config (ConfigDict) – Nested config dictionary representing the defaults

Raises:

RuntimeError – Raised if any config that exists in the runtime config does not have a default defined in default_config

static _resolve_config_paths(runtime_config: dict) → None

Convert all paths in a runntime config to global paths in the current environment. Uses the hardcoded list of paths in ConfigManager.PATH_CONFIG_KEYS

This mutates the config dictionary passed.

Parameters:

runtime_config (dict) – Current runtime config nested dictionary

static resolve_runtime_config(runtime_config_filepath: pathlib.Path | str | None = None) → pathlib.Path

Resolve a user-supplied runtime config to where we will actually pull config from.

1. If a runtime config file is specified, we will use that file.

2. If no file is specified and there is a file named “hyrax_config.toml” in the cwd we will use it.

3. If no file is specified and there is no file named “hyrax_config.toml” in the cwd we will exclusively work off the configuration defaults in the packaged “hyrax_default_config.toml” file.

Parameters:

runtime_config_filepath (Union[Path, str, None], optional) – Location of the supplied config file, by default None

Returns:

Path to the configuration file ultimately used for config resolution. When we fall back to the package supplied default config file, the Path to that file is returned.

Return type:

Path

create_results_dir(config: ConfigDict, postfix: str) → pathlib.Path

Creates a results directory for this run.

Postfix is the verb name of the run e.g. (infer, train, etc)

The directory is created within the results dir (set with config results_dir) and follows the pattern <timestamp>-<postfix>

The resulting directory is returned.

Parameters:

• config (ConfigDict) – The full runtime configuration for this run

• postfix (str) – The verb name of the run.

Returns:

The path created by this function

Return type:

Path

find_most_recent_results_dir(config: ConfigDict, verb: str) → pathlib.Path | None

Find the most recent results directory corresponding to a particular verb This is a best effort search in the currently configured results root.

If result directories are created within 1 second of one another this function will return one of the directories but it is undefined which one it will return.

This function may return None indicating it could not find a directory matching the query verb

log_runtime_config(runtime_config: ConfigDict, output_path: pathlib.Path, file_name: str = 'runtime_config.toml')

Log a runtime configuration.

Parameters:

• runtime_config (ConfigDict) – A ConfigDict object containing runtime configuration values.

• output_path (str) – The path to put the config file

• file_name (str, Optional) – Optional name for the config file, defaults to “runtime_config.toml”