Python轮子：profig~智能配置管理

原文链接：http://www.juzicode.com/python-module-profig

Profig是Python的多源配置管理库，提供配置合并、类型转换和动态重载功能，适用于现代应用的复杂配置需求。

应用场景

• 多环境配置自动切换
• 配置热更新与动态重载
• 多格式配置统一接口

安装与导入

# juzicode.com/VX公众号:juzicode
pip install profig
from profig import Config

基本用法

1. 配置写入

首先用Config()创建配置对象，然后用类似字典的方法设置配置，最后再写入到文件中。

# juzicode.com/VX公众号:juzicode
from profig import Config

# 初始化配置对象
config = Config()
# 设置配置值
config['app.name'] = 'MyApp'
config['version'] = 1.0
config['debug'] = True
# 保存到文件
config.write('temp.cfg') 
# 打印文件内容
with open('temp.cfg', mode='r') as pf:
    print(pf.read())

运行结果：

[app]
name = MyApp

[version] = 1.0

[debug] = true

2. 配置读取

利用前面写入的文件，初始化对象后用read()方法读取文件，再用字典方法或者get()方法获取配置值：

# juzicode.com/VX公众号:juzicode
from profig import Config
config = Config('temp.cfg') # 指定文件路径
config.read()    # 从文件读取    
print(config['version'])    # 字典方式输出配置值
print(config.get('version'))  # get()方法获取
print(config.get('version2', '0.10'))  # 获取默认值（若键不存在则用0.10作为返回结果）

运行结果：

1.0
1.0
0.10

3. 配置数据类型的转换

可以根据配置的类型自带转换，下面的例子展示str，int，boot等3种类型的数据读出后显示的数据类型：

# juzicode.com/VX公众号:juzicode
from profig import Config

config = Config() 
config['server'] = {
    'host': 'localhost',   # 字符串
    'port': 8080,   #  int
    'ssl': True   #bool
}

# 根据配置类型自动转换
print(config['server.host'])   
print(type(config['server.host']))  # 输出: str
print(config['server.port'])   
print(type(config['server.port']))  # 输出: int
print(config['server.ssl'])   
print(type(config['server.ssl']))  # 输出: bool

运行结果：

localhost
<class 'str'>
8080
<class 'int'>
True
<class 'bool'>

4. 字典结构显示

使用as_dict()方法可以将配置以字典方式显示，这个例子仍然以前面生成的temp.cfg文件为例：

# juzicode.com/VX公众号:juzicode
from profig import Config
config = Config('temp.cfg') # 指定文件路径
config.read()   
print(config.as_dict())

运行结果：

OrderedDict([('app', OrderedDict([('name', 'MyApp')])), ('version', '1.0'), ('debug', 'true')])

5. 多源输入

在用Config()生成实例时，可以指定多个文件作为输入：

config = Config('temp.cfg','temp2.cfg','temp3.cfg') 

有3个文件的内容如下所示：

temp.cfg
[app]
name = MyApp
[version] = 1.0
[debug] = true
[version3] = 3.0

temp2.cfg
[app]
name = MyApp
[version] = 2.0
[debug] = true

temp3.cfg
[app]
name = MyApp
[version] = 3.0
[debug] = true
[version3] = 3.0

使用多源输入时，首先到第1个配置文件中获取配置值，没有找到的关键字则依次到其他文件中查找：

# juzicode.com/VX公众号:juzicode
from profig import Config
config = Config('temp.cfg','temp2.cfg','temp3.cfg') # 指定文件路径
config.read()   
print(config['version'])
print(config['version3'])
config['version']=5.0
config['version3']=5.3
config.write()

运行结果：

1.0
3.0

读取配置时，关键字version在3个文件中均存在，按照配置文件的顺序，使用的是第1个文件temp.cfg的内容，但是关键字version3只存在于temp3.cfg中，所以用的是temp3.cfg的值。

示例代码中最后3行重新设置和写入文件，打开文件可以看到，temp.cfg中增加了version3字段的内容，并没有修改temp3.cfg，所以这里write()写入配置只影响了第一个文件。

总结

Profig为现代应用提供全功能配置解决方案，是一个简洁高效的配置管理工具，适合需要快速集成且不希望引入复杂依赖的项目。