作者：Gakki

前言

• 配置文件的必要性：

  1. 集中管理、统一修改、降低修改难度和避免修改不全面等问题；
  2. 代码和参数分离，方便不同模块代码中重复调用，保持核心代码整洁。

• 配置文件复杂度比：ini < json ≈ toml < yaml

01. ini 配置文件

• 格式：

 ; ini注释格式
[section1]
Param1 = value1
Param2= value2
[section2]
Param3= value3
Param4= value4

• 注：

  1. section 的名称不可以重复；读取都是字符串；读取的字符串不区分大小写
  2. 在 ini 文件中，使用 “;” 进行注释
  3. [ section ]：ini 的 section 模块，是下面参数值的一个统称
  4. Param = value：参数以及参数值

• python 自带的 configparser 模块可以读取 .ini 文件

import configparser
file = "test_data.ini"
# 创建配置文件对象
con = configparser.ConfigParser()
# 读取文件
con.read(file, encoding="utf-8")
# 获取所有 section
sections = con.sections()
print("获取所有的 section：%s" % sections)
# 获取指定的 section
items = con.items("section1") # 返回结果为元组，数字也默认读取为字符串
print("获取指定的 section: %s" % items)
# 可以通过 dict 方法转换为字典
print("获取指定的 section 转换为字典: %s" % dict(items))

• 响应结果

获取所有的 section：['section1', 'section2']
获取指定的 section: [('param1', 'value1'), ('param2', 'value2')]
获取指定的 section 转换为字典: {'param1': 'value1', 'param2': 'value2'}

02. 对 ini 配置文件进行操作

• 读取：

config.read(filename) # 读取文件内容
config.get("section", "option") # 获取指定section下的options
config.getint("section", "option") # 将获取到值转换为int型
config.getboolean("section", "option") # 将获取到值转换为bool型
config.getfloat("section", "option") # 将获取到值转换为浮点型
config.sections() # 得到所有的section，并以列表的形式返回
config.options(section) # 得到该section的所有option
config.items(section)：得到该section的所有键值对。

• 更新：

config.set("section_mod", "option", "option_value") # 修改section_mod的option
config.add_section("section_add") # 添加section节点
config.set("section_add", "option", "option_value") # 设置指定section_add的options

• 检查：

config.options('section') # 获取指定section 的options即该节点的所有键
config.has_section("section")# 是否存在该section
config.has_option("section", "option") # 是否存在该option

• 删除：

config.remove_section("section_rmv") # 整个section_rmv下的所有内容都将删除
config.remove_option("section_rmv", 'option') # 删除section_rmv下的指定option

• 保存：

config.write(open("Config", "w")) # 保存config

03. json 配置文件

• 格式：

{
    "book": [
    {
       "id":"01",
       "language": "Java",
       "edition": "third",
       "author": "Herbert Schildt"
    },
    {
       "id":"07",
       "language": "C++",
       "edition": "second",
       "author": "E.Balagurusamy"
    }]
}

04. 对 json 配置文件进行操作

• python 内置的 json 标准库进行解析 json 文件
• 读取 json 文件：

import json
with open("config.json") as file:
    conf_json = json.load(file)
print(conf_json)

• 输出结果：

{'book': [{'id': '01', 'language': 'Java', 'edition': 'third', 'author': 'Herbert Schildt'}, {'id': '07', 'language': 'C++', 'edition': 'second', 'author': 'E.Balagurusamy'}]}

• 写入 json 文件：

import json
data = {
    "name": "Gakki",
    "age": 25
}
with open("config.json", "w") as file1:
    json.dump(data, file1)

• 注：
  1. load() 从json文件中读取json格式数据
  2. loads() 将字符串类型数据转化为json格式数据
  3. dump() 将json格式数据保存到文件
  4. dumps() 将json格式数据保存为字符串类型

05. yaml 配置文件

• 语法特点：
  1. 大小写敏感
  2. 使用缩进表示层级关系，缩进的空格数目不重要，只要相同层级的元素左侧对其即可
  3. 缩进时不允许使用 Tab 键，只允许使用空格
  4. 字符串不需要使用引号标注，但若字符串包含有特殊字符则需用引号标注
  5. 注释标识为 #
• yaml 支持的数据格式有三种：
  1. 对象：键值对的集合，又称为映射/哈希/字典
  2. 数组：一组按次序排列的值，又称为序列/列表
  3. 纯量：单个的，不可再分的值。字符串、布尔值、整数、浮点数、Null、时间、日期

06. 对 yaml 配置文件进行操作

• config.json 文件配置如下

url: https://www.baidu.com
email:
 send: xxx@qq.com
 port: 25
 status_code:
  - 200
  - 300

• 读取数据

import yaml
with open("config.yaml", 'rb') as f:
    data = yaml.safe_load(f)
    print(data)

• 输出结果：

{'url': 'https://www.baidu.com', 'email': {'send': 'xxx@qq.com', 'port': 25}}{'url': 'https://www.baidu.com', 'email': {'send': 'xxx@qq.com', 'port': 25, 'status_code': [200, 300]}}

• 其他：锚点&和别名，可以用来引用；&用来建立锚点（ip_data），<<表示合并到当前数据，用来引用锚点

ip_data: &ip_data
 url: https://www.baidu.com
 port: 25

test_data1:
 name: Gakki
 <<: *ip_data

test:
 account: 1234567
 pwd: zxcv
 <<: *ip_data

• 上面 yaml 文件等同于：

 
ip_data: &ip_data
 url: https://www.baidu.com
 port: 25

test_data1:
 name: Gakki
 url: https://www.baidu.com
  port: 25

test:
 account: 1234567
 pwd: zxcv
 url: https://www.baidu.com
 port: 25