paidiverpy.config.config_params

Configuration parameters module.

Classes

ConfigParams

Configuration parameters using Pydantic.

Module Contents

class paidiverpy.config.config_params.ConfigParams

Bases: paidiverpy.utils.base_model.BaseModel

Configuration parameters using Pydantic.

Fields:

input_path (Path): The input path. output_path (Path): The output path. image_open_args (str): The image type. metadata_path (Path): The metadata path. metadata_type (str): The metadata type. track_changes (bool): Whether to track changes. Defaults to True. n_jobs (int): Number of jobs. Defaults to 1.

classmethod validate_required_keys(values: dict[str, Any]) → dict[str, Any]

Validate the required keys in the configuration parameters.

Parameters:

values (dict) – The values to validate.

Raises:

ValueError – If any of the required keys are missing.

Returns:

The validated values.

Return type:

dict