YamlManager

Yamlmanager

Bibliothek, um das Management und die Erstellung von JSON- und YAML -Dateien zu vereinfachen.

Funktionen:

1. to_json_file:

   • Funktion:
     • Wandelt ein Wörterbuch in eine JSONFILE um
   • Argumente:
     • json_path - Eine String oder eine JSONFILE , Ort der JSONFILE
     • dictionary - die Daten, die die JSONFILE haben sollte
   • Optionale Argumente:
     • save - ob die JSONFILE gespeichert (erstellt oder geändert) werden sollte, sobald die Daten dem Wörterbuch entsprechen
   • Rückgaben:
     • Eine JSONFILE in json_path

2. JSON_FILE_TO_DICT:

   • Funktion:
     • Konvertiert die Daten von einer JSONFILE in ein Wörterbuch
   • Argumente:
     • json_path - Eine String oder eine JSONFILE , Ort der JSONFILE
   • Rückgaben:
     • Ein Wörterbuch , das alle Daten aus der JSONFILE enthält

3. JSON_FILE_TO_YAML_FILE:

   • Funktion:
     • Konvertiert die Daten von einer JSONFILE in ein Yamlfile
   • Argumente:
     • json_path - Eine String oder eine JSONFILE , Ort der JSONFILE
     • yaml_path - eine Zeichenfolge oder eine Yamlfile , Ort der Yamlfile
   • Optionale Argumente:
     • save - ob das YAMLFILE gespeichert (erstellt oder geändert) werden sollte, sobald die Daten mit der JSON -Datei übereinstimmen
   • Rückgaben:
     • Ein Yamlfile in yaml_path

4. to_yaml_file:

   • Funktion:
     • Wandelt ein Wörterbuch in ein Yamlfile um
   • Argumente:
     • yaml_path - eine Zeichenfolge oder eine Yamlfile , Ort der Yamlfile
     • dictionary - die Daten, die das Yamlfile haben sollte
   • Optionale Argumente:
     • save - ob das YAMLFILE gespeichert (erstellt oder geändert) werden sollte, sobald die Daten dem Wörterbuch entsprechen
   • Rückgaben:
     • Ein Yamlfile in yaml_path

5. yaml_file_to_dict:

   • Funktion:
     • Konvertiert die Daten von einem Yamlfile in ein Wörterbuch
   • Argumente:
     • yaml_path - eine Zeichenfolge oder eine Yamlfile , Ort der Yamlfile
   • Rückgaben:
     • Ein Wörterbuch , das alle Daten aus dem Yamlfile enthält

6. yaml_file_to_json_file:

   • Funktion:
     • Konvertiert die Daten von einem Yamlfile in eine JSON -Datei
   • Argumente:
     • yaml_path - eine Zeichenfolge oder eine Yamlfile , Ort der Yamlfile
     • json_path - Eine String oder eine JSONFILE , Ort der JSONFILE
   • Optionale Argumente:
     • save - ob die JSON -Datei gespeichert (erstellt oder geändert) werden sollte, sobald die Daten mit der Yamlfile entsprechen
   • Rückgaben:
     • Eine JSONFILE in json_path

Klassen / Objekte

Yamlfile

• Beschreibung:
  • Stellt eine YAML -Datei dar und bietet Methoden zur Manipulation ihrer Daten.
• Methoden:
  • load() : Laden Sie die YAML -Dateidaten.
  • save() : Speichert die aktuellen Daten in der YAML -Datei.

JSONFILE

• Beschreibung:
  • Repräsentiert eine JSON -Datei und bietet Methoden zur Manipulation ihrer Daten.
• Methoden:
  • load() : Laden Sie die JSON -Dateidaten.
  • save() : Speichert die aktuellen Daten in der JSON -Datei.

Filecontroller

• Beschreibung:
  • Stellt einen abstrakten Dateicontroller dar und bietet Methoden zur Manipulation von Dateidaten.
• Methoden:
  • __init__(file_path: str) : Initialisiert die FileController -Instanz mit dem Dateipfad.
  • reload() : Abstract -Methode zum Laden von Daten aus der Datei. Muss durch Unterklassen implementiert werden.
  • save() : Abstract -Methode zum Speichern von Daten in der Datei. Muss durch Unterklassen implementiert werden.
  • contains(key: str) -> bool : Überprüft, ob im Datenwörterbuch ein Schlüssel vorhanden ist.
  • set(key: str, value: any) -> None : Setzt, verändert oder löscht Werte in der Konfiguration.
  • string(key: str, default_value: str | None = None) -> str | None : Ruft aus den Daten einen Zeichenfolgenwert ab.
  • float(key: str, default_value: float | int | None = None) -> float | None : Ruft aus den Daten einen Float -Wert ab.
  • int(key: str, default_value: int | None = None) -> int | None : Erhält einen ganzzahligen Wert aus den Daten.
  • boolean(key: str, default_value: bool | None = None) -> bool | None : Erhält einen Booleschen Wert aus den Daten.
  • str_list(key: str, default_value: list[str] | None = None) -> list[str] | None : Holen Sie sich eine Liste von Zeichenfolgen aus den Daten.
  • float_list(key: str, default_value: list[float | int] | None = None) -> list[float] | None : Holen Sie sich eine Liste von Float -Werten aus den Daten.
  • int_list(key: str, default_value: list[int | float] | None = None) -> list[int] | None : Holen Sie sich eine Liste von Ganzzahlwerten aus den Daten.
  • bool_list(key: str, default_value: list[bool] | None = None) -> list[bool] | None : Holen Sie sich eine Liste von booleschen Werten aus den Daten.
  • dictionary(key: str, default_value: dict | None = None) -> dict | None : Erholt ein Wörterbuch aus den Daten.