Merge pull request #872 from RockChinQ/feat/config-file-api

Feat: 添加yaml配置文件的支持

pkg/config/impls/yaml.py

@@ -0,0 +1,59 @@
+import os
+import shutil
+import yaml
+
+from .. import model as file_model
+
+
+class YAMLConfigFile(file_model.ConfigFile):
+    """YAML配置文件"""
+
+    def __init__(
+        self, config_file_name: str, template_file_name: str = None, template_data: dict = None
+    ) -> None:
+        self.config_file_name = config_file_name
+        self.template_file_name = template_file_name
+        self.template_data = template_data
+
+    def exists(self) -> bool:
+        return os.path.exists(self.config_file_name)
+
+    async def create(self):
+        if self.template_file_name is not None:
+            shutil.copyfile(self.template_file_name, self.config_file_name)
+        elif self.template_data is not None:
+            with open(self.config_file_name, "w", encoding="utf-8") as f:
+                yaml.dump(self.template_data, f, indent=4, allow_unicode=True)
+        else:
+            raise ValueError("template_file_name or template_data must be provided")
+
+    async def load(self, completion: bool=True) -> dict:
+
+        if not self.exists():
+            await self.create()
+
+        if self.template_file_name is not None:
+            with open(self.template_file_name, "r", encoding="utf-8") as f:
+                self.template_data = yaml.load(f, Loader=yaml.FullLoader)
+
+        with open(self.config_file_name, "r", encoding="utf-8") as f:
+            try:
+                cfg = yaml.load(f, Loader=yaml.FullLoader)
+            except yaml.YAMLError as e:
+                raise Exception(f"配置文件 {self.config_file_name} 语法错误: {e}")
+
+        if completion:
+
+            for key in self.template_data:
+                if key not in cfg:
+                    cfg[key] = self.template_data[key]
+
+        return cfg
+
+    async def save(self, cfg: dict):
+        with open(self.config_file_name, "w", encoding="utf-8") as f:
+            yaml.dump(cfg, f, indent=4, allow_unicode=True)
+
+    def save_sync(self, cfg: dict):
+        with open(self.config_file_name, "w", encoding="utf-8") as f:
+            yaml.dump(cfg, f, indent=4, allow_unicode=True)

pkg/config/manager.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from . import model as file_model
-from .impls import pymodule, json as json_file
+from .impls import pymodule, json as json_file, yaml as yaml_file
 
 
 managers: ConfigManager = []
@@ -31,7 +31,16 @@ class ConfigManager:
 
 
 async def load_python_module_config(config_name: str, template_name: str, completion: bool=True) -> ConfigManager:
-    """加载Python模块配置文件"""
+    """加载Python模块配置文件
+    
+    Args:
+        config_name (str): 配置文件名
+        template_name (str): 模板文件名
+        completion (bool): 是否自动补全内存中的配置文件
+
+    Returns:
+        ConfigManager: 配置文件管理器
+    """
     cfg_inst = pymodule.PythonModuleConfigFile(
         config_name,
         template_name
@@ -44,7 +53,14 @@ async def load_python_module_config(config_name: str, template_name: str, comple
 
 
 async def load_json_config(config_name: str, template_name: str=None, template_data: dict=None, completion: bool=True) -> ConfigManager:
-    """加载JSON配置文件"""
+    """加载JSON配置文件
+    
+    Args:
+        config_name (str): 配置文件名
+        template_name (str): 模板文件名
+        template_data (dict): 模板数据
+        completion (bool): 是否自动补全内存中的配置文件
+    """
     cfg_inst = json_file.JSONConfigFile(
         config_name,
         template_name,
@@ -55,3 +71,27 @@ async def load_json_config(config_name: str, template_name: str=None, template_d
     await cfg_mgr.load_config(completion=completion)
 
     return cfg_mgr
+
+
+async def load_yaml_config(config_name: str, template_name: str=None, template_data: dict=None, completion: bool=True) -> ConfigManager:
+    """加载YAML配置文件
+    
+    Args:
+        config_name (str): 配置文件名
+        template_name (str): 模板文件名
+        template_data (dict): 模板数据
+        completion (bool): 是否自动补全内存中的配置文件
+
+    Returns:
+        ConfigManager: 配置文件管理器
+    """
+    cfg_inst = yaml_file.YAMLConfigFile(
+        config_name,
+        template_name,
+        template_data
+    )
+
+    cfg_mgr = ConfigManager(cfg_inst)
+    await cfg_mgr.load_config(completion=completion)
+
+    return cfg_mgr