详解Python利用configparser对配置文件进行读写操作


Posted in Python onNovember 03, 2020

简介

想写一个登录注册的demo,但是以前的demo数据都写在程序里面,每一关掉程序数据就没保存住。。
于是想着写到配置文件里好了
Python自身提供了一个Module - configparser,来进行对配置文件的读写

Configuration file parser.
A configuration file consists of sections, lead by a “[section]” header,
and followed by “name: value” entries, with continuations and such in
the style of RFC 822.

Note The ConfigParser module has been renamed to configparser in Python 3. The 2to3 tool will automatically adapt imports when converting your sources to Python 3.

在py2中,该模块叫ConfigParser,在py3中把字母全变成了小写。本文以py3为例

ConfigParser的属性和方法

ConfigParser -- responsible for parsing a list of
   configuration files, and managing the parsed database.
 
 methods:
 
 __init__(defaults=None, dict_type=_default_dict, allow_no_value=False,
  delimiters=('=', ':'), comment_prefixes=('#', ';'),
  inline_comment_prefixes=None, strict=True,
  empty_lines_in_values=True, default_section='DEFAULT',
  interpolation=<unset>, converters=<unset>):
 Create the parser. When `defaults' is given, it is initialized into the
 dictionary or intrinsic defaults. The keys must be strings, the values
 must be appropriate for %()s string interpolation.
 
 When `dict_type' is given, it will be used to create the dictionary
 objects for the list of sections, for the options within a section, and
 for the default values.
 
 When `delimiters' is given, it will be used as the set of substrings
 that divide keys from values.
 
 When `comment_prefixes' is given, it will be used as the set of
 substrings that prefix comments in empty lines. Comments can be
 indented.
 
 When `inline_comment_prefixes' is given, it will be used as the set of
 substrings that prefix comments in non-empty lines.
 
 When `strict` is True, the parser won't allow for any section or option
 duplicates while reading from a single source (file, string or
 dictionary). Default is True.
 
 When `empty_lines_in_values' is False (default: True), each empty line
 marks the end of an option. Otherwise, internal empty lines of
 a multiline option are kept as part of the value.
 
 When `allow_no_value' is True (default: False), options without
 values are accepted; the value presented for these is None.
 
 When `default_section' is given, the name of the special section is
 named accordingly. By default it is called ``"DEFAULT"`` but this can
 be customized to point to any other valid section name. Its current
 value can be retrieved using the ``parser_instance.default_section``
 attribute and may be modified at runtime.
 
 When `interpolation` is given, it should be an Interpolation subclass
 instance. It will be used as the handler for option value
 pre-processing when using getters. RawConfigParser objects don't do
 any sort of interpolation, whereas ConfigParser uses an instance of
 BasicInterpolation. The library also provides a ``zc.buildbot``
 inspired ExtendedInterpolation implementation.
 
 When `converters` is given, it should be a dictionary where each key
 represents the name of a type converter and each value is a callable
 implementing the conversion from string to the desired datatype. Every
 converter gets its corresponding get*() method on the parser object and
 section proxies.
 
 sections()
 Return all the configuration section names, sans DEFAULT.
 
 has_section(section)
 Return whether the given section exists.
 
 has_option(section, option)
 Return whether the given option exists in the given section.
 
 options(section)
 Return list of configuration options for the named section.
 
 read(filenames, encoding=None)
 Read and parse the iterable of named configuration files, given by
 name. A single filename is also allowed. Non-existing files
 are ignored. Return list of successfully read files.
 
 read_file(f, filename=None)
 Read and parse one configuration file, given as a file object.
 The filename defaults to f.name; it is only used in error
 messages (if f has no `name' attribute, the string `<???>' is used).
 
 read_string(string)
 Read configuration from a given string.
 
 read_dict(dictionary)
 Read configuration from a dictionary. Keys are section names,
 values are dictionaries with keys and values that should be present
 in the section. If the used dictionary type preserves order, sections
 and their keys will be added in order. Values are automatically
 converted to strings.
 
 get(section, option, raw=False, vars=None, fallback=_UNSET)
 Return a string value for the named option. All % interpolations are
 expanded in the return values, based on the defaults passed into the
 constructor and the DEFAULT section. Additional substitutions may be
 provided using the `vars' argument, which must be a dictionary whose
 contents override any pre-existing defaults. If `option' is a key in
 `vars', the value from `vars' is used.
 
 getint(section, options, raw=False, vars=None, fallback=_UNSET)
 Like get(), but convert value to an integer.
 
 getfloat(section, options, raw=False, vars=None, fallback=_UNSET)
 Like get(), but convert value to a float.
 
 getboolean(section, options, raw=False, vars=None, fallback=_UNSET)
 Like get(), but convert value to a boolean (currently case
 insensitively defined as 0, false, no, off for False, and 1, true,
 yes, on for True). Returns False or True.
 
 items(section=_UNSET, raw=False, vars=None)
 If section is given, return a list of tuples with (name, value) for
 each option in the section. Otherwise, return a list of tuples with
 (section_name, section_proxy) for each section, including DEFAULTSECT.
 
 remove_section(section)
 Remove the given file section and all its options.
 
 remove_option(section, option)
 Remove the given option from the given section.
 
 set(section, option, value)
 Set the given option.
 
 write(fp, space_around_delimiters=True)
 Write the configuration state in .ini format. If
 `space_around_delimiters' is True (the default), delimiters
 between keys and values are surrounded by spaces.

配置文件的数据格式

下面的config.ini展示了配置文件的数据格式,用中括号[]括起来的为一个section例如Default、Color;每一个section有多个option,例如serveraliveinterval、compression等。
option就是我们用来保存自己数据的地方,类似于键值对 optionname = value 或者是optionname : value (也可以设置允许空值)

[Default]
serveraliveinterval = 45
compression = yes
compressionlevel = 9
forwardx11 = yes
values like this: 1000000
or this: 3.14159265359
[No Values]
key_without_value
empty string value here =

[Color]
isset = true
version = 1.1.0
orange = 150,100,100
lightgreen = 0,220,0

数据类型

在py configparser保存的数据中,value的值都保存为字符串类型,需要自己转换为自己需要的数据类型

Config parsers do not guess datatypes of values in configuration files, always storing them internally as strings. This means that if you need other datatypes, you should convert on your own:

例如

>>> int(topsecret['Port'])
50022
>>> float(topsecret['CompressionLevel'])
9.0

常用方法method

打开配置文件

import configparser

file = 'config.ini'

# 创建配置文件对象
cfg = configparser.ConfigParser(comment_prefixes='#')
# 读取配置文件
cfg.read(file, encoding='utf-8')

这里只打开不做什么读取和改变

读取配置文件的所有section

file处替换为对应的配置文件即可

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')

# 获取所有section
sections = cfg.sections()
# 显示读取的section结果
print(sections)

判断有没有对应的section!!!

当没有对应的section就直接操作时程序会非正常结束

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')
if cfg.has_section("Default"): # 有没有"Default" section
 print("存在Defaul section")
else:
	print("不存在Defaul section")

判断section下对应的Option

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')
# 检测Default section下有没有"CompressionLevel" option
if cfg.cfg.has_option('Default', 'CompressionLevel'): 
 print("存在CompressionLevel option")
else:
	print("不存在CompressionLevel option")

添加section和option

最最重要的事情: 最后一定要写入文件保存!!!不然程序修改的结果不会修改到文件里

  • 添加section前要检测是否存在,否则存在重名的话就会报错程序非正常结束
  • 添加option前要确定section存在,否则同1

option在修改时不存在该option就会创建该option

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')

if not cfg.has_section("Color"): # 不存在Color section就创建
 cfg.add_section('Color')

# 设置sectin下的option的value,如果section不存在就会报错
cfg.set('Color', 'isset', 'true')
cfg.set('Color', 'version', '1.1.0') 
cfg.set('Color', 'orange', '150,100,100')

# 把所作的修改写入配置文件
with open(file, 'w', encoding='utf-8') as configfile:
 cfg.write(configfile)

删除option

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')

cfg.remove_option('Default', 'CompressionLevel'

# 把所作的修改写入配置文件
with open(file, 'w', encoding='utf-8') as configfile:
 cfg.write(configfile)

删除section

删除section的时候会递归自动删除该section下面的所有option,慎重使用

import configparser

file = 'config.ini'
cfg = configparser.ConfigParser(comment_prefixes='#')
cfg.read(file, encoding='utf-8')

cfg.remove_section('Default')

# 把所作的修改写入配置文件
with open(file, 'w', encoding='utf-8') as configfile:
 cfg.write(configfile)

实例

创建一个配置文件

import configparser

file = 'config.ini'

# 创建配置文件对象
cfg = configparser.ConfigParser(comment_prefixes='#')
# 读取配置文件
cfg.read(file, encoding='utf-8')```

# 实例
## 创建一个配置文件
下面的demo介绍了如何检测添加section和设置value
```python
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
'''
@File : file.py
@Desc : 使用configparser读写配置文件demo
@Author : Kearney
@Contact : 191615342@qq.com
@Version : 0.0.0
@License : GPL-3.0
@Time : 2020/10/20 10:23:52
'''
import configparser

file = 'config.ini'

# 创建配置文件对象
cfg = configparser.ConfigParser(comment_prefixes='#')
# 读取配置文件
cfg.read(file, encoding='utf-8')

if not cfg.has_section("Default"): # 有没有"Default" section
 cfg.add_section("Default") # 没有就创建

# 设置"Default" section下的option的value
# 如果这个section不存在就会报错,所以上面要检测和创建
cfg.set('Default', 'ServerAliveInterval', '45')
cfg.set('Default', 'Compression', 'yes')
cfg.set('Default', 'CompressionLevel', '9')
cfg.set('Default', 'ForwardX11', 'yes')

if not cfg.has_section("Color"): # 不存在Color就创建
 cfg.add_section('Color')

# 设置sectin下的option的value,如果section不存在就会报错
cfg.set('Color', 'isset', 'true')
cfg.set('Color', 'version', '1.1.0') 
cfg.set('Color', 'orange', '150,100,100')
cfg.set('Color', 'lightgreen', '0,220,0')

if not cfg.has_section("User"): 
 cfg.add_section('User')

cfg.set('User', 'iscrypted', 'false')
cfg.set('User', 'Kearney', '191615342@qq.com')
cfg.set('User', 'Tony', 'backmountain@gmail.com')

# 把所作的修改写入配置文件,并不是完全覆盖文件
with open(file, 'w', encoding='utf-8') as configfile:
 cfg.write(configfile)

跑上面的程序就会创建一个config.ini的配置文件,然后添加section和option-value
文件内容如下所示

[Default]
serveraliveinterval = 45
compression = yes
compressionlevel = 9
forwardx11 = yes

[Color]
isset = true
version = 1.1.0
orange = 150,100,100
lightgreen = 0,220,0

[User]
iscrypted = false
kearney = 191615342@qq.com
tony = backmountain@gmail.com

References

到此这篇关于详解Python利用configparser对配置文件进行读写操作的文章就介绍到这了,更多相关Python configparser配置文件读写内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

Python 相关文章推荐
使用python实现扫描端口示例
Mar 29 Python
python使用装饰器和线程限制函数执行时间的方法
Apr 18 Python
Python3安装Pymongo详细步骤
May 26 Python
目前最全的python的就业方向
Jun 05 Python
详解Django的model查询操作与查询性能优化
Oct 16 Python
python修改txt文件中的某一项方法
Dec 29 Python
python反编译学习之字节码详解
May 19 Python
使用Python制作缩放自如的圣诞老人(圣诞树)
Dec 25 Python
python numpy生成等差数列、等比数列的实例
Feb 25 Python
Jupyter notebook设置背景主题,字体大小及自动补全代码的操作
Apr 13 Python
python 使用tkinter与messagebox写界面和弹窗
Mar 20 Python
基于Python实现股票收益率分析
Apr 02 Python
Python抓包并解析json爬虫的完整实例代码
Nov 03 #Python
python中not、and和or的优先级与详细用法介绍
Nov 03 #Python
如何基于Python按行合并两个txt
Nov 03 #Python
Python txt文件如何转换成字典
Nov 03 #Python
Python headers请求头如何实现快速添加
Nov 03 #Python
python time()的实例用法
Nov 03 #Python
Python-openpyxl表格读取写入的案例详解
Nov 02 #Python
You might like
simplehtmldom Doc api帮助文档
2012/03/26 PHP
一个选择最快的服务器转向代码
2009/04/27 Javascript
jquery中输入验证中一个不错的效果
2010/08/21 Javascript
表单JS弹出填写提示效果代码
2011/04/16 Javascript
循环 vs 递归浅谈
2013/02/28 Javascript
用javascript读取xml文件读取节点数据
2014/08/12 Javascript
微信小程序 框架详解及实例应用
2016/09/26 Javascript
微信小程序 数据绑定及运算的简单实例
2017/09/20 Javascript
react.js 父子组件数据绑定实时通讯的示例代码
2017/09/25 Javascript
Vue 使用 Mint UI 实现左滑删除效果CellSwipe
2018/04/27 Javascript
vue组件name的作用小结
2018/05/23 Javascript
解决bootstrap模态框数据缓存的问题方法
2018/08/10 Javascript
JavaScript函数Call、Apply原理实例解析
2020/02/17 Javascript
Vue2.4+新增属性.sync、$attrs、$listeners的具体使用
2020/03/08 Javascript
Vue项目打包压缩的实现(让页面更快响应)
2020/03/10 Javascript
详解JavaScript中分解数字的三种方法
2021/01/05 Javascript
vue 使用 v-model 双向绑定父子组件的值遇见的问题及解决方案
2021/03/01 Vue.js
浅谈numpy数组中冒号和负号的含义
2018/04/18 Python
python的concat等多种用法详解
2018/11/28 Python
浅谈python requests 的put, post 请求参数的问题
2019/01/02 Python
python顺序执行多个py文件的方法
2019/06/29 Python
Python中最好用的命令行参数解析工具(argparse)
2019/08/23 Python
简单了解python中的f.b.u.r函数
2019/11/02 Python
Python list与NumPy array 区分详解
2019/11/06 Python
Python数据分析pandas模块用法实例详解
2019/11/20 Python
打架检讨书100字
2014/01/19 职场文书
最新奶茶店创业计划书
2014/01/25 职场文书
货车司机岗位职责
2014/03/18 职场文书
大学生村官演讲稿
2014/04/25 职场文书
计算机系统管理员求职信
2014/06/20 职场文书
委托书的格式
2014/08/01 职场文书
党员自我剖析材料范文
2014/10/06 职场文书
2015年综治宣传月活动总结
2015/03/25 职场文书
员工加薪申请报告
2015/05/15 职场文书
创业计划书介绍
2019/04/24 职场文书
使用golang编写一个并发工作队列
2021/05/08 Golang