5 分钟掌握 Python 中常见的配置文件

图片

为什么要写配置文件

在开发过程中,吾们往往会用到一些固定参数或者是常量。对于这些较为固定且常用到的片面,往往会将其写到一个固定文件中,避免在分歧的模块代码中重复展现从而保持中央代码乾净。

这个固定文件吾们能够直接写成一个 .py 文件,例如 settings.py 或 config.py,云云的益处就是能够在联相符工程下直接始末 import 来导入当中的片面;但倘若吾们必要在其他非 Python 的平台进走配置文件共享时,写成单个 .py 就不是一个很益的选择。这时吾们就答该选择通用的配置文件类型来行为存储这些固定的片面。现在常用且通走的配置文件格式类型主要有 ini、json、toml、yaml、xml 等,这些类型的配置文件吾们都能够始末标准库或第三方库来进走解析。

ini

ini 即 Initialize 初起化之意,早期是在 Windows 上配置文件的存储格式。ini 文件的写法一般易懂,往往比较浅易,清淡由节(Section)、键(key)和值(value)构成,就像以下形态:

[localdb]host = 127.0.0.1user = rootpassword = 123456port = 3306database = mysql

Python 本身内置的 configparser 标准库,吾们直接就能够用来对 ini 文件进走解析。如吾们将上述内容保存在一个名为 db.ini 的文件中,然后行使 read() 手段来进走解析和读取,末了始末 items() 手段来获取指定节点下的一切键值对。

>>> from configparser import ConfigParser>>> cfg = ConfigParser()>>> cfg.read('/Users/Bobot/db.ini')['/Users/Bobot/db.ini']>>> cfg.items('localdb')[('host', '127.0.0.1'), ('user', 'root'), ('password', '123456'), ('port', '3306'), ('database', 'mysql')]

必要仔细的是,configparser 默认将值以字符串的形态表现,于是这也就是为什么吾们在 db.ini 文件中异国添引号而是直接将字面量写在上面的因为。

获取到键值对后,吾其实直接就将其转换成字典,然后始末解包的手段进走穿参,保持代码简洁:

#!pip install pymysqlimport pymysqlfrom configparser import ConfigParsercfg = ConfigParser()cfg.read('/Users/Bobot/db.ini')db_cfg = dict(cfg.items('localdb'))con = pymysql.connect(**db_cfg)json

json 格式能够说是吾们常见的一栽文件形态了,也是现在在互联网较为通走的一栽数据交换格式。除此之表,json 未必也是配置文件的一栽。

比如 npm(JavaScript 包管理工具相通 Python 的 pip)、以及微柔出品的现在被普及行使的 VSCode 编辑器,都行使 json 编写配置参数。

和 configparser 相通,Python 也内置了 json 标准库,能够始末 load() 和 loads() 手段来导入文件式和字符串的 json 内容。

{    'localdb':{        'host': '127.0.0.1',        'user': 'root',        'password': '123456',        'port': 3306,        'database': 'mysql'    }}

吾们将上述内容保存为 db.json 后进走读取休争析,json 库读取 json 文件相对浅易容易,而且很容易解析成 Python 的字典对象。

>>> import json>>> from pprint import pprint>>> >>> with open('/Users/Bobot/db.json') as j:...     cfg = json.load(j)['localdb']... >>> pprint(cfg){'database': 'mysql', 'host': '127.0.0.1', 'password': '123456', 'port': 3306, 'user': 'root'}

行使 json 文件配置的弱点就是语法标准厉格局限,为人所诟病之一的就是无法在当中写注解,除非采取 json 类型的其他超集行为替代方案(VSCode 中能写注解的 json 参数配置文件便是代替方案的一栽);同时存在嵌套过深的题目,容易导致出错,不宜用来写过长或复杂的参数配相新闻。

toml

toml 格式(或 tml 格式)是 Github 说相符创起人 Tom Preston-Werner 所挑出的一栽配置文件格式。按照维基百科的原料,toml 最开起挑出时是在 2013年7月份,距今已有七年时间;它在某些方面也与后面要谈到的 yaml 文件有些相通,但倘若当你晓畅 yaml 的规范有几十页(异国错,真的就是几十页……)的时候,能够你真的就不太情愿往写那么复杂的配置文件,toml 格式则倒是个不错的选择。

toml 格式大致如下:

图片

01-toml样式

从这边能够看出 toml 有点相通于前线所讲的 ini 文件。但是它比 ini 扩展了更众的内容。

在样例图片中吾们能够看到,除了基本的字符串以表,例如时间戳、布尔值、数组等都进一步声援,而且样式和 Python 的原生写法相等相通。

自然这边不会过众介绍 toml 格式的一些规范表明,有人已经对官方的规范文档进走了翻译,兴味味的同伴能够直接查阅。

这么契相符 Python 手段的配置文件类型已经有开发者造出了响答的「轮子」,现在在 Github 上 Stars 数最众的是则 uiri/toml 的版本,不过该版本仅始末了 v0.5 版本 toml 规范,但在行使上照样蛮简洁的,吾们能够始末 pip 命令进走安置

pip install toml

该库的解析手段很浅易,也有点相通于 json 库的解析用法,即始末load() 或 loads() 来进走解析;同理转换并导出也是同样相通的用法。

比如吾们现在将以下内容写入到 config.toml 中:

[mysql]host = '127.0.0.1'user = 'root'port = 3306database = 'test' [mysql.parameters] pool_size = 5 charset = 'utf8' [mysql.fields] pandas_cols = [ 'id', 'name', 'age', 'date']

紧接着吾们就能够始末 toml 库中的 load() 手段来进走读取:

>>> import toml>>> import os>>> from pprint import pprint>>> cfg = toml.load(os.path.expanduser('~/Desktop/config.toml'))>>> pprint(cfg){'mysql': {'database': 'test',           'fields': {'pandas_cols': ['id', 'name', 'age', 'date']},           'host': '127.0.0.1',           'parameters': {'charset': 'utf8', 'pool_size': 5},           'port': 3306,           'user': 'root'}}

能够看到 toml 文件被间接地转化成了字典类型,自然这也就是 json 版的写法(将单引号替换成双引号即可),方便吾们后续调用或者传参。

yaml

yaml 格式(或 yml 格式)是现在较为通走的一栽配置文件,它早在 2001 由一个名为 Clark Evans 的人挑出;同时它也是现在被普及行使的配置文件类型,典型的就是 Docker 容器里的 docker-compose.yml 配置文件,倘若频繁行使 Docker 进走安放的人对此不会生硬。

yaml 文件的设计从 Python、XML 等地方获取灵感,于是在行使时能很懂得地看到这些片面的影子。

在上一节 toml 内容里吾曾挑到,yaml 的规范内容能够说是冗长和复杂,足足有80页之众(斗尊强者,恐怖如斯……)。

图片

02-yaml规范页数

于是感趣味的同伴能够再自走晓畅相关用法。

YAML 官方早已经挑供了响答的 Python 库进走声援,即 PyYAML;自然也同样必要吾们事先辈走安置:

pip install pyyaml

同 json 库和 toml 库相通,始末 load() 手段来进走添载。

必要仔细的是,行使 load() 手段会存在必定的坦然隐患,从思科 Talos 的这份通知中吾们能够看到,倘若添载了未知或不信任的 yaml 文件,那么有能够会存在被抨击的风险和网络坦然隐患,由于它能够直接调用响答的 Python 函数来实走为抨击者所必要的命令,比如说在 yaml 文件中写入这么一段:

# 行使Linux和macOS的同伴不要容易尝试!!python/object/apply:os.system ['rm -rf /']

因此最益是行使 safe_load() 来代替 load() 手段。

这和 Python 内置的 string 标准库中 Template 类的 substitute() 模板手段相通存在着同样的坦然隐患,于是行使 safe_substitute() 来替代是相通的道理。

如吾们现在将之前的一些配相新闻写入 config.yaml 文件中:

mysql:  host: '127.0.0.1'  port: 3306  user: 'root'  password: '123456'  database: 'test'  parameter:    pool_size: 5    charset: 'utf8'  fields:    pandas_cols:       - id      - name      - age      - date

然后吾们始末 safe_load() 手段进走解析:

>>> import os>>> from pprint import pprint>>> >>> with open(os.path.expanduser('~/config.yaml'), 'r') as config:...     cfg = yaml.safe_load(config)... >>> pprint(cfg){'mysql': {'database': 'test',           'fields': {'pandas_cols': ['id', 'name', 'age', 'date']},           'host': '127.0.0.1',           'parameter': {'charset': 'utf8', 'pool_size': 5},           'password': '123456',           'port': 3306,           'user': 'root'}}

能够看到末了效果和前线的 toml 库的解析效果基原形反。

末了

本文列举了一些主流且常见的配置文件类型及其 Python 的读取手段,能够有的读者会发现当中异国 xml 格式类型的内容。对于 xml 配置文件能够与 Java 系说话打交道的同伴遇见得会众一些,但 xml 文件的可读性实在是让人看而生畏;对 xml 文件不晓畅的同伴能够行使 Chrome 涉猎器搪塞进入一个网站然后按下 F12 进入开发者后查看那密密麻麻的 html 元素便是 .xml 的缩影。

除了这些主流的配置文件类型之表,像一些 .cfg、.properties 等都能够行为配置文件,甚至和起头挑到的那样,你单独用一个 .py 文件来书写各类配相新闻行为配置文件进走导入都是没题目,只是在跨说话共享时能够会有些窒碍。因此本文就不过众介绍,感趣味的同伴能够进一步自走晓畅。

在本文里列举的配置文件类型其复杂性由上到下挨次增补:ini < json ≈ toml < yaml,它们之间各有优劣,能够按照本身实际的需乞降团队配相符请求来详细选择。

作者:100gle,演习时长不到两年的非郑重文科生一枚,爱敲代码、写写文章、捣鼓捣鼓各栽新事物;现从事相关大数据分析与发掘的相关做事。


posted @ posted @ 21-01-24 08:17  admin  阅读量:

Powered by 上海迪昊自动化科技有限公司 @2018 RSS地图 HTML地图