python操作ini文件

简介

ini文件作为常见的配置文件，因此需要对ini文件做处理，此处使用configparser模块，本文介绍以下ini文件常用的处理方式。

需要读取的ini文件

如下文件，[ ]包含的称为section,其下面的称为option

; section
[timeout]
; option
timeout = 10
[max_time]
max_time = 200
[min_time]
min_time = 10
[city]
city = ['南京', "北京", "武汉"]

读取ini文件

通常写法

import pathlib
import configparser


ini_path = pathlib.Path(__file__).parent.joinpath("test.ini")
# 获取ini文件对象
config = configparser.ConfigParser()
# 读取ini的文件名称
config.read(ini_path, encoding="utf8")
# 获取section为city, option为city的值
print(config.get("city", "city"))
# 获取section为timeout, option为timeout的值
print(config.get("timeout", "timeout"))
# 获取所有的sections，以列表形式返回
print(config.sections())
# 获取sections为timeout的所有options，以列表形式返回
print(config.options("timeout"))
# 判断section是否包含timeout
print(config.has_section("timeout"))
# 判断section是否包含timeout2
print(config.has_section("timeout2"))
# 判断section为timeout的下面是否包含timeout
print(config.has_option("timeout", "timeout"))
# 判断section为timeout的下面是否包含timeout2
print(config.has_option("timeout", "timeout2"))

['南京', "北京", "武汉"]
10
['timeout', 'max_time', 'min_time', 'city']
['timeout', 'timeout2']
True
False
True
False

需要注意的是，当读取的值包含中文时，需要在read的时候添加encoding编码为utf8,以保证不会出现乱码。

读取ini配置的几种方式

读取的来源不同，但后续的读取信息的操作都是一致的

从字典中读取ini配置

这可以从字典中读取对应key的value，不过一般对于某个key的value值直接使用索引读取即可，但这个可以方便读取到某一层级的所有key值以及是否包含某个key。

dict_data = {
    "timeout": {"timeout": 10, "timeout2": 20},
    "max_time": {"max_time": 200},
    "min_time": {"min_time": 10},
    "city": {"city": ["南京", "北京", "武汉"]},
}
config.read_dict(dict_data)
print(config.get("city", "city"))
print(config.get("timeout", "timeout"))
print(config.sections())
print(config.options("timeout"))

从给定字符串中读取ini配置

这种方法相当于将直接从ini文件的字符串中读取，一般不会这么做

with open(ini_path, mode="r", encoding="utf8") as f:
    data = f.read()
    print(data)
    config.read_string(data)
    print(config.get("city", "city"))
    print(config.get("timeout", "timeout"))
    print(config.sections())
    print(config.options("timeout"))

读取ini文件的文件对象

使用open获取fp对象进行操作， f.name可以省略

# 已废弃，使用read_file代替
config.readfp()
with open(ini_path, encoding="utf8") as f:
    config.read_file(f, f.name)
    print(config.get("city", "city"))
    print(config.get("timeout", "timeout"))
    print(config.sections())
    print(config.options("timeout"))

读取ini的文件名称或者path对象也可以

上述通常已介绍，此处不再赘述。

config.read(ini_path, encoding="utf8")

另外，在读取配置时候可以指定读取值的类型

config.getboolean
config.getfloat
config.getint

写入ini文件

import pathlib
import configparser


ini_path = pathlib.Path(__file__).parent.joinpath("test.ini")
config = configparser.ConfigParser()
# 添加section
config.add_section("huawei")
# 添加option并设置值，只能是string值
config.set("huawei", "huawei", "1")
# 写入ini文件，注意写入的mode会影响是否覆盖ini文件
with open(ini_path, "a+", encoding="utf8") as f:
    config.write(f)

补充

configparser中其实有三个，分别是

# 通常是最常用的解析ini文件的配置
configparser.ConfigParser()
# 可以匹配正则的标题和选项的配置，类似于模糊查询的那种
configparser.RawConfigParser()
# 已废弃，与configparser.ConfigParser()作用一致，在python3.2后改为前者，将在python3.12中删除
configparser.SafeConfigParser()