共计 10695 个字符,预计需要花费 27 分钟才能阅读完成。
1 configparser 装置
pip3 install configparser
2 configparser 简介
- 用来读取配置文件的 python 包;
- 个别做自动化测试的时候,会应用到这个模块,用来封装一些常量。比方数据库、邮件、用户名明码、我的项目常量等等;
- 这个应用依据集体爱好和我的项目来确定,不肯定肯定要应用这个模块,也能够应用其它的办法做配置,比方 py 文件、xml、excel、yaml、json 等等。
- configparser 源码大概 1360 行左右,通读源码可无效理解该模块的应用。本文只做简略介绍罕用的办法。
3 示意办法
- 新建一个名为
conf.py
文件; - 写入如下数据,格局如下:
[mysqldb] | |
sql_host = 127.0.0.1 | |
sql_port = 3699 | |
sql_user = root | |
sql_pass = 123456 | |
[mailinfo] | |
name = NoamaNelson | |
passwd = 123456 | |
address = 123456@qq.com |
4 configparser 具体应用
4.1 对象初始化
- 写入如下代码,把对象初始化。
# -*- coding:utf-8 -*- | |
# 作者:NoamaNelson | |
# 日期:2021/11/19 | |
# 文件名称:conf.py | |
# 作用:configparser 模块的应用 | |
# 分割:VX(NoamaNelson) | |
# 博客:https://blog.csdn.net/NoamaNelson | |
import configparser | |
import os | |
class Conf: | |
def __init__(self): | |
self.conf = configparser.ConfigParser() | |
self.root_path = os.path.dirname(os.path.abspath(__file__)) | |
self.f = os.path.join(self.root_path + "/config.conf") | |
self.conf.read(self.f) |
4.2 获取所有的 sections
def read_sections(self): | |
print(f"1、获取所有的 sections:{self.conf.sections()}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] |
4.3 获取所有的 sections 对应的 options
def read_options(self, s1, s2): | |
print(f"2、获取 mysqldb 所有的 options:{self.conf.options(s1)}") | |
print(f"3、获取 mailinfo 所有的 options:{self.conf.options(s2)}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] |
4.4 read 办法和 get 办法,获取指定 section 下的 option 值
read
是读取配置文件,如self.conf.read(self.f)
是读取指定config.conf
文件;get
是获取具体的值;
def read_conf(self, m, n): | |
name = self.conf.get(m, n) # 获取指定 section 的 option 值 | |
print(f"4、获取指定 section:{m}下的 option:{n}的值为{name}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 |
4.5 items 办法,获取指导 section 所用配置信息
def get_items(self, m, n): | |
print(f"5、获取 sectoion:{m}下的配置信息为:{self.conf.items(m)}") | |
print(f"6、获取 sectoion:{n}下的配置信息为:{self.conf.items(n)}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 | |
5、获取 sectoion:mysqldb 下的配置信息为:[('sql_host', '127.0.0.1'), ('sql_port', '3699'), ('sql_user', 'root'), ('sql_pass', '123456')] | |
6、获取 sectoion:mailinfo 下的配置信息为:[('name', 'NoamaNelson'), ('passwd', '123456'), ('address', '123456@qq.com')] |
4.6 set 和 write 办法,批改某个 option 的值
- 如果 option 不存在则创立它;
def set_option(self, m, n, s): | |
self.conf.set(m, n, s) | |
self.conf.write(open(self.f, "w")) | |
print(f"7、设置 setion:{m}下的 option:{n}的值为:{s}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") | |
aa.set_option("mysqldb", "sql_name", "游客") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 | |
5、获取 sectoion:mysqldb 下的配置信息为:[('sql_host', '127.0.0.1'), ('sql_port', '3699'), ('sql_user', 'root'), ('sql_pass', '123456')] | |
6、获取 sectoion:mailinfo 下的配置信息为:[('name', 'NoamaNelson'), ('passwd', '123456'), ('address', '123456@qq.com')] | |
7、设置 setion:mysqldb 下的 option:sql_name 的值为:游客 |
- 因为之前的配置文件中没有
sql_name
,所以会新创建它,如果创立的内容存在,间接批改对应的值;
4.7 has_section 和 has_option 办法
has_section
办法查看对应的section
是否存在;has_option
办法查看对应的option
是否存在;
def has_s_o(self, s, o): | |
print(f"8、查看 section:{s}是否存在:{self.conf.has_section(s)}") | |
print(f"9、查看 section:{s}下的 option:{o}是否存在:{self.conf.has_option(s, o)}") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") | |
aa.set_option("mysqldb", "sql_name", "游客") | |
aa.has_s_o("mysqldb", "sql_name") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass', 'sql_name'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 | |
5、获取 sectoion:mysqldb 下的配置信息为:[('sql_host', '127.0.0.1'), ('sql_port', '3699'), ('sql_user', 'root'), ('sql_pass', '123456'), ('sql_name', '游客')] | |
6、获取 sectoion:mailinfo 下的配置信息为:[('name', 'NoamaNelson'), ('passwd', '123456'), ('address', '123456@qq.com')] | |
7、设置 setion:mysqldb 下的 option:sql_name 的值为:游客 | |
8、查看 section:mysqldb 是否存在:True | |
9、查看 section:mysqldb 下的 option:sql_name 是否存在:True |
4.8 add_section 办法,增加 section 和 option
add_section
:增加section
;- 增加前:
def add_s_o(self, s, o, v): | |
if not self.conf.has_section(s): | |
self.conf.add_section(s) | |
print(f"10、增加新的 section 为{s}") | |
else: | |
print(f"10、增加新的 section 为 {s} 曾经存在,无需增加!") | |
if not self.conf.has_option(s, o): | |
self.conf.set(s, o, v) | |
print(f"11、要增加的 option 为{o}, 值为{v}") | |
else: | |
print(f"11、要增加的 option 为{o}, 值为{v},曾经存在,无需增加!") | |
self.conf.write(open(self.f, "w")) | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") | |
aa.set_option("mysqldb", "sql_name", "游客") | |
aa.has_s_o("mysqldb", "sql_name") | |
aa.add_s_o("login", "name", "root") |
- 增加后:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass', 'sql_name'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 | |
5、获取 sectoion:mysqldb 下的配置信息为:[('sql_host', '127.0.0.1'), ('sql_port', '3699'), ('sql_user', 'root'), ('sql_pass', '123456'), ('sql_name', '游客')] | |
6、获取 sectoion:mailinfo 下的配置信息为:[('name', 'NoamaNelson'), ('passwd', '123456'), ('address', '123456@qq.com')] | |
7、设置 setion:mysqldb 下的 option:sql_name 的值为:游客 | |
8、查看 section:mysqldb 是否存在:True | |
9、查看 section:mysqldb 下的 option:sql_name 是否存在:True | |
10、增加新的 section 为 login | |
11、要增加的 option 为 name, 值为 root |
- 再次运行代码,会提醒曾经存在:
10、增加新的 section 为 login 曾经存在,无需增加!11、要增加的 option 为 name, 值为 root,曾经存在,无需增加!
4.9 remove_section 和 remove_option 办法,删除 section 和 option
def remove_s_o(self, s, o): | |
if self.conf.has_section(s): | |
self.conf.remove_section(s) | |
print(f"12、删除 section:{s}==OK!") | |
else: | |
print(f"12、要删除的 section:{s}不存在,不必删除!") | |
if self.conf.has_option(s, o): | |
self.conf.remove_option(s, o) | |
print(f"13、删除 section:{s}下的 option:{o}==OK!") | |
else: | |
print(f"13、要删除的 section:{s}下的 option:{o}不存在,不必删除!") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") | |
aa.set_option("mysqldb", "sql_name", "游客") | |
aa.has_s_o("mysqldb", "sql_name") | |
aa.add_s_o("login", "name", "root") | |
aa.remove_s_o("login", "name") |
- 后果为:
D:\Python37\python.exe F:/python_study/conf.py | |
1、获取所有的 sections:['mysqldb', 'mailinfo', 'login'] | |
2、获取 mysqldb 所有的 options:['sql_host', 'sql_port', 'sql_user', 'sql_pass', 'sql_name'] | |
3、获取 mailinfo 所有的 options:['name', 'passwd', 'address'] | |
4、获取指定 section:mysqldb 下的 option:sql_host 的值为 127.0.0.1 | |
5、获取 sectoion:mysqldb 下的配置信息为:[('sql_host', '127.0.0.1'), ('sql_port', '3699'), ('sql_user', 'root'), ('sql_pass', '123456'), ('sql_name', '游客')] | |
6、获取 sectoion:mailinfo 下的配置信息为:[('name', 'NoamaNelson'), ('passwd', '123456'), ('address', '123456@qq.com')] | |
7、设置 setion:mysqldb 下的 option:sql_name 的值为:游客 | |
8、查看 section:mysqldb 是否存在:True | |
9、查看 section:mysqldb 下的 option:sql_name 是否存在:True | |
10、增加新的 section 为 login 曾经存在,无需增加!11、要增加的 option 为 name, 值为 root,曾经存在,无需增加!12、删除 section:login==OK! | |
13、要删除的 section:login 下的 option:name 不存在,不必删除! |
5 configparser 常见的异样
<div class=”table-box”><table><thead><tr><th> 异样 </th><th> 形容 </th></tr></thead><tbody><tr><td>ConfigParser.Error</td><td> 所有异样的基类 </td></tr><tr><td>ConfigParser.NoSectionError</td><td> 指定的 section 没有找到 </td></tr><tr><td>ConfigParser.DuplicateSectionError</td><td> 调用 add_section() 时,section 名称曾经被应用 </td></tr><tr><td>ConfigParser.NoOptionError</td><td> 指定的参数没有找到 </td></tr><tr><td>ConfigParser.InterpolationError</td><td> 当执行字符串插值时呈现问题时,出现异常的基类 </td></tr><tr><td>ConfigParser.InterpolationDepthError</td><td> 当字符串插值无奈实现时,因为迭代次数超过了最大的范畴,所以无奈实现。InterpolationError 的子类 </td></tr><tr><td>InterpolationMissingOptionError</td><td> 当援用的选项不存在时,会出现异常。InterpolationError 的子类 </td></tr><tr><td>ConfigParser.InterpolationSyntaxError</td><td> 当产生替换的源文本不合乎所需的语法时,就会出现异常。InterpolationError 的子类。</td></tr><tr><td>ConfigParser.MissingSectionHeaderError</td><td> 当试图解析一个没有分段题目的文件时,会出现异常。</td></tr><tr><td>ConfigParser.ParsingError</td><td> 当试图解析文件时产生谬误时,会出现异常 </td></tr><tr><td>ConfigParser.MAX_INTERPOLATION_DEPTH</td><td> 当 raw 参数为 false 时,get()的递归插值的最大深度。这只实用于 ConfigParser 类 </td></tr></tbody></table></div>
6 本文所有源码
# -*- coding:utf-8 -*- | |
# 作者:NoamaNelson | |
# 日期:2021/11/19 | |
# 文件名称:conf.py | |
# 作用:configparser 模块的应用 | |
# 分割:VX(NoamaNelson) | |
# 博客:https://blog.csdn.net/NoamaNelson | |
import configparser | |
import os | |
class Conf: | |
def __init__(self): | |
self.conf = configparser.ConfigParser() | |
self.root_path = os.path.dirname(os.path.abspath(__file__)) | |
self.f = os.path.join(self.root_path + "/config.conf") | |
self.conf.read(self.f) | |
def read_sections(self): | |
print(f"1、获取所有的 sections:{self.conf.sections()}") | |
def read_options(self, s1, s2): | |
print(f"2、获取 mysqldb 所有的 options:{self.conf.options(s1)}") | |
print(f"3、获取 mailinfo 所有的 options:{self.conf.options(s2)}") | |
def read_conf(self, m, n): | |
name = self.conf.get(m, n) # 获取指定 section 的 option 值 | |
print(f"4、获取指定 section:{m}下的 option:{n}的值为{name}") | |
def get_items(self, m, n): | |
print(f"5、获取 sectoion:{m}下的配置信息为:{self.conf.items(m)}") | |
print(f"6、获取 sectoion:{n}下的配置信息为:{self.conf.items(n)}") | |
def set_option(self, m, n, s): | |
self.conf.set(m, n, s) | |
self.conf.write(open(self.f, "w")) | |
print(f"7、设置 setion:{m}下的 option:{n}的值为:{s}") | |
def has_s_o(self, s, o): | |
print(f"8、查看 section:{s}是否存在:{self.conf.has_section(s)}") | |
print(f"9、查看 section:{s}下的 option:{o}是否存在:{self.conf.has_option(s, o)}") | |
def add_s_o(self, s, o, v): | |
if not self.conf.has_section(s): | |
self.conf.add_section(s) | |
print(f"10、增加新的 section 为{s}") | |
else: | |
print(f"10、增加新的 section 为 {s} 曾经存在,无需增加!") | |
if not self.conf.has_option(s, o): | |
self.conf.set(s, o, v) | |
print(f"11、要增加的 option 为{o}, 值为{v}") | |
else: | |
print(f"11、要增加的 option 为{o}, 值为{v},曾经存在,无需增加!") | |
self.conf.write(open(self.f, "w")) | |
def remove_s_o(self, s, o): | |
if self.conf.has_section(s): | |
self.conf.remove_section(s) | |
print(f"12、删除 section:{s}==OK!") | |
else: | |
print(f"12、要删除的 section:{s}不存在,不必删除!") | |
if self.conf.has_option(s, o): | |
self.conf.remove_option(s, o) | |
print(f"13、删除 section:{s}下的 option:{o}==OK!") | |
else: | |
print(f"13、要删除的 section:{s}下的 option:{o}不存在,不必删除!") | |
if __name__ == "__main__": | |
aa = Conf() | |
aa.read_sections() | |
aa.read_options("mysqldb", "mailinfo") | |
aa.read_conf("mysqldb", "sql_host") | |
aa.get_items("mysqldb", "mailinfo") | |
aa.set_option("mysqldb", "sql_name", "游客") | |
aa.has_s_o("mysqldb", "sql_name") | |
aa.add_s_o("login", "name", "root") | |
aa.remove_s_o("login", "name") |