YamlManager

Ямлманагер

Библиотека для упрощения управления и создания файлов JSON и YAML.

Функции:

1. to_json_file:

   • Функция:
     • Преобразует словарь в jsonfile
   • Аргументы:
     • json_path - строка или jsonfile , местоположение Jsonfile
     • dictionary - данные, которые должен иметь jsonfile
   • Необязательные аргументы:
     • save - следует ли сохранить (создано или изменено JSONFile , как только данные соответствуют словару
   • Возвращает:
     • Jsonfile , расположенный в json_path

2. json_file_to_dict:

   • Функция:
     • Преобразует данные из jsonfile в словарь
   • Аргументы:
     • json_path - строка или jsonfile , местоположение Jsonfile
   • Возвращает:
     • Словарь, содержащий все данные из jsonfile

3. json_file_to_yaml_file:

   • Функция:
     • Преобразует данные из jsonfile в yamlfile
   • Аргументы:
     • json_path - строка или jsonfile , местоположение Jsonfile
     • yaml_path - строка или yamlfile , расположение Yamlfile
   • Необязательные аргументы:
     • save - следует ли сохранить ямлфиль (создан или изменен), как только данные соответствуют jsonfile
   • Возвращает:
     • Yamlfile, расположенный в yaml_path

4. to_yaml_file:

   • Функция:
     • Преобразует словарь в yamlfile
   • Аргументы:
     • yaml_path - строка или yamlfile , расположение Yamlfile
     • dictionary - данные, которые должен был иметь у Yamlfile
   • Необязательные аргументы:
     • save - будь то yamlfile быть сохранен (создан или изменен), как только данные соответствуют словару
   • Возвращает:
     • Yamlfile, расположенный в yaml_path

5. yaml_file_to_dict:

   • Функция:
     • Преобразует данные из Yamlfile в словарь
   • Аргументы:
     • yaml_path - строка или yamlfile , расположение Yamlfile
   • Возвращает:
     • Словарь, содержащий все данные из Yamlfile

6. yaml_file_to_json_file:

   • Функция:
     • Преобразует данные из yamlfile в jsonfile
   • Аргументы:
     • yaml_path - строка или yamlfile , расположение Yamlfile
     • json_path - строка или jsonfile , местоположение Jsonfile
   • Необязательные аргументы:
     • save - следует ли сохранить jsonfile (создан или изменен), как только данные соответствуют Yamlfile
   • Возвращает:
     • Jsonfile , расположенный в json_path

Классы / объекты

Yamlfile

• Описание:
  • Представляет файл YAML и предоставляет методы манипулирования его данными.
• Методы:
  • load() : загружает данные файла YAML.
  • save() : сохраняет текущие данные в файле YAML.

Jsonfile

• Описание:
  • Представляет файл JSON и предоставляет методы манипулирования его данными.
• Методы:
  • load() : загружает данные файла JSON.
  • save() : сохраняет текущие данные в файле JSON.

Filecontroller

• Описание:
  • Представляет абстрактный контроллер файла и предоставляет методы манипулирования данными файлов.
• Методы:
  • __init__(file_path: str) : инициализирует экземпляр FileController с помощью пути файла.
  • reload() : абстрактный метод загрузки данных из файла. Должен быть реализован подклассами.
  • save() : абстрактный метод для сохранения данных в файл. Должен быть реализован подклассами.
  • contains(key: str) -> bool : проверяет, существует ли ключ в словаре данных.
  • set(key: str, value: any) -> None : Устанавливает, изменяет или удаляет значения в конфигурации.
  • string(key: str, default_value: str | None = None) -> str | None : получает строковое значение из данных.
  • float(key: str, default_value: float | int | None = None) -> float | None : Получает значение поплавки из данных.
  • int(key: str, default_value: int | None = None) -> int | None : получает целочисленное значение из данных.
  • boolean(key: str, default_value: bool | None = None) -> bool | None : получает логическое значение из данных.
  • str_list(key: str, default_value: list[str] | None = None) -> list[str] | None : получает список строк из данных.
  • float_list(key: str, default_value: list[float | int] | None = None) -> list[float] | None : получает список значений плавания из данных.
  • int_list(key: str, default_value: list[int | float] | None = None) -> list[int] | None : получает список целочисленных значений из данных.
  • bool_list(key: str, default_value: list[bool] | None = None) -> list[bool] | None : получает список логических значений из данных.
  • dictionary(key: str, default_value: dict | None = None) -> dict | None : получает словарь из данных.