third_party_pyyaml/README.md
xuyong f3cee100d0 modify spelling error
Signed-off-by: xuyong <xuyong59@huawei.com>
2022-01-05 15:18:31 +08:00

1.8 KiB
Raw Blame History

PyYAML

PyYAML是一套基于Python实现的全能YAML处理框架。

安装

您可以通过执行python setup.py install完成LibYAML的安装。

默认情况下,setup.py会检查LibYAML是否已安装在LibYAML已安装的情况下会自动构建及安装LibYAML bindings。

如果想忽略相应的检查直接安装LibYAML bindings可以执行以下命令

--with-libyaml: python setup.py --with-libyaml install

如果想关闭检查且忽略构建及安装LibYAML bindings可以执行以下命令

--without-libyaml: python setup.py --without-libyaml install

当LibYAML bindings成功安装之后你可以按照以下方式进行YAML流的加载解析

>>> yaml.load(stream, Loader=yaml.CLoader)
>>> yaml.dump(data, Dumper=yaml.CDumper)

如果您不是很信任某个YAML输入流可以通过安全模式进行加载

>>> yaml.safe_load(stream)

测试

PyYAML包含完整的测试套件您可以通过执行 python setup.py test可以完成相应的测试用例的执行。

更多信息

  • 如果您想获取更多关于PyYAML的信息可以访问PyYAML官网PyYAML homepagePyYAML tutorial and reference

  • 您也可以通过Matrix或者IRC #pyyaml irc.libera.chat 和PyYAML的维护人员讨论问题。

  • 您也可以通过访问PyYAML bug tracker来提交您发现的关于PyYAML的任何Bug或者您想增加的新特性。

协议

PyYAML模块由Kirill Simonov xi@resolvent.net编码实现目前由YAML和Python社区负责维护。

PyYAML基于MIT协议发布更多协议相关的内容可以访问LICENSE文件。