Validations

Module to define specific validations in Haddock3.

haddock.gear.validations.v_rundir(rundir: str | Path) → None

Validate string defining the run directory.

haddock.gear.validations.validate_defaults_yaml(yaml_fpath: str | Path) → None

Validate a defaults.yaml file.

Parameters:

yaml_fpath (str) – Path to the defaults.yaml file to validate.

haddock.gear.validations.validate_parameter_scheme(param_name: str, parameters: dict[str, Any]) → None

Validate a parameter scheme.

Parameters:

• param_name (str) – Name of this parameter.

• parameters (dict[str, Any]) – Dictionary of param, value for this parameter.

haddock.gear.validations.validate_yaml_params_scheme(yaml_fpath: str | Path) → None

Validate a defaults.yaml file module parameters schemes.

Parameters:

yaml_fpath (str) – Path to the defaults.yaml file to check.