gpf_check_pyramide_rok4.core module

Main module logic.

gpf_check_pyramide_rok4.core.check_filename_format(filename: str) → bool

Fonction qui vérifie si le nom du fichier respecte le format attendu, à savoir

DATA_${level}_${column}_${row}.tif.

Paramètres:

filename (str) – nom du fichier à vérifier

Renvoie:

True si format est respecté, False sinon

Type renvoyé:

bool

gpf_check_pyramide_rok4.core.check_upload_parameters(parameters: GpfOrchestratorParameters) → bool

Fonction qui vérifie que les paramètres de la livraison sont complets.

Paramètres:

parameters (GpfOrchestratorParameters) – liste des uploads contenus dans le fichier de paramètres.

Renvoie:

True si les paramètres de la livraison sont complets, False sinon

Type renvoyé:

bool

gpf_check_pyramide_rok4.core.get_tms_level(level: str, tiles: list[dict]) → dict | None

Retourne la tuile à un certain niveau de la pyramide.

Paramètres:

• level (str) – niveau dans la pyramide

• tiles (list[dict]) – liste de tuiles

Renvoie:

tuile

Type renvoyé:

dict

gpf_check_pyramide_rok4.core.is_tms_element(tms_id: str, level: str, column: int, row: int) → bool

Fonction qui teste si les paramètres correspondent à un élément possible du TMS.

Paramètres:

• tms_id (str) – identifiant du TMS

• level (str) – niveau dans la pyramide

• column (int) – numéro de colonne dans la tuile

• row (int) – numéro de ligne dans la tuile

Renvoie:

True si les paramètres correspondent à un élément possible du TMS, False sinon

Type renvoyé:

bool

gpf_check_pyramide_rok4.core.run(upload_dir_paths: dict, parameters: GpfOrchestratorParameters, ignored_file_extensions: Iterable = ['md5']) → tuple[Status, dict]

Main function running the logic.

Paramètres:

• upload_dir_paths (dict) – Dict of (_id, path) with path where data for upload _id are

• parameters (GpfOrchestratorParameters) – parameters from the configuration file

• upload_dir_name (str, optional) – Name (not the path) of the upload directory. Defaults to « upload ».

• ignored_file_extensions (Iterable, optional) – List of ignored file extensions. Defaults to (« md5 »).

Renvoie:

status of the whole execution, and status of each files

Type renvoyé:

Tuple[Status, dict]