Python3 configparser模块

python

1. 简介

  configparser用于配置文件解析,可以解析特定格式的配置文件,多数此类配置文件名格式为XXX.ini,例如mysql的配置文件。在python3.X中

模块名为configparser ,在python2.X中使用的模块名为ConfigParser。

##### ini 文件示例 ########

[section1]

name = wang

age = 18

[section2]

name:python

age = 19

#### 文件格式说明 #########

[XXX] 代表节点

XX = XX 或者 XX : XX 代表参数

read(filename) #读取配置文件,直接读取ini文件内容

sections() #获取ini文件内所有的section,以列表形式返回['logging', 'mysql']

options(sections) #获取指定sections下所有options ,以列表形式返回['host', 'port', 'user', 'password']

items(sections) #获取指定section下所有的键值对,[('host', '127.0.0.1'), ('port', '3306'), ('user', 'root'), ('password', '123456')]

get(section, option) #获取section中option的值,返回为string类型

>>>>>获取指定的section下的option <class 'str'> 127.0.0.1

getint(section,option) 返回int类型

getfloat(section, option) 返回float类型

getboolean(section,option) 返回boolen类型

常用方法

2. 使用

import configparser       # 导入模块

config = configparser.ConfigParser() # 创建对象

config.read("user.ini", encoding="utf-8") # 读取配置文件,如果配置文件不存在则创建

# 查看

secs = config.sections() # 获取所有的节点名称

print(secs)

# ['section1', 'section2']

options = config.options('section1') # 获取指定节点的所有key

print(options)

# ['name', 'age']

item_list = config.items('section1') # 获取指定节点的键值对

print(item_list)

#[('name', 'wang'), ('age', '18')]

val = config.get('section1', 'name') # 获取指定节点的指定key的value

print(val)

# wang

val = config.getint('section1', 'age') # 获取节点section1的age属性,属性需要是int型,否则ValueError

print(val)

# 18

val = config.has_section('section1') # 检查指定节点是否存在,返回True或False

print(val)

# True

val = config.has_option('section1', 'age') # 检查指定节点中是否存在某个key,返回True或False

print(val)

#True

# 增删改

config.add_section("node") # 添加一个节点,节点名为node, 此时添加的节点node尚未写入文件

config.write(open('user.ini', "w")) # 将添加的节点node写入配置文件

config.remove_section("node") # 删除一个节点,节点名为node, 删掉了内存中的节点node

config.write(open("user.ini", "w")) # 将删除节点node后的文件内容回写到配置文件

config.set("section1", "k1", "v1") # 在已存在的节点中添加一个键值对k1 = v1 ,如果该节点不存在则报错,如果key已经存在,则修改value

# configparser.NoSectionError: No section: 'section'

config.write(open("user.ini", "w"))

#!/usr/bin/env python

# coding=utf-8

__author__ = 'Luzhuo'

__date__ = '2017/5/26'

# config_configparser.py 配置文件

# configparser 可以读写和解析注释文件, 但是没有写入注释的功能

import configparser

import re

config_str = '''

# 配置文件信息案例

[DEFAULT]

minSdkVersion = 15

targetSdkVersion = 24

versionName = 1.0.0

server action = yes

[luzhuo.me]

user = luzhuo

# This is a comments.

[mysql]

ip = 127.0.0.1

port = 3306

'''

def config_write():

'''

生成配置文件, 字典的形式添加数据

'''

config = configparser.ConfigParser()

config['DEFAULT'] = {'minSdkVersion': '15',

'targetSdkVersion': '24',

'versionName': '1.0.0',

'server action': 'yes'}

config['luzhuo.me'] = {}

config['luzhuo.me']['user'] = 'luzhuo'

config['mysql'] = {}

topsecret = config['mysql']

topsecret['ip'] = '127.0.0.1'

topsecret['port'] = '3306'

with open('config.ini', 'w') as configfile:

config.write(configfile)

def config_read():

'''

解析配置文件

'''

# 读取

config = configparser.ConfigParser()

config.read('config.ini')

lists_header = config.sections() # 配置组名, ['luzhuo.me', 'mysql'] # 不含'DEFAULT'

print(lists_header)

boolean = 'luzhuo.me' in config # 配置组是否存在

boolean = config.has_section("luzhuo.me")

print(boolean)

user = config['luzhuo.me']['user']

print(user)

mysql = config['mysql']

mysql_ip = mysql['ip']

mysql_port = mysql['port']

print(mysql_ip, ":", mysql_port)

for key in config['luzhuo.me']: # 遍历配置组的key, 与'DEFAULT'组的key

print(key)

# 删除

sec = config.remove_section("luzhuo.me") # 删除

config.write(open("config.ini", "w")) # 写回去

# 添加

config.add_section("web.server")

config.write(open("config.ini", "w"))

# 修改/添加

config.set("web.server", "http", "http://luzhuo.me")

config.write(open("config.ini", "w"))

# 删除key

config.remove_option("mysql", "ip")

config.write(open("config.ini", "w"))

def config_func():

'''

写入的值均为字符串

配合文件的节名称区分大小写, 键不区分大小写(可任意缩进), 注释用'#'和';'(用作整行前缀,可缩进,不推荐行内注释), 值可以跨越多行(要缩进,慎用), 键值分隔符'='和':'

DEFAULT无法移除,试图删除将引发ValueError, clear()保持原样, popitem()不返回

'''

# --- ConfigParser 对象 ---

# 配置解析器, defaults:DEFAULT字典, dict_type:字典类型(默认:有序字典), allow_no_value:True是否接收不带值的选项(值为None),(默认False), delimiters:键值分隔符, comment_prefixes:整行注释符, inline_comment_prefixes:行内注释符(值之后), strict:是否去重:True(默认), empty_lines_in_values:值是否可以多行;(默认True),False(行标记选项的结尾), default_section:默认节的名称'DEFAULT', interpolation:插值, converters:转换器{类型转换器的名称, 从字符串转换所需数据的类型}{'dicimal': decimal.Decimal}

# class configparser.ConfigParser(defaults=None, dict_type=collections.OrderedDict, allow_no_value=False, delimiters=('=', ':'), comment_prefixes=('#', ';'), inline_comment_prefixes=None, strict=True, empty_lines_in_values=True, default_section=configparser.DEFAULTSECT, interpolation=BasicInterpolation(), converters={})

config = configparser.ConfigParser()

# items(raw=False, vars=None) # 所有节(含DEFAULT) ItemsView(section_name, section_proxy)(可遍历对象)

ItemsView = config.items()

dicts = config.defaults() # DEFAULT字典

lists = config.sections() # 可用的节列表(不含DEFAULT)

# has_section(section) # 是否存在该节

boolean = config.has_section("mysql")

lists = config.options("mysql") # 指定节的选项列表(含DEFAULT)

boolean = config.has_option("mysql", "ip") # 是否存在指定节的选项

# read(filenames, encoding=None) # 尝试读取和解析文件名列表(不存在则忽略), 加载初始值调用read_file()要在read()之前调用

config.read("config.ini", encoding="utf-8-sig") # windows下用记事本保存utf8格式要用utf-8-sig编码集

# read_file(f, source=None) # 从f读取和解析配置数据, source:文件名

config.read_file(open('config.ini', encoding="utf-8-sig"))

# read_string(string, source='<string>') # 从字符串解析配置数据

config.read_string(config_str)

# read_dict(dictionary, source='<dict>') # 读取字典

config.read_dict({'section1': {'key1': 'value1',

'key2': 'value2'},

'section2': {'key3': 'value3',

'key4': 'value4'}

})

# get(section, option, *, raw=False, vars=None[, fallback]) # 获取指定节的选项值, fallback:为找到选项时的返回值

data_str = config.get("mysql", "ip", fallback=None)

# getint(section, option, *, raw=False, vars=None[, fallback]) # 获取整数(选项的值强转为整数)

data_int = config.getint("mysql", "port", fallback=-1)

# getfloat(section, option, *, raw=False, vars=None[, fallback])

data = float = config.getfloat("mysql", "port", fallback=-1)

# getboolean(section, option, *, raw=False, vars=None[, fallback])

data_bool = config.getboolean("DEFAULT", "server action", fallback=False) # 获取布尔值,不区分大小写,识别'yes'/'no','on'/'off','true'/'false','1'/'0'

# write(fileobject, space_around_delimiters=True) # 将配置写入文件, space_around_delimiters:是否用空格分隔键值之间

config.write(open("config.ini", "w", encoding="utf-8"))

# add_section(section) # 添加节, 节重复DuplicateSectionError, 与默认节重复ValueError, 不是字符串TypeError

config.add_section("server.luzhuo.me")

# remove_section(section) # 删除节, 存在True,不存在False

boolean = config.remove_section("server.luzhuo.me")

# set(section, option, value) # 给指定的节设置值, 节不存在NoSectionError, option和value:选项和值为字符串,否则TypeError

config.set("server.luzhuo.me", "ip", "127.0.0.1")

# remove_option(section, option) # 删除选型, 不存在节NoSectionError, 选项存在True,不存在False

boolean = config.remove_option("server.luzhuo.me", "ip")

# optionxform(option) # 子类重写该方法, 或 config.optionxform = str(str区分大小写) 修改, 用于选项名称转为在内部结构中使用的实现

configparser.MAX_INTERPOLATION_DEPTH # 使用默认插值时, 当raw=false,get()递归插值的最大深度

config.clear() # 所有节都包含'DEFAULT'值,对节的清空不会删除'DEFAULT'值

config.BOOLEAN_STATES.update({'enabled': True, 'disabled': False}) # 自定义boolean的判断

config.SECTCRE = re.compile(r"\[ *(?P<header>[^]]+?) *\]") # 自定义节头的编译与解析的正则表达式(去除左右空格)

# --- 异常 ---

try: pass

except configparser.Error: pass # configparser异常的基类

except configparser.NoSectionError: pass # 未找到指定节

except configparser.DuplicateSectionError: pass # 节重复

except configparser.DuplicateOptionError: pass # 选项重复

except configparser.NoOptionError: pass # 未找到指定选项

except configparser.InterpolationError: pass # 插值异常的基类

except configparser.InterpolationDepthError: pass # 迭代次数超过MAX_INTERPOLATION_DEPTH

except configparser.InterpolationMissingOptionError: pass # 选项不存在

except configparser.InterpolationSyntaxError: pass # 替换源文本不符合语法

except configparser.MissingSectionHeaderError: pass # 没有节头

except configparser.ParsingError: pass # 解析文件错误

if __name__ == "__main__":

config_write()

config_read()

# config_func()

示例代码

https://www.cnblogs.com/dion-90/p/7978081.html

1. 简介

  configparser用于配置文件解析,可以解析特定格式的配置文件,多数此类配置文件名格式为XXX.ini,例如mysql的配置文件。在python3.X中

模块名为configparser ,在python2.X中使用的模块名为ConfigParser。

1

2

3

4

5

6

7

8

9

10

11

12

13

##### ini 文件示例 ########

 

[section1]      

name = wang

age = 18

  

[section2]

name:python

age = 19

 

#### 文件格式说明 #########

[XXX]  代表节点

XX = XX 或者 XX : XX 代表参数

2. 使用

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

import configparser       # 导入模块

config = configparser.ConfigParser()   # 创建对象

config.read("user.ini", encoding="utf-8")  # 读取配置文件,如果配置文件不存在则创建

# 查看

secs = config.sections()  # 获取所有的节点名称

print(secs)

# ['section1', 'section2']

options = config.options('section1')  # 获取指定节点的所有key

print(options)

# ['name', 'age']

item_list = config.items('section1')  # 获取指定节点的键值对

print(item_list)

#[('name', 'wang'), ('age', '18')]

val = config.get('section1''name')  # 获取指定节点的指定key的value

print(val)

# wang

val = config.getint('section1''age')  # 获取节点section1的age属性,属性需要是int型,否则ValueError

print(val)

# 18

val = config.has_section('section1')  # 检查指定节点是否存在,返回True或False

print(val)

# True

val = config.has_option('section1''age')  # 检查指定节点中是否存在某个key,返回True或False

print(val)

#True

 

# 增删改

config.add_section("node")  # 添加一个节点,节点名为node, 此时添加的节点node尚未写入文件

config.write(open('user.ini'"w"))  # 将添加的节点node写入配置文件

 

config.remove_section("node")  # 删除一个节点,节点名为node, 删掉了内存中的节点node

config.write(open("user.ini""w"))  # 将删除节点node后的文件内容回写到配置文件

 

config.set("section1""k1""v1")  # 在已存在的节点中添加一个键值对k1 = v1 ,如果该节点不存在则报错,如果key已经存在,则修改value

# configparser.NoSectionError: No section: 'section'

config.write(open("user.ini""w"))

以上是 Python3 configparser模块 的全部内容, 来源链接: utcz.com/z/387200.html

回到顶部