YamlManager

Yamlmanager

Bibliothèque pour simplifier la gestion et la création de fichiers JSON et YAML.

Fonctions:

1. to_json_file:

   • Fonction:
     • Convertit un dictionnaire en jsonfile
   • Arguments:
     • json_path - Une chaîne ou un JSONfile , emplacement du Jsonfile
     • dictionary - les données que le JsonFile devrait avoir
   • Arguments facultatifs:
     • save - si le JSONFile doit être enregistré (créé ou modifié) dès que les données correspondent au dictionnaire
   • Renvoie:
     • Un Jsonfile situé à json_path

2. JSON_FILE_TO_DICT:

   • Fonction:
     • Convertit les données d'un JSONFile en dictionnaire
   • Arguments:
     • json_path - Une chaîne ou un JSONfile , emplacement du Jsonfile
   • Renvoie:
     • Un dictionnaire contenant toutes les données du JSONfile

3. JSON_FILE_TO_YAML_FILE:

   • Fonction:
     • Convertit les données d'un JSONFile à un yamlfile
   • Arguments:
     • json_path - Une chaîne ou un JSONfile , emplacement du Jsonfile
     • yaml_path - une chaîne ou un yamlfile , emplacement du yamlfile
   • Arguments facultatifs:
     • save - si le yamlfile doit être enregistré (créé ou modifié) dès que les données correspondent au JSONfile
   • Renvoie:
     • Un yamlfile situé à yaml_path

4. to_yaml_file:

   • Fonction:
     • Convertit un dictionnaire en yamlfile
   • Arguments:
     • yaml_path - une chaîne ou un yamlfile , emplacement du yamlfile
     • dictionary - les données que le yamlfile devrait avoir
   • Arguments facultatifs:
     • save - si le yamlfile doit être enregistré (créé ou modifié) dès que les données correspondent au dictionnaire
   • Renvoie:
     • Un yamlfile situé à yaml_path

5. yaml_file_to_dict:

   • Fonction:
     • Convertit les données d'un yamlfile à un dictionnaire
   • Arguments:
     • yaml_path - une chaîne ou un yamlfile , emplacement du yamlfile
   • Renvoie:
     • Un dictionnaire contenant toutes les données du yamlfile

6. yaml_file_to_json_file:

   • Fonction:
     • Convertit les données d'un yamlfile en jsonfile
   • Arguments:
     • yaml_path - une chaîne ou un yamlfile , emplacement du yamlfile
     • json_path - Une chaîne ou un JSONfile , emplacement du Jsonfile
   • Arguments facultatifs:
     • save - si le JSONFile doit être enregistré (créé ou modifié) dès que les données correspondent au yamlfile
   • Renvoie:
     • Un Jsonfile situé à json_path

Classes / objets

Yamlfile

• Description:
  • Représente un fichier YAML et fournit des méthodes pour manipuler ses données.
• Méthodes:
  • load() : charge les données du fichier YAML.
  • save() : enregistre les données actuelles dans le fichier YAML.

Jsonfile

• Description:
  • Représente un fichier JSON et fournit des méthodes pour manipuler ses données.
• Méthodes:
  • load() : charge les données du fichier JSON.
  • save() : enregistre les données actuelles dans le fichier JSON.

File de file

• Description:
  • Représente un contrôleur de fichiers abstrait et fournit des méthodes pour manipuler les données de fichiers.
• Méthodes:
  • __init__(file_path: str) : initialise l'instance FileController avec le chemin du fichier.
  • reload() : méthode abstraite pour charger les données du fichier. Doit être implémenté par sous-classes.
  • save() : Méthode abstraite pour enregistrer les données dans le fichier. Doit être implémenté par sous-classes.
  • contains(key: str) -> bool : vérifie si une clé existe dans le dictionnaire de données.
  • set(key: str, value: any) -> None : définit, modifie ou supprime les valeurs dans la configuration.
  • string(key: str, default_value: str | None = None) -> str | None : obtient une valeur de chaîne à partir des données.
  • float(key: str, default_value: float | int | None = None) -> float | None : obtient une valeur flottante à partir des données.
  • int(key: str, default_value: int | None = None) -> int | None : obtient une valeur entière à partir des données.
  • boolean(key: str, default_value: bool | None = None) -> bool | None : obtient une valeur booléenne à partir des données.
  • str_list(key: str, default_value: list[str] | None = None) -> list[str] | None : obtient une liste de chaînes à partir des données.
  • float_list(key: str, default_value: list[float | int] | None = None) -> list[float] | None : obtient une liste des valeurs de flotteur à partir des données.
  • int_list(key: str, default_value: list[int | float] | None = None) -> list[int] | None : obtient une liste de valeurs entières à partir des données.
  • bool_list(key: str, default_value: list[bool] | None = None) -> list[bool] | None : obtient une liste des valeurs booléennes à partir des données.
  • dictionary(key: str, default_value: dict | None = None) -> dict | None : obtient un dictionnaire des données.