import{_ as a,c as n,a7 as i,j as t,o as l}from"./chunks/framework.v7PlT0Wt.js";const E=JSON.parse('{"title":"liteyuki.config","description":"","frontmatter":{"title":"liteyuki.config"},"headers":[],"relativePath":"en/dev/api/config.md","filePath":"en/dev/api/config.md","lastUpdated":1725101868000}'),h={name:"en/dev/api/config.md"};function e(k,s,p,r,d,o){return l(),n("div",null,s[0]||(s[0]=[i('

Module liteyuki.config ​

该模块用于常用配置文件的加载 多配置文件编写原则：

  1. 尽量不要冲突: 一个键不要多次出现
  2. 分工明确: 每个配置文件给一个或一类服务提供配置
  3. 扁平化编写: 配置文件尽量扁平化，不要出现过多的嵌套
  4. 注意冲突时的优先级: 项目目录下的配置文件优先级高于config目录下的配置文件
  5. 请不要将需要动态加载的内容写入配置文件，你应该使用其他储存方式

func flat_config(config: dict[str, Any]) -> dict[str, Any] ​

Description: 扁平化配置文件

',6),t("p",{"a.b.c:":"",1:""},"{a:{b:{c:1}}} ->",-1),i(`

Arguments:

Return: 扁平化后的配置文件，但也包含原有的键值对

Source code or View on GitHub
python
def flat_config(config: dict[str, Any]) -> dict[str, Any]:
    new_config = copy.deepcopy(config)
    for key, value in config.items():
        if isinstance(value, dict):
            for k, v in flat_config(value).items():
                new_config[f'{key}.{k}'] = v
    return new_config

func load_from_yaml(file_: str) -> dict[str, Any] ​

Description: Load config from yaml file

Source code or View on GitHub
python
def load_from_yaml(file_: str) -> dict[str, Any]:
    logger.debug(f'Loading YAML config from {file_}')
    config = yaml.safe_load(open(file_, 'r', encoding='utf-8'))
    return flat_config(config if config is not None else {})

func load_from_json(file_: str) -> dict[str, Any] ​

Description: Load config from json file

Source code or View on GitHub
python
def load_from_json(file_: str) -> dict[str, Any]:
    logger.debug(f'Loading JSON config from {file_}')
    config = json.load(open(file_, 'r', encoding='utf-8'))
    return flat_config(config if config is not None else {})

func load_from_toml(file_: str) -> dict[str, Any] ​

Description: Load config from toml file

Source code or View on GitHub
python
def load_from_toml(file_: str) -> dict[str, Any]:
    logger.debug(f'Loading TOML config from {file_}')
    config = toml.load(open(file_, 'r', encoding='utf-8'))
    return flat_config(config if config is not None else {})

func load_from_files(*files: str, *, no_warning: bool = False) -> dict[str, Any] ​

Description: 从指定文件加载配置项，会自动识别文件格式 默认执行扁平化选项

Source code or View on GitHub
python
def load_from_files(*files: str, no_warning: bool=False) -> dict[str, Any]:
    config = {}
    for file in files:
        if os.path.exists(file):
            if file.endswith(('.yaml', 'yml')):
                config.update(load_from_yaml(file))
            elif file.endswith('.json'):
                config.update(load_from_json(file))
            elif file.endswith('.toml'):
                config.update(load_from_toml(file))
            elif not no_warning:
                logger.warning(f'Unsupported config file format: {file}')
        elif not no_warning:
            logger.warning(f'Config file not found: {file}')
    return config

func load_configs_from_dirs(*directories: str, *, no_waring: bool = False) -> dict[str, Any] ​

Description: 从目录下加载配置文件，不递归 按照读取文件的优先级反向覆盖 默认执行扁平化选项

Source code or View on GitHub
python
def load_configs_from_dirs(*directories: str, no_waring: bool=False) -> dict[str, Any]:
    config = {}
    for directory in directories:
        if not os.path.exists(directory):
            if not no_waring:
                logger.warning(f'Directory not found: {directory}')
            continue
        for file in os.listdir(directory):
            if file.endswith(_SUPPORTED_CONFIG_FORMATS):
                config.update(load_from_files(os.path.join(directory, file), no_warning=no_waring))
    return config

func load_config_in_default(no_waring: bool = False) -> dict[str, Any] ​

Description: 从一个标准的轻雪项目加载配置文件 项目目录下的config.*和config目录下的所有配置文件 项目目录下的配置文件优先

Arguments:

Source code or View on GitHub
python
def load_config_in_default(no_waring: bool=False) -> dict[str, Any]:
    config = load_configs_from_dirs('config', no_waring=no_waring)
    config.update(load_from_files('config.yaml', 'config.toml', 'config.json', 'config.yml', no_warning=no_waring))
    return config

class Loader ​

func __init__(self) ​

Source code or View on GitHub
python
def __init__(self):
    self.config = {}

func load_from_yaml(self, fp: str) -> Loader ​

Description: 从yaml文件加载配置

Arguments:

Source code or View on GitHub
python
def load_from_yaml(self, fp: str) -> 'Loader':
    with open(fp, 'r') as file:
        self.config.update(yaml.safe_load(file))
    return self

func load_from_toml(self, fp: str) -> Loader ​

Description: 从toml文件加载配置

Source code or View on GitHub
python
def load_from_toml(self, fp: str) -> 'Loader':
    with open(fp, 'r') as file:
        self.config.update(toml.load(file))
    return self

func load_from_json(self, fp: str) -> Loader ​

Description: 从json文件加载配置

Source code or View on GitHub
python
def load_from_json(self, fp: str) -> 'Loader':
    with open(fp, 'r') as file:
        self.config.update(json.load(file))
    return self

func load_from_env(self, prefix: str = '') -> Loader ​

Description: 从环境变量加载配置

Source code or View on GitHub
python
def load_from_env(self, prefix: str='') -> 'Loader':
    for key, value in os.environ.items():
        if key.startswith(prefix):
            self.config[key[len(prefix):]] = value
    return self

func merge(self, loader: Loader) -> Loader ​

Description: 合并两个Loader键值对树

Source code or View on GitHub
python
def merge(self, loader: 'Loader') -> 'Loader':
    self.config.update(loader.config)
    return self

func get(self, key: str, default: Any = None) -> Any ​

Description: 获取配置值

Source code or View on GitHub
python
def get(self, key: str, default: Any=None) -> Any:
    return self.config.get(key, default)
`,60)]))}const y=a(h,[["render",e]]);export{E as __pageData,y as default};