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
  1. 配置文件分为

    • section 使用方括号包裹的名称,区分大小写
    • option 你可以理解为变量名称,option及其对应的值,不区分大小写
  2. 配置文件中的键值对可以使用=或者:进行连接,但推荐使用=,为什么?因为=不会出现中文符号的异常问题!比如下面的报错:

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

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

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

    • DEFAULT不会再conf.section()中显示
    • 它类似于python的继承,默认子section都会具备DEFAULT的内容。当子section中出现与DEFAULT同名的键,会覆盖DEFAULT的原始内容
  5. key:value中value可以存在多行,比如例子中的version,但换行后的内容,切记不可定格写,不然会被认为是key,而导致报错。

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

  7. 配置文件支持%(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

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

The End

期待你关注我的公众号清风Python,如果你觉得不错,希望能动动手指转发给你身边的朋友们。
我的github地址:https://github.com/BreezePython

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容