gpf_generate_archive.core module

Main module logic.

gpf_generate_archive.core.check_crs(uploads: list[GpfUpload], output_stored_data: GpfStoredData) Status

Vérifie les SRS des livraisons et, le cas échéant, de la sortie.

Paramètres:
  • uploads (List[GpfUpload]) – liste des livraisons.

  • output_stored_data (GpfStoredData) – output stored data

Renvoie:

FAILURE s’il y a des srs différents ou que les srs de l’entrée et de la sortie diffèrent

SUCCESS sinon

Type renvoyé:

Status

gpf_generate_archive.core.get_file_information(file_name: Path, output_stored_data: GpfStoredData, srs: str) FileInformations

Retourne les informations d’une livraison

Paramètres:
  • file_name (Path) – Le fichier en entrée.

  • output_stored_data (GpfStoredData) – output stored data

  • srs (string) – srs de l’upload

Renvoie:

dataclass avec les informations sur le fichier

Type renvoyé:

FileInformations

gpf_generate_archive.core.get_information(upload_dir: Path, output_stored_data: GpfStoredData, srs: str) list[FileInformations]

Retourne les informations d’une livraison.

Paramètres:
  • upload_dir (Path) – Répertoire d’un upload

  • output_stored_data (GpfStoredData) – output stored data

  • srs (string) – srs de l’upload

Renvoie:

une liste de dataclass avec les informations sur le fichier

Type renvoyé:

list[FileInformations]

gpf_generate_archive.core.run(work_dir: Path, parameters: GpfOrchestratorParameters) Status

Main function running the logic.

Paramètres:
  • work_dir (Path) – Input working directory. The folder must exist.

  • parameters (GpfOrchestratorParameters) – Processing parameters

Renvoie:

statut de la génération de l’archive

Type renvoyé:

Status

gpf_generate_archive.core.upload_file_to_s3(input_dir: Path, s3_client: GpfS3Client) None

Retourne les informations d’une livraison

Paramètres:
  • input_dir (Path) – Répertoire à upload dans S3

  • s3_client (GpfS3Client) – client S3 associé à la stored data de sortie