qgis_deployment_toolbelt.exceptions module

Custom exceptions.

exception qgis_deployment_toolbelt.exceptions.JobOptionBadName(job_id: str, bad_option_name: str, expected_options_names: Iterable[str])

Bases: KeyError

When a job reveives an option which is not part of accepted ones.

__init__(job_id: str, bad_option_name: str, expected_options_names: Iterable[str])

Initialization method.

Parameters:

  • job_id (str) – job ID

  • bad_option_name (str) – name of bad option passed

  • expected_options_names (Iterable[str]) – _description_

exception qgis_deployment_toolbelt.exceptions.JobOptionBadValue(job_id: str, bad_option_name: str, bad_option_value: str, condition: str, accepted_values: Iterable[str])

Bases: ValueError

When a job’s option reveives a value which does not complies with condition.

__init__(job_id: str, bad_option_name: str, bad_option_value: str, condition: str, accepted_values: Iterable[str])

Initialization method.

Parameters:

  • job_id (str) – job ID

  • bad_option_name (str) – name of bad option passed

  • bad_option_type (str) – name of bad option passed

  • condition (str) – condition

  • accepted_values (Iterable[str]) – accepted types of values

exception qgis_deployment_toolbelt.exceptions.JobOptionBadValueType(job_id: str, bad_option_name: str, bad_option_value: str, expected_option_type: Iterable[str])

Bases: TypeError

When a job reveives an option which is not of the expected type.

__init__(job_id: str, bad_option_name: str, bad_option_value: str, expected_option_type: Iterable[str])

Initialization method.

Parameters:

  • job_id (str) – job ID

  • bad_option_name (str) – name of bad option passed

  • bad_option_value (str) – option’s value

  • expected_option_type (Iterable[str]) – accepted types of values

exception qgis_deployment_toolbelt.exceptions.QgisInstallNotFound

Bases: Exception

When no QGIS installation are found.

__init__()

Initialization method.

exception qgis_deployment_toolbelt.exceptions.SplashScreenBadDimensions(image_filepath: Path, profile_name: str | None = None)

Bases: Exception

When splash screen image does not comply with recomended dimensions.

__init__(image_filepath: Path, profile_name: str | None = None)

Initialization method.

Parameters:

  • image_filepath (Path) – path to the selected image to be set as splash screen

  • profile_name (str, optional) – name of profile. Defaults to None.