云社区 博客 博客详情
云社区 博客 博客详情

python读写配置文件使用总结与避坑指南

技术火炬手 发表于 2019-06-12 15:44:41 06-12 15:44
技术火炬手 发表于 2019-06-12 15:44:41 2019/06/12
0
1

【摘要】 最近拿python在写项目部署的相关集成代码,本来两天的工作量,硬是在来回的需求变更中,拖到了一周的时间。今天算是暂时告一段落了。这次由于涉及多个系统的调用和配置参数,代码开发中出现了较多之前未发现或者说没暴露出来的问题,今天针对这些知识点进行相关的复习与总结。

原创: 王翔丨 清风Python

Python 配置文件管理

configparser是python推荐使用的配置文件管理模块,但坦白说它真的不怎么好用,使用yaml、json等格式的存储,在多层级数据存储上,效率要比它高很多。但存在即合理,不是所有人都会使用yaml的格式,至于json的格式,很容易导致确实括号等问题,最终json.loads时报错....

关于命名:

python2中模块叫:ConfigParser

python3中更名为:configparser

eg:其实有时候懒得写2和3的差别,但很多公司或者团队至今还在使用python2,然后一导入报错,就说是我的内容写的有问题,心累....

先来看看它的基本使用:

我们首先的定义一个配置文件:

[DEFAULT]
path = /home/python
version = 3.6.8
    Beta1
author = Qing_Feng_Python
number = 13

[Mysql]
creator = pymysql
host = 127.0.0.1
port = 3306
user = root
password = 123
database = mysqlDB
status = off
uri = %(user)s@%(host)s:%(port)s/%(database)s

配置文件分为

section 使用方括号包裹的名称,区分大小写

option 你可以理解为变量名称,option及其对应的值,不区分大小写

配置文件中的键值对可以使用=或者:进行连接,但推荐使用=,为什么?因为=不会出现中文符号的异常问题!比如下面的报错:

configparser.ParsingError: Source contains parsing errors: 'config.ini'

键值对的分隔符及行首、行尾的空格会被strip()掉

关于DEFAULT,这个section几乎在每个配置文件中都会出现

DEFAULT不会再conf.section()中显示

它类似于python的继承,默认子section都会具备DEFAULT的内容。当子section中出现与DEFAULT同名的键,会覆盖DEFAULT的原始内容

key:value中value可以存在多行,比如例子中的version,但换行后的内容,切记不可定格写,不然会被认为是key,而导致报错。

配置文件中的value不管是int还是str亦或者表面看起来的列表[1,2,3]或者字典样式{"name":"Urnaus"}都会被认为是str字符串类型。所以配置文件中,切记不要使用列表的样式,推荐使用json格式,这样可以通过json模块进行字典的转换

配置文件支持%(key)s的变量解析能力,些许的类似python....

说完了配置文件,再来说说怎么读取配置文件吧:

# -*- coding: utf-8 -*-
# @Author   : 王翔
# @JianShu  : 清风Python
# @Date     : 2019/6/8 22:30
# @Software : PyCharm
# @version  :Python 3.6.8
# @File     : PythonConfig.py
import configparser
# 初始化
conf = configparser.ConfigParser()
# 读取配置文件
conf.read('config.ini', encoding='utf-8')

# 获得配置文件中的所有sections
print(conf.sections())
# section是区分大小写的,写成小写会被认为不存在
print(conf.has_section('mysql'))

# 获取section = Mysql 下的所有options,即keys
print(conf.options('Mysql'))
# option 不区分大小写,判断结果为True
print(conf.has_option('Mysql', 'DATABASE'))

# 获取section = Mysql 下的所有键值对
print(conf.items('Mysql'))

# 获取section=Mysql下host键对应的value值
# get方法通过不同类型,存在getint、getfloat、getboolean 不同的类型
# 其中getboolean 可以识别 true/false、 1/0、yes/no、 on/off
print(conf.get('Mysql', 'host'))
print(conf.getboolean('Mysql', 'status'))
print(conf.get('Mysql', 'uri'))

# 删除键值对,同样的还设有remove_section(section)就不演示了...
# conf.remove_section('Mysql')
conf.remove_option('Mysql', 'status')

# 我们添加了section为Python,并创建了tools=Pycharm
# 打印显示正常,但是配置文件中,并没有
conf.add_section('Python')
conf.set("Python", "tools", "Pycharm")
print(conf.get("Python", "tools"))
# 此时的配置保存在内存中,需要写入文件方可生效
with open("config.ini", "w+") as f:
    conf.write(f)

output:
['Mysql']

False

['creator', 'host', 'port', 'user', 'password', 'database', 'status', 'uri', 'path', 'version', 'author', 'number']

True

[('path', '/home/python'), ('version', '3.6.8\nBeta1'), ('author', 'Qing_Feng_Python'), ('number', '13'), ('creator', 'pymysql'), ('host', '127.0.0.1'), ('port', '3306'), ('user', 'root'), ('password', '123'), ('database', 'mysqlDB'), ('status', 'off'), ('uri', 'root@127.0.0.1:3306/mysqlDB')]

127.0.0.1

False

root@127.0.0.1:3306/mysqlDB

Pycharm

大家可以看到,获取option和items的时候,默认将DEFAULT中的参数也继承进去了。

最后一行的变量解析,也正常显示...

最后的写入一定要切记,很多时候只是在内存中进行了添加删除,而未进行文件写入,最终白玩一场....

关于列表的坑

在配置文件的存储时我用到了列表,类似如下方式:

index_list = [.......]

if x not  in index_list:
    index_list.append(x)
else:
    pass

一段很平常的代码,然后呢?问题让我定位了好久,直接看个例子吧:

>>> index_list = [1,2,3]
>>> 2.0 not in index_list
False

其实这种情况在python中是普遍存在的,比如字典中

default_dict ={1:1,2:2}
default_dict[1.0]=2
default_dict
{1: 2, 2: 2}

为什么?python字典的key存储时,比较哈希值来确定两个键是否相同的

hash(1)==hash(1.0)
True

对于这些坑,你必须牢记在心,不然坑你没商量....

好了,今天的内容就到这里,如果觉得有帮助,记得点赞支持。欢迎大家关注我的公众号【清风Python】,

公众号内有整理好的各类福利数据供大家下载,扫码关注:

image.png


---------

阅读原文

登录后可下载附件,请登录或者注册

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区),文章链接,文章作者等基本信息,否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件至:huaweicloud.bbs@huawei.com进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容。
评论文章 //点赞 收藏 1
点赞
分享文章到微博
分享文章到朋友圈

评论 (0)


0/1000
评论

登录后可评论,请 登录注册

评论

您没有权限执行当前操作

温馨提示

您确认删除评论吗?

确定
取消
温馨提示

您确认删除评论吗?

删除操作无法恢复,请谨慎操作。

确定
取消
温馨提示

您确认删除博客吗?

确定
取消

确认删除

您确认删除博客吗?

确认删除

您确认删除评论吗?

温馨提示

登录超时或用户已下线,请重新登录!!!

确定
取消