YamlManager

Yamlmanager

库简化JSON和YAML文件的管理和创建。

功能：

1. to_json_file：

   • 功能：
     • 将字典转换为jsonfile
   • 参数：
     • json_path弦或jsonfile ， jsonfile的位置
     • dictionary - jsonfile应该拥有的数据
   • 可选参数：
     • save - 数据与字典匹配后应立即保存（创建还是修改） JSONFILE
   • 返回：
     • 位于json_path JSONFILE

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 Yamlfile

4. to_yaml_file：

   • 功能：
     • 将字典转换为Yamlfile
   • 参数：
     • yaml_path字符串或Yamlfile ， Yamlfile的位置
     • dictionary - Yamlfile应该拥有的数据
   • 可选参数：
     • save - 一旦数据与字典匹配，是否应立即保存（创建或修改） Yamlfile
   • 返回：
     • 位于yaml_path Yamlfile

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 - 数据匹配Yamlfile ，是否应立即保存（创建或修改） JSONFILE
   • 返回：
     • 位于json_path JSONFILE

类 /对象

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 ：从数据中获取字典。