ruamel.yaml.string 0.1.1

ruamel.yaml.string

版本:

0.1.1

更新时间:

2023-05-02

此插件向ruamel.yaml.YAML实例添加了一个方法dump_to_string（及其等效的dumps），该方法将文档作为Python字符串返回。

安装

可以使用以下方式从PyPI安装此模块

pip install ruamel.yaml.string

此模块依赖于ruamel.yaml，因此您不需要明确使您的模块依赖于两者。

使用方法

import ruamel.yaml

yaml = ruamel.yaml.YAML(typ=['rt', 'string'])
data  = dict(abc=42, help=['on', 'its', 'way'])
print('retval', yaml.dump_to_string(data))
print('>>>> done')

它给出

retval abc: 42
help:
- on
- its
- way
>>>> done

请注意，返回的字符串末尾没有添加换行符。原因是print()函数默认添加换行符。（这与使用PyYAML的dump不同，例如，文档（2021）中各种print dump(data)示例的输出未能清楚地显示示例输出末尾的双换行符。它与返回不带最终换行符的字符串的json.dumps(data, indent=2)类似。）

另一种方法是第一个print调用可以是

print('retval', yaml.dump_to_string(data, add_final_eol=True), end='')

效果相同。

可以将.dump_to_string()简写为.dumps()

直接使用yaml.dump(data, sys.stdout)将数据写入sys.stdout比打印yaml.dumps(data)的结果更高效

更改日志

0.1.1 (2023-05-02):

• 添加了输入和readme修正

0.1.0 (2022-03-17):

• 初始插件版本