hpcflow.sdk.config.config.ConfigOptions

class hpcflow.sdk.config.config.ConfigOptions(default_directory, directory_env_var, default_config=<factory>, extra_schemas=<factory>, default_known_configs_dir=None)

Bases: object

Application-level options for configuration

Methods

init_schemas	Get allowed configurable keys from config schemas.
validate	Validate configuration items of the loaded invocation.

Attributes

default_known_configs_dir	Default directory of known configurations.
default_directory	The default directory.
directory_env_var	The environment variable containing the directory name.
default_config	The default configuration.
extra_schemas	Any extra schemas to apply.

Parameters:

• default_directory (Path | str) –

• directory_env_var (str) –

• default_config (DefaultConfiguration) –

• extra_schemas (Sequence[Schema]) –

• default_known_configs_dir (str | None) –

default_config: DefaultConfiguration

The default configuration.

default_directory: Path | str

The default directory.

default_known_configs_dir: str | None = None

Default directory of known configurations.

directory_env_var: str

The environment variable containing the directory name.

extra_schemas: Sequence[Schema]

Any extra schemas to apply.

init_schemas()

Get allowed configurable keys from config schemas.

Return type:

tuple[Sequence[Schema], Sequence[str]]

validate(data, logger, metadata=None, raise_with_metadata=True)

Validate configuration items of the loaded invocation.

Parameters:

• data (T) –

• logger (logging.Logger) –

• metadata (ConfigMetadata | None) –

• raise_with_metadata (bool) –

Return type:

T