wf_psf.utils.configs_handler

Configs_Handler Registry.

Provides runtime dispatch for config handlers based on config file names.

Functions

`get_run_config`(run_config_name, *config_params)	Get Run Configuration Instance.
`register_configclass`(config_class)	Register Config Class.
`set_run_config`(config_name)	Set Run Configuration Class.

Classes

Abstract base class for all config handlers.

Exceptions

Custom Config Parameter Error exception class for specific error scenarios.

class wf_psf.utils.configs_handler.ConfigHandler[source]

Bases: ABC

Abstract base class for all config handlers.

Methods

Execute the configured task.

exception wf_psf.utils.configs_handler.ConfigParameterError(message='An error with your config settings occurred.')[source]

Custom Config Parameter Error exception class for specific error scenarios.

wf_psf.utils.configs_handler.get_run_config(run_config_name, *config_params)[source]

Get Run Configuration Instance.

A function to retrieve an instance of the appropriate configuration class for a WF-PSF run.

Parameters:

run_config_name (str) – Name of the run configuraton
*config_params (str) – Run configuration parameters used for class instantiation.

Returns:

config_class – A class instance of the selected configuration class.

Return type:

object

wf_psf.utils.configs_handler.register_configclass(config_class)[source]

Register Config Class.

A wrapper function to register all config classes in a dictionary.

wf_psf.utils.configs_handler.set_run_config(config_name)[source]

Set Run Configuration Class.

A function to retrieve the appropriate configuration class based on the provided config name.