romtools.hpc.configuration#

Functions

option_name(arg_name)

The command-line switch for a schema argument, e.g. "--hpc-remote-root".

print_help()

Print the dispatcher's configuration arguments.

Classes

Configuration([config_path])

Handles parsing a yaml file and any supplied command-line args.

Exceptions

ConfigurationError

Raised when the command line cannot be parsed against SCHEMA.
class romtools.hpc.configuration.Configuration(config_path=None)[source]#

Bases: object

Handles parsing a yaml file and any supplied command-line args.

Precedence:

  1. CLI args (overwrite YAML)

  2. YAML file values (if provided)

  3. Class defaults

Parameters:

config_path (str | None) – Path to the YAML file to load. When omitted, the path is taken from -c or –hpc-config on this program’s command line.

classmethod defaults()[source]#

Schema defaults, reading neither a YAML file nor the command line.

Return type:

Configuration

exception romtools.hpc.configuration.ConfigurationError[source]#

Bases: Exception

Raised when the command line cannot be parsed against SCHEMA.

romtools.hpc.configuration.option_name(arg_name)[source]#

The command-line switch for a schema argument, e.g. “–hpc-remote-root”.

Parameters:

arg_name (str)

Return type:

str

romtools.hpc.configuration.print_help()[source]#

Print the dispatcher’s configuration arguments.

Return type:

None