paidiverpy.models.general_config

paidiverpy.models.general_config#

Configuration module.

Classes#

GeneralConfig

General configuration class.

Module Contents#

class paidiverpy.models.general_config.GeneralConfig[source]#

Bases: paidiverpy.utils.base_model.BaseModel

General configuration class.

This class is used to define the general configuration from the configuration file

or from the input from the user.

classmethod validate_fields(values: dict[str, Any]) → dict[str, Any][source]#

Validate the fields of the configuration.

Parameters:

values (dict) – The values to validate.

Returns:

The validated values.

Return type:

dict

check_required_fields() → GeneralConfig[source]#

Ensure output_path is provided and either sample_data or input_path is set.

update(**updates: dict[str, Any]) → GeneralConfig[source]#

Update the model in-place with new values.