【python第三方库】configparser---python解析config文件入门

一、概览

用来读取配置文件的python包；

一般做自动化测试的时候，会使用到这个模块，用来封装一些常量。比如数据库、邮件、用户名密码、项目常量等等；

这个使用根据个人喜好和项目来确定，不一定一定要使用这个模块，也可以使用其它的方法做配置，比如py文件、xml、excel、yaml、json等等。

ConfigParser模块在python3中修改为configparser.这个模块定义了一个ConfigParser类，该类的作用是使用配置文件生效，配置文件的格式和windows的INI文件的格式相同

该模块的作用 就是使用模块中的RawConfigParser()、ConfigParser()、 SafeConfigParser()这三个方法之一，创建一个对象使用对象的方法对指定的配置文件做增删改查 操作。

1. config文件格式

新建一个名为conf.py文件（也可为 .txt, .ini, .cfg等）
写入如下数据，格式如下：

[mysqldb]
sql_host = 127.0.0.1
sql_port = 3699
sql_user = root
sql_pass = 123456

[mailinfo]
# name
name = NoamaNelson
# passwd
passwd = 123456
# address
address = 123456@qq.com

1 [My Section]
2 foodir: %(dir)s/whatever
3 dir=frob
4 long: this value continues
5    in the next line

含义如下：

[section] 
name=value
或者
name: value
"#" 和";" 表示注释
%(dir)s 会被frob代替。
[DEFAULT] #设置默认的变量值，初始化

默认值会以字典的形式传递给ConfigParser的构造器。
section一般存放的内置目录下，如果切换到其他的目录需要指定存放位置。

2. 常用方法

下面这三种方式使用时，切记注意

在调用这三个函数时，切记这三个函数会将调用optionxform()，在传递键值对数据时，会将键名 全部转化为小写。

RawConfigParser()

'''
遇到问题没人解答？小编创建了一个Python学习交流QQ群：857662006 
寻找有志同道合的小伙伴，互帮互助,群里还有不错的视频学习教程和PDF电子书！
'''
1 ConfigParser.RawConfigParser([defaults[, dict_type[, allow_no_value]]]) 
2 
3 defaults : 如果指定默认值，则使用默认值的键值对
4 dict_type：使用新的section的键值对
5 allow_no_value ：默认是False，如果是True，表示可以接收空值（None）
6 return：对象

不支持可变参数，在section中不能存在%()s

ConfigParser(）

1 ConfigParser.ConfigParser([defaults[, dict_type[, allow_no_value]]]) 

在default中必须出现%()s

SafeConfigParser()

 ConfigParser.SafeConfigParser([defaults[, dict_type[, allow_no_value]]]) 

更加智能化，在section中是否存在%()s会自动判断

传递参数使用函数optionxform()，foo %(bar)s 和 foo %(BAR)s是相同的，optionxform()会将大写字母全部转换为小写。

3. 常见异常

二、代码示例

# -*- coding:utf-8 -*-
# 作者：NoamaNelson
# 日期：2021/11/19 
# 文件名称：conf.py
# 作用：configparser模块的使用
# 联系：VX(NoamaNelson)
# 博客：https://blog.csdn.net/NoamaNelson

import configparser
import os


class Conf:
	# 1. 对象初始化
    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)
        
	# 2. 获取所有的sections
    def read_sections(self):
        print(f"1、获取所有的sections:{self.conf.sections()}")
	'''1、获取所有的sections:['mysqldb', 'mailinfo']'''

	# 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)}")
        '''2、获取mysqldb所有的options:['sql_host', 'sql_port', 'sql_user', 'sql_pass']
		   3、获取mailinfo所有的options:['name', 'passwd', 'address']'''

	# 4. read方法和get方法，获取指定section下的option值
    def read_conf(self, m, n):
        name = self.conf.get(m, n)  # 获取指定section的option值
        print(f"4、获取指定section:{m}下的option：{n}的值为{name}")
    '''4、获取指定section:mysqldb下的option：sql_host的值为127.0.0.1'''
	
	# 5. 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)}")
    '''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')]'''
	
	# 6. set和write方法，修改某个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}")
    '''7、设置setion:mysqldb下的option:sql_name的值为：游客'''

	# 7. has_section和has_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)}")
    '''8、检查section：mysqldb是否存在：True
	   9、检查section：mysqldb下的option：sql_name是否存在：True'''

	# 8. add_section方法，添加section和option
    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"))
    '''10、添加新的section为login
	   11、要添加的option为name, 值为root'''

	# 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}不存在，不用删除！")
    '''12、删除section:login==OK!
	   13、要删除的section：login下的option：name不存在，不用删除！'''

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")

参考链接：
https://blog.csdn.net/AI_Green/article/details/121445523