实用的 PyYAML 使用技巧
AML 是一个被广泛使用的数据序列化和配置语言,作为一个开发者,总是不免和它打交道。但处理 YAML 文档,尤其是使用 PyYAML 的过程总是非常痛苦。
这篇文章分享我在 Python 下使用 PyYAML 的技巧和代码片段,并介绍几个相关的库。
注意:本文中的代码仅保证在 Python 3 下正常工作
总是使用 safe_load/safe_dump
PyYAML 的 load 函数可以构造任意 Python 对象(Pickle 协议),这意味着一次 load 可能导致任意 Python 函数被执行。
为了确保应用程序的安全性,尽量在任何情况下使用 yaml.safe_load 和 yaml.safe_dump。
保留字段顺序
Python 3.7+ 中,dict keys 具备保留插入顺序的特性,所以通过 yaml.safe_load 得到的 dict,其 keys 顺序会与原始文件保持一致。
>>> import yaml
>>> text = """---
... c: 1
... b: 1
... d: 1
... a: 1
... """
>>> d = yaml.safe_load(text)
>>> d
{'c': 1, 'b': 1, 'd': 1, 'a': 1}
>>> list(d)
['c', 'b', 'd', 'a']
当把 dict 导出为 YAML 字符串时,为 yaml.safe_dump 传递 sort_keys=False 来保留 keys 的顺序。
>>> print(yaml.safe_dump(d))
a: 1
b: 1
c: 1
d: 1
>>> d['e'] = 1
>>> print(yaml.safe_dump(d, sort_keys=False))
c: 1
b: 1
d: 1
a: 1
e: 1
如果 Python 版本较低,或者你想确保代码能在更广泛的环境下工作,你可以使用 oyaml 库来代替 PyYAML 的 yaml 包。
>>> import oyaml as yaml
>>> d = yaml.safe_load(text)
>>> d
OrderedDict([('c', 1), ('b', 1), ('d', 1), ('a', 1)])
>>> d['e'] = 1
>>> print(yaml.safe_dump(d, sort_keys=False))
c: 1
b: 1
d: 1
a: 1
e: 1
优化列表项的缩进
默认情况下,PyYAML 输出的列表缩进与其父元素一致。
>>> d = {'a': [1, 2, 3]}
>>> print(yaml.safe_dump(d))
a:
- 1
- 2
- 3
这并不是很好的格式,根据 Ansible 和 HomeAssistant 等 YAML 书写规范,列表项应该缩进 2 空格。
这种格式也会对导致列表项不会被如 VSCode 等编辑器识别,进而无法使用编辑器的折叠功能。
要解决这个问题,使用如下代码片段,在代码中定义 IndentDumper class:
class IndentDumper(yaml.Dumper):def increase_indent(self, flow=False, indentless=False):return super(IndentDumper, self).increase_indent(flow, False)
然后将它传递给 yaml.dump 的 Dumper 关键字参数。
>>> print(yaml.dump(d, Dumper=IndentDumper))
a:- 1- 2- 3
注意,yaml.safe_dump 由于有自己的 Dumper class,传递此参数会造成冲突。
输出可读的 UTF-8 字符
默认情况下,PyYAML 假设你希望输出的结果里只有 ASCII 字符。
>>> d = {'a': '你好'}
>>> print(yaml.safe_dump(d))
a: "\u4F60\u597D"
这会让输出结果非常难以阅读。
在 UTF-8 足够普及的今天,直接输出 UTF-8 字符是非常安全的。因此我们可以将 allow_unicode=True 传入 yaml.safe_dump 使 PyYAML 将 Unicode 转换成 UTF-8 字符串。
>>> print(yaml.safe_dump(d, allow_unicode=True))
a: 你好
一些 YAML 相关的库
oyaml
Link: https://github.com/wimglenn/oyaml
正如上文中提到的,oyaml 是 yaml 包的替换品,使 dict keys 的顺序在 dump/load 的时候得以保留。
oyaml 是一个单文件库,只有 53 行代码,因此使用起来非常灵活,你可以直接把它的代码复制到自己的项目中,然后根据自己的需求进行修改。
strictyaml
Link: https://github.com/crdoconnor/strictyaml
有的人说 YAML 过于复杂和灵活,不是一个好的配置语言。但我认为这不是 YAML 的问题,而是使用方式的问题。如果我们限制程序只使用 YAML 的部分功能,YAML 其实可以变得像它设计的那般好用。
这就是 StrictYAML 的设计意图,它是一个类型安全的 YAML 解析器,实现了 YAML 规范说明中的一个子集 。
如果你对 YAML 的输入输出有较强的安全考虑,建议使用 StrictYAML 代替 PyYAML。
顺带一提的是,StrictYAML 的文档站有很多关于设计细节和配置语言思考的文章,非常值得一看。
ruamel.yaml
Link: https://yaml.readthedocs.io/en/latest/overview.html
ruamel.yaml 是 PyYAML 的一个分叉,于 2009 年发布并持续维护至今。
ruamel.yaml 的文档里详细说明了它和 PyYAML 的差异。总体来说,ruamel.yaml 专注在 YAML 1.2 上,对一些语法进行了优化。
ruamel.yaml 最令我感兴趣的特性是输入输出的 “round-trip”,可以最大程度地保留输入源的原始格式。官方文档中的定义是这样的:
A round-trip is a YAML load-modify-save sequence and ruamel.yaml tries to preserve, among others:
comments
block style and key ordering are kept, so you can diff the round-tripped source
flow style sequences ( ‘a: b, c, d’) (based on request and test by Anthony Sottile)
anchor names that are hand-crafted (i.e. not of the formidNNN)
merges in dictionaries are preserved
如果你有尽可能保留原始格式的需求,建议使用 ruamel.yaml 代替 PyYAML。
在使用中我注意到 ruamel.yaml 的 safe load 方法 (YAML(typ='safe').load) 与 PyYAML 有些不同,它无法解析 flow style 的集合定义 (如 a: {"foo": "bar"}),这点没有在文档中提及,使用时须多加注意。
总结
YAML 有它好的地方和坏的地方。它易于阅读,初期的学习曲线非常平缓。但 YAML 的规范说明非常复杂,不仅造成了使用中的混乱,也使不同语言的实现在很多细微的地方难以保持一致。
尽管有这些小毛病,YAML 仍然是我心中最好的配置语言。希望这篇文章所介绍的技巧能够帮助你避免问题,获得更好的开发和使用体验。
链接:https://reorx.com/blog/python-yaml-tips-zh/
实用的 PyYAML 使用技巧相关推荐
- 计算机的一些小操作,电脑小白操作中最实用的9个技巧!
原标题:电脑小白操作中最实用的9个技巧! 1.快速锁屏 在工作中,很多时候,我们需要暂时离开座位去做别的事情,但是又不想让他人动到我的电脑,也不让看到我的桌面资料.怎么办呢?很多人鼠标点击开始-关机- ...
- 办公技巧:分享12个实用的word小技巧,欢迎收藏!
今天给大家分享12个实用的word小技巧,希望对大家能有所帮助! 1. Word表格自动填充序号 在Word表格里选中要填入相同内容的单元格,单击"格式→项目符号和编号",进入&q ...
- 分享9个实用的电脑维修技巧,赶紧收藏吧!
今天给大家分享9个实用的电脑维修技巧,赶紧收藏吧! 01.电脑不能上网 常见原因1:新装系统无驱动 解决方法:需要下载驱动进行安装,可以先从其他设备下载拷贝到U盘安装. 常见原因2:DNS服务器 解决 ...
- 继续分享 5 个实用的 vs 调试技巧
前言 我在上一篇文章????<5 个非常实用的 vs 调试技巧> 中分享了 5 个我认为非常值得了解的 vs 调试技巧,本周继续分享 5 个很基础但同样实用的调试技巧. 1. 条件断点 作 ...
- 计算机办公软件的使用技巧,实用的Word小技巧集锦(1)办公软件知识 -电脑资料
一,把文字替换成图片 首先把图片复制到 剪贴板中,然后打开替换对话框,在"查找内容"框中输入将被替换的文字,接着在"替换为"框中输入"^c" ...
- 微信公众平台最实用的工具和技巧大集合
推荐语 这不是一篇纯工具的文章,还配有一些使用感受以及小技巧.微信公众平台的编辑本就是个累活儿,希望本文能够助你提高工作效率.下面是微信公众平台最实用的工具和技巧大集合 如果觉得有帮助,欢迎转发和收藏 ...
- excel打印预览在哪里_简单实用的excel打印技巧 建议收藏
打印也是需要技巧滴,一些简单实用的excel打印技巧送给你! 1.每页都打印相同标题 在打印时,第一页有标题,第二页及以后没有标题,造成阅读不便,如何使每页都打印相同标题呢? [页面布局]→[打印标题 ...
- 助你掌握搜索神器,10个实用的Elasticsearch查询技巧
前言 Elasticsearch是一个非常流行的搜索引擎,已经成为了许多企业的首选解决方案.然而,我们要想成为一个优秀的程序员,就必须掌握各种查询技巧.本文将向大家介绍10个实用的Elastics ...
- python实用大全pdf_超级实用干货|九大技巧,带你用Python玩转PDF
原标题:超级实用干货|九大技巧,带你用Python玩转PDF 尽管PDF最开始是由Adobe发明的,但它现在已经成为国际标准组织ISO维护的公开标准了.大家可以在Python中通过PyPDF2包来处理 ...
最新文章
- GAN的基本原理与入门应用!
- 暂时无法登陆GOOGLE,却依然可以用GOOGLE搜索--更多GOOGLE入口
- golang中的strings.SplitAfter
- WPF中的Attached Property
- kafka集群原理介绍
- android dialog 点击确定不消失,AlertDialog点击按钮不消失的实现方法
- 学生渐进片add如何给_渐进片的那些事「5」——验配之前的问诊
- 古墓新手机器人_古墓新手任务攻略 - 玩家乐园 - 北大侠客行MUD论坛 - Powered by Discuz!...
- 利用EditPlus制作Anki记忆卡批量导入文件
- bzoj 1984: 月下“毛景树”
- 用免费WiFi上网软件有什么好处
- win7浏览器主页修改不过来_Win7系统IE浏览器无法更改主页的具体解决方法
- 智联招聘 'python数据分析'职位分析第一篇
- 三季度国内光伏市场需求仍将强劲
- 计算机的开机键在哪里设置,笔记本电脑怎么开机 笔记本电脑开机键在哪
- 最新51CTO学院vue.js项目实战课程
- 图片大小、像素、分辨率之间的关系
- 可编程逻辑器件之按键消抖实验
- 互联网医疗的千姿百态:火热、亏损、巨头亲赖
- C++ MFC 学习笔记+小型通讯录系统实现
热门文章
- 使用MetaMask客户端获取以太坊测试网络ropsten测试币
- 合肥工业大学计算机学院加减分,合肥工业大学奖学金加减分细则(定稿修改)
- bss与data的区别
- 这么多的内置函数能记住吗?对python的68个内置函数分类总结!
- CSS 的弹性布局(flex) ,是什么?
- [LiteratureReview]EAO-SLAM Monocular Semi-Dense Object SLAM Based on Ensemble Data Association
- 【Sublime Text 3】Sublime Text 3 - cracked 3086
- 015 四路直流马达控制(麦克纳姆轮)
- 亚像素(Pixel)
- 裴波那契数列(循环实现递归)