ruamel yaml文档预处理器

ryd的Python项目详细描述


示例

"normal" .ryd 文件由一个文件中的多个yaml文档组成。

第一个文档在顶层有一个映射。这个 映射是此流的RYD配置数据 文档,用于定义使用的文档版本,输出 以及其他配置信息。

第一个文档后面的文档通常是块的 使用可选标记设置文字标量的样式。标记影响标量 字符串在选定的输出系统中处理:

---
version: 0.1
output: rst
fix_inline_single_backquotes: true
--- |
Example Python program
++++++++++++++++++++++

This is an example of a python program
--- !python |
n = 7
print(n**2 - n)
--- !stdout |
The answer is::

这将(使用: ryd convert test.ryd )生成以下 test.rst

Example Python program
++++++++++++++++++++++

This is an example of a Python program
::

  n = 7
  print(n**2 - n)

The answer is::

  42

然后可以使用 rst2pdf 将其转换为pdf,或者使用 rst2html 将其转换为html。

命令行选项

ryd的命令行由多个组件组成:

ryd [--global-option] command [--options] [arguments]

尽管没有指出,大多数全局选项也可以在命令之后出现。

命令

convert             generate output as per first YAML document
clean               clean output files for .ryd files
roundtrip           roundtrip .ryd file, updating sections
from-rst (fromrst)  convert .rst to .ryd

您经常使用convert,它以一个或多个文件名作为参数 并生成RYD配置数据中指定的输出。有些选项允许您覆盖那里的设置(例如 --pdf -没有pdf

来自rst的命令 将一个 .rst 文件转换为 .ryd 执行某些节下划线检查并添加ryd配置数据文档。

往返命令有一个选项在适当的位置运行 在 上设置代码格式!python)-pre) 文件的 .ryd 部分。你需要 在您的路径中已经有了 oitnb

执行 ryd command --help可能会指示尚未进入的额外选项 文档。

文档和文档标签

每个yaml文档与其他文档分开溪流 文档开始标记。除了第一份文件,大部分 文档包含单行、多行、非缩进、标量。这个 因此,标记后面跟着管道( )符号,该符号是 多行标量的yaml指示。

通过插入 在 之前加上标签。例如,一种python程序类型的文档 有一个标签!python

文档标记的确切功能取决于标记,但也可能取决于 在以前处理的标记文档上选择的输出文件格式,其他 .ryd 以前处理过的文件和环境。 以下是所有标记的简短说明,与选定的 输出格式:

< DL> < d>!代码< dt >
在文本中包含程序。不要标记为可执行,不影响 !标准输出
< d>!注释< /d>
整个文档将被丢弃,即不包含在输出中。
< d>!焚烧< / dt >
将列出的原始文件(即未经处理的文件)包含到输出中。
< d>!Python < /dt >
在文本中包含python程序。前缀并标记为可执行。
< d>!python pre
在后面加上前缀!python包含此文档的文档(例如用于导入)
< d>!STDUD/< DT >
包括上一个可执行文档的输出(例如 !python )作为代码。
< d>!标准输出原始值
包括最后一个程序的输出,作为输出格式的源。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java Spring freemarker多模板加载程序路径   在java插件中从控制台获取输入   java在包中创建继承类   网页抓取Java Jsoup网页抓取   java在线程内创建一个对象,而true条件具有相同的引用   java如何根据空格数拆分字符串   java新的安卓 studio更新中的配置文件“app”是什么?   java在将ArrayList写入/读取到文件时出现奇怪的问题   java Reg替换文本块第一次出现+最后一次出现   java当我单击任何RecyclerView列表项时,如何在MainActivity的EditText中显示特定的单击项?   JAVA XML删除节点仅删除第一个外观   java如何在数组中查找特定值   java SVG/矢量图形对象布尔运算(并集、交集、减法)   java在Android中创建线程需要多长时间   尝试从JBOSS联系Oracle LDAP服务器时发生java连接重置异常   java基于参数获取特定的实现实例   使用java就地修改文件内容   java MonetaryException:未加载MonetaryAmountsSingletonSpi   java接受用户的不同输入并使其触发完全相同的代码段的最短方法是什么   Spring 3.2.8应用程序中未找到java HTTP 404错误