一 功能介绍
configparser模块使用来读取写入配置文件的,其配置文件的结构为:
[section1]
key1 = value1
key2 = value2
[section2]
key1 = value1
key2 = value2
其中"[ ]"包围的部分为section,是区分各个配置的标志,下面的值是以key-value的形式存在的。该模块对文件的名称没有要求,但是一般配置文件的的名称后缀为.conf或者.ini。
二 读取操作
import os
import configparser
if __name__ == '__main__':
path = os.path.join(os.path.abspath("."), "config")
os.chdir(path) # 一般会通过该方法将目标目录设置为工作目录
cf = configparser.ConfigParser() # 获取工作对象
cf.read("conf.txt",encoding="utf-8") # 将配置文件读入工作对象,如果之前没设置工作路径这里要用绝对路径。后面的编码可以省略。
name = cf.get("kafka1", "name")
print(name)
其他常用方法:
- 获取所有section节点:cf.sections(),返回值为list
- 获取指定section的所有options的key值:cf.options(section),返回结果为list
- 获取指定的section的指定的key的值:cf.get(section, key),返回结果为str
- 获取指定的section所有的option的key-value:cf.items(section),返回结果为:
#[('db_host', '127.0.0.1'), ('db_port', '69'), ('db_user', 'root')]
- 判断对应的section或option是否存在:cf.has_section(section),cf.has_option(section, option),返回值为bol
三 写入操作
- 修改某个option的值,如果不存在则会出创建:cf.set(section, key, value)
- 添加section 和 option:cf.add_section(section), cf.set(section, key, value)
if __name__ == '__main__':
path = os.path.join(os.path.abspath("."), "config")
os.chdir(path)
cf = configparser.ConfigParser()
cf.read("test.ini")
if not cf.has_section("default"):
cf.add_section("default")
if not cf.has_option("default", "name"):
cf.set("default", "name", "tianqi")
cf.write(open("test.ini", "w"))
- 删除section 和 option:cf.remove_section(section),cf.remove_option(section, option)
- 直接创建文件,上面两部操作只是将数据读入内存,下面的write才是创建文件。
if __name__ == '__main__':
path = os.path.join(os.path.abspath("."), "config")
os.chdir(path)
cf = configparser.ConfigParser()
cf.write(open("test.conf", "w"))
参考: