Skip to content

ncdhz/no_config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

no_config

yamljsontoml等配置文件映射为类,需要很多冗余代码或者魔术字符串。这对代码的维护工作提出了更高的要求,no_config能简化这种映射,仅仅需要两行代码即可完成映射。更多文档信息请参考https://ncdhz.github.io/no_config

安装

pip安装

pip install no_config

源码安装

git clone https://github.com/ncdhz/no_config.git
# 进入no_config目录执行下面语句
pip install .

快速开始

下面将用一个简短的例子介绍本库该怎么使用,例子中使用的源码在examples/start/start.py

把配置文件中的信息,映射到实体类User中。

  1. 配置文件

    # 创建配置文件start.yaml
    user:
        username: ncdhz
        password: ncdhz
  2. 源码文件

    from os import path
    from no_config import Config
    
    # 配置注入
    @Config
    class User:
        password = None
        username = None
    
    if __name__ == '__main__':
        # 配置初始化
        # 全局只需一次初始化
        # 在更改配置之后可以通过此函数刷新配置
        Config.init(path.join(path.dirname(__file__), 'start.yaml'))
        print(User.password)
        print(User.username)