沈阳app制作网站建设推,360网站建设搜索,天津企业网站建设一条龙,郑州网站优化公司电话在软件开发过程中#xff0c;开发者常常需要利用一些固定的参数或常量。对于这些相对恒定且频繁使用的元素#xff0c;一种常见的做法是将它们集中存储在一个特定的文件中#xff0c;以避免在多个模块代码中重复定义#xff0c;从而维护核心代码的清晰度和整洁性。
具体而…在软件开发过程中开发者常常需要利用一些固定的参数或常量。对于这些相对恒定且频繁使用的元素一种常见的做法是将它们集中存储在一个特定的文件中以避免在多个模块代码中重复定义从而维护核心代码的清晰度和整洁性。
具体而言我们可以将这些固定元素编写成一个Python文件例如命名为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 ConfigParsercfg 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 ConfigParsercfg ConfigParser()
cfg.read(/Users/Bobot/db.ini)
db_cfg dict(cfg.items(localdb))con pymysql.connect(**db_cfg) json
json 格式可以说是我们常见的一种文件形式了也是目前在互联网较为流行的一种数据交换格式。除此之外json 有时也是配置文件的一种。
比如 npmJavaScript 包管理工具类似 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 jsonfrom pprint import pprintwith 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 格式大致如下 从这里可以看出 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 5charset utf8[mysql.fields]pandas_cols [ id, name, age, date]
紧接着我们就可以通过 toml 库中的 load() 方法来进行读取 import tomlimport osfrom pprint import pprintcfg 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页之多。 感兴趣的朋友可以再自行了解相关用法。
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.1port: 3306user: rootpassword: 123456database: testparameter:pool_size: 5charset: utf8fields:pandas_cols: - id- name- age- date
然后我们通过 safe_load() 方法进行解析 import osfrom pprint import pprintwith 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文件的读者而言一个直观的理解方式是通过Chrome浏览器访问任意网站随后按F12键进入开发者工具观察其中繁复的HTML元素这些元素在某种程度上可视作XML文件的缩影。
除了上述主流配置文件类型之外还存在如.cfg、.properties等格式的文件它们同样可作为配置文件使用。甚至如前文所述单独采用一个.py文件来编写各类配置信息并以此作为配置文件进行导入亦无不可。然而在跨语言共享配置信息时此类方法可能会面临一定的障碍。鉴于篇幅限制及主题聚焦本文对此类非主流配置文件类型不做过多阐述。对于对此类内容感兴趣的读者建议进一步自行深入研究。
