返回顶部
首页 > 资讯 > 后端开发 > Python >超全!Python中常见的配置文件写法
  • 299
分享到

超全!Python中常见的配置文件写法

Python配置文件 2023-05-14 21:05:48 299人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

为什么要写配置文件这个固定文件我们可以直接写成一个 .py 文件,例如 settings.py 或 config.py,这样的好处就是能够在同一工程下直接通过 import 来导入当中的部分;但如果我们需要在其他非 python 的平台进行

超全!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.1
user = root
passWord = 123456
port = 3306
database = 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 pymysql
import pymysql
from configparser import ConfigParser
cfg = 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 格式大致如下:

超全!Python中常见的配置文件写法

从这里可以看出 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 = 3306
database = "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页之多。

超全!Python中常见的配置文件写法

所以感兴趣的朋友可以再自行了解相关用法。

YAML 官方早已经提供了相应的 Python 库进行支持,即 PyYAML;当然也同样需要我们事先进行安装:

pip install pyyaml

同 json 库和 toml 库一样,通过 load() 方法来进行加载。

需要注意的是,使用 load() 方法会存在一定的安全隐患,从思科 Talos 的这份报告中我们可以看到,如果加载了未知或不信任的 yaml 文件,那么有可能会存在被攻击的风险和网络安全隐患,因为它能够直接调用相应的 Python 函数来执行为攻击者所需要的命令,比如说在 yaml 文件中写入这么一段:

# 使用linuxMacOS的朋友不要轻易尝试
!!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,它们之间各有优劣,可以根据自己实际的需求和团队协作要求来具体选择。

以上就是超全!Python中常见的配置文件写法的详细内容,更多请关注编程网其它相关文章!

--结束END--

本文标题: 超全!Python中常见的配置文件写法

本文链接: https://www.lsjlt.com/news/205350.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • 超全!Python中常见的配置文件写法
    为什么要写配置文件这个固定文件我们可以直接写成一个 .py 文件,例如 settings.py 或 config.py,这样的好处就是能够在同一工程下直接通过 import 来导入当中的部分;但如果我们需要在其他非 Python 的平台进行...
    99+
    2023-05-14
    Python 配置文件
  • 超全!Python 中常见的配置文件写法
    为什么要写配置文件在开发过程中,我们常常会用到一些固定参数或者是常量。对于这些较为固定且常用到的部分,往往会将其写到一个固定文件中,避免在不同的模块代码中重复出现从而保持核心代码整洁。这个固定文件我们可以直接写成一个 .py 文件,例如 s...
    99+
    2023-05-14
    Python 配置文件
  • Python常见的配置文件写法有哪些
    本篇内容介绍了“Python常见的配置文件写法有哪些”的有关知识,在实际案例的操作过程中,不少人都会遇到这样的困境,接下来就让小编带领大家学习一下如何处理这些情况吧!希望大家仔细阅读,能够学有所成!为什么要写配置文件在开发过程中,我们常常会...
    99+
    2023-07-02
  • Python3中常见配置文件写法汇总
    目录1、引言2、配置文件写法2.1 ini2.2 json2.3 toml2.4 yaml3、总结1、引言 小鱼:小屌丝,走啊,出去撸串啊, 小屌丝:没时间啊,鱼哥 小鱼:嗯??? ...
    99+
    2024-04-02
  • Python 常见的配置文件写法梳理汇总
    目录前言为什么要写配置文件inijsontomlyaml结尾前言 在本文里列举的配置文件类型其复杂性由上到下依次增加:ini < json ≈ toml < ...
    99+
    2024-04-02
  • Python中有哪些常见的配置文件
    这篇文章将为大家详细讲解有关Python中有哪些常见的配置文件,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。 为什么要写配置文件在开发过程中,我们常常会用到一些固定参数或者是常量。...
    99+
    2023-06-15
  • 超实用 nginx 中常见的配置合集
    ✨ 目录 🎈 封禁 IP🎈 仅开放内网🎈 负载均衡🎈 列出文件列表🎈 路由转发🎈 开启...
    99+
    2023-09-04
    nginx 服务器 运维 经验分享 原力计划
  • Python读写EXCEL文件常用方法大全
    python读写excel的方式有很多,不同的模块在读写的讲法上稍有区别,这里我主要介绍几个常用的方式。 用xlrd和xlwt进行excel读写;用openpyxl进行excel读写;用pandas进行excel读写; 一、数据准备 为了方...
    99+
    2023-09-01
    python pandas 数据分析
  • Vue中.prettierrc文件的常见配置(浅显易懂)
    目录.prettierrc文件常见配置.prettierrc文件的作用.prettierrc文件常见配置 当我们使用右键格式化的时候,就会自动帮我们补全符号,但是,有些符号在esli...
    99+
    2022-11-13
    Vue中.prettierrc文件 .prettierrc文件常见配置 Vue prettierrc配置
  • Python中怎么读写配置文件
    Python中怎么读写配置文件,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。python 读写配置文件ConfigParser模块是python自带的读取配置文件的模块.通...
    99+
    2023-06-17
  • Python中ini配置文件读写的实现
    导入模块 import configparser # py3 写入 config = configparser.ConfigParser() config["DEFAULT"] ...
    99+
    2024-04-02
  • Python常用配置文件ini、json、yaml读写总结
    本文参考文章,出于学习目的,写本文。 开发项目时,为了维护一些经常需要变更的数据,比如数据库的连接信息、请求的url、测试数据等,需要将这些数据写入配置文件,将数据和代码分离,只需要...
    99+
    2024-04-02
  • python读取/写入配置文件ini方法
    在写测试脚本时,经常有一些需要变动的数据,可以单独放在ini文件里,然后读取传递给 相应的函数,这样程序操作更灵活。具体的方法介绍如下: 文件结构: Cofig.ini内容:[test1]ip = 10.10.10.10 [test2]po...
    99+
    2023-01-31
    配置文件 方法 python
  • 超实用的Nginx常见配置合集分享
    目录封禁 IP仅开放内网负载均衡列出文件列表路由转发开启 gzip 压缩解决跨域资源防盗链Keepalived 提高吞吐量HTTP 强制跳转 HTTPS封禁 IP 通过 deny 可...
    99+
    2024-04-02
  • 全网非常详细的pytest配置文件
    目录更改默认命令行选项注册标记来防止拼写错误指定pytest的最低版本号指定pytest忽略某些目录指定测试目录更改测试搜索的规则python_classespython_files...
    99+
    2024-04-02
  • Python的ini配置文件怎么写入
    本文小编为大家详细介绍“Python的ini配置文件怎么写入”,内容详细,步骤清晰,细节处理妥当,希望这篇“Python的ini配置文件怎么写入”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。INI介绍INI是英文...
    99+
    2023-06-29
  • Linux常用的配置文件保存位置大全
    这篇文章主要介绍“Linux常用的配置文件保存位置大全”,在日常操作中,相信很多人在Linux常用的配置文件保存位置大全问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”Linux常用的配置文件保存位置大全”的疑...
    99+
    2023-06-13
  • app.json文件全局配置的方法
    本文小编为大家详细介绍“app.json文件全局配置的方法”,内容详细,步骤清晰,细节处理妥当,希望这篇“app.json文件全局配置的方法”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。  app.json文件用...
    99+
    2023-06-26
  • javascript中常见的兼容写法
    这篇文章主要讲解了“javascript中常见的兼容写法”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“javascript中常见的兼容写法”吧!1 .获取后...
    99+
    2024-04-02
  • redis配置文件中常用配置详解
    此次安装的版本为: 5.0.3 [root@localhost local]# redis-server --version Redis server v=5.0.3 sha=0...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作