模块格式和文档

如果你想将你的模块贡献给大多数 Ansible 集合，你必须使用 Python 编写你的模块并遵循下面描述的标准格式。（除非你正在编写 Windows 模块，在这种情况下，Windows 指南适用。）除了遵循此格式外，你还应该在你打开拉取请求之前查看我们的提交清单、编程技巧和维护 Python 2 和 Python 3 兼容性的策略，以及有关测试的信息。

每个用 Python 编写的 Ansible 模块都必须以特定顺序以七个标准部分开头，然后是代码。这些部分按顺序排列为：

注意

为什么导入不在开头？

敏锐的 Python 程序员可能会注意到，与 PEP 8 的建议相反，我们没有将 imports 放在文件的顶部。这是因为 DOCUMENTATION 到 RETURN 部分不被模块代码本身使用；它们本质上是文件的额外文档字符串。出于与 PEP 8 将导入放在介绍性注释和文档字符串之后相同的原因，导入放置在这些特殊变量之后。这将代码的活动部分放在一起，并将纯粹的信息部分分开。排除 E402 的决定是基于可读性（这就是 PEP 8 的目的）。模块中的文档字符串与模块级文档字符串比代码更相似，并且模块本身从未使用过它们。将导入放在此文档下方并更靠近代码，以一致的方式整合和分组所有相关的代码，以提高可读性、调试和理解。

警告

小心复制旧模块！

一些较旧的 Ansible 模块在文件的底部有 imports，带有完整 GPL 前缀的 Copyright 通知，和/或顺序错误的 DOCUMENTATION 字段。这些是需要更新的旧文件——不要将它们复制到新模块中。随着时间的推移，我们正在更新和纠正较旧的模块。请遵循此页面上的指南！

注意

对于非 Python 模块，你仍然需要创建一个 .py 文件用于文档目的。从 ansible-core 2.14 开始，你可以选择创建一个 .yml 文件，该文件具有相同的数据结构，但使用纯 YAML。使用 YAML 文件，下面的示例很容易使用，方法是删除 Python 引号并将 = 替换为 :，例如 DOCUMENTATION = r''' ... ''' 改为 DOCUMENTATION: ... 并删除结束引号。相邻的 YAML 文档文件

Python Shebang 和 UTF-8 编码

以 #!/usr/bin/python 开头你的 Ansible 模块——这个“Shebang”允许 ansible_python_interpreter 工作。在 Shebang 后面立即添加 # -*- coding: utf-8 -*- 以阐明该文件是 UTF-8 编码的。

警告

• 使用 #!/usr/bin/env 将 env 设为解释器，并绕过 ansible_<interpreter>_interpreter 逻辑。

• 在 Shebang 中传递参数给解释器不起作用（例如，#!/usr/bin/env python）。

注意

如果你使用不同的脚本语言开发模块，请相应地调整解释器（#!/usr/bin/<interpreter>），以便 ansible_<interpreter>_interpreter 可以为该特定语言工作。

注意

二进制模块不需要 Shebang 或解释器。

版权和许可

在 Shebang 和 UTF-8 编码之后，添加一个包含原始版权持有者和许可声明的版权行。许可声明应该只有一行，而不是完整的 GPL 前缀。

#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright: Contributors to the Ansible project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

模块的添加（例如，重写）不允许添加除默认版权声明（如果缺失）以外的其他版权行。

# Copyright: Contributors to the Ansible project

任何法律审查都将包括源代码控制历史记录，因此不需要详尽的版权页眉。请不要包含版权年份。如果现有的版权声明包含年份，请不要编辑现有的版权年份。未经版权作者许可，不得修改任何现有的版权页眉。

ANSIBLE_METADATA 块

自从我们迁移到集合以来，我们已经弃用了 METADATA 功能，它不再是模块所必需的，但是如果存在，它也不会破坏任何东西。

DOCUMENTATION 块

在 Shebang、UTF-8 编码、版权行和许可证部分之后是 DOCUMENTATION 块。Ansible 的在线模块文档是从每个模块源代码中的 DOCUMENTATION 块生成的。DOCUMENTATION 块必须是有效的 YAML。你可能会发现，在你将其包含在 Python 文件中之前，先在一个具有 YAML 语法高亮的编辑器中开始编写你的 DOCUMENTATION 字符串更容易。你可以从将我们的示例文档字符串复制到你的模块文件中并进行修改开始。如果你的 YAML 中出现语法问题，你可以在YAML Lint 网站上验证它。

模块文档应简要准确地定义每个模块和选项的作用以及它与底层系统中的其他模块的协作方式。文档应为广泛的受众编写——专家和非专家都能阅读。

• 描述应始终以大写字母开头，并以句号结尾。一致性始终有所帮助。

• 验证doc和模块spec dict中的参数是否相同。

• 对于密码/密钥参数，应设置 no_log=True。

• 对于似乎包含敏感信息但**不**包含密钥的参数，例如“password_length”，请设置 no_log=False 来禁用警告消息。

• 如果某个选项仅在某些情况下需要，请描述这些条件。例如，“当 I(state=present) 时需要”。

• 如果你的模块允许 check_mode，请在文档中反映这一事实。

为了创建清晰、简洁、一致且有用的文档，请遵循样式指南。

下面描述每个文档字段。在提交模块文档之前，请在命令行和 HTML 中测试它。

• 只要您的模块文件在本地可用，您就可以使用ansible-doc -t module my_module_name在命令行查看您的模块文档。任何解析错误都将很明显——您可以通过添加-vvv到命令中来查看详细信息。

• 您还应该测试模块文档的HTML输出。

文档字段

DOCUMENTATION块中的所有字段都为小写。除非另有说明，否则所有字段都是必需的。

module:

• 模块的名称。

• 必须与文件名相同，不包括.py扩展名。

short_description:

• 简短描述，显示在集合索引页面和ansible-doc -l中。

• short_description由ansible-doc -l显示，没有任何类别分组，因此它需要足够的细节来解释模块的目的，而无需其所在目录结构的上下文。

• 与description:不同，short_description不应该以句点结尾。

description:

• 详细描述（通常是两句或更多句）。

• 必须用完整的句子书写，换句话说，要用大写字母和句点。

• 不应提及模块名称。

• 应使用多个条目，而不是使用一个长段落。

• 除非YAML要求，否则不要引用完整的值。

version_added:

• 添加模块的Ansible版本。

• 这是一个字符串，而不是浮点数，例如version_added: '2.1'。

• 在集合中，这必须是添加模块的集合版本，而不是Ansible版本。例如，version_added: 1.0.0。

author:

• 模块作者的姓名，格式为First Last (@GitHubID)。

• 如果有多个作者，请使用多行列表。

• 不要使用引号，因为YAML不需要。

deprecated:

• 标记将在未来版本中删除的模块。另请参见Ansible 模块或插件的生命周期。

options:

• 选项通常称为“参数”或“参数”。因为文档字段称为options，我们将使用该术语。

• 如果模块没有选项（例如，它是一个_facts模块），您只需要一行：options: {}。

• 如果您的模块有选项（换句话说，接受参数），则应详细记录每个选项。对于每个模块选项，包括

option-name:

• 声明式操作（不是CRUD），专注于最终状态，例如online:，而不是is_online:。

• 选项的名称应与模块的其余部分以及同一类别中的其他模块保持一致。

• 如有疑问，请查找其他模块以查找用于相同目的的选项名称，我们希望为用户提供一致性。

• （没有显式的字段option-name。此条目是关于options字典中选项的键。）

description:

• 对该选项的作用的详细解释。它应该用完整的句子书写。

• 第一个条目是对选项本身的描述；后续条目详细说明其用法、依赖项或可能值的格式。

• 不应列出可能的值（这就是choices:的作用，尽管如果它们不明显，它应该解释这些值的作用）。

• 如果某个选项仅在某些情况下需要，请描述这些条件。例如，“当 I(state=present) 时需要”。

• 互斥选项必须在每个选项的最后一句中记录。

required:

• 只有在true时才需要。

• 如果缺失，我们假设该选项不是必需的。

default:

• 如果required为false/缺失，则可以指定default（如果缺失，则假定为“null”）。

• 确保文档中的默认值与代码中的默认值匹配。

• 默认字段不应列为描述的一部分，除非它需要其他信息或条件。

• 如果选项是布尔值，您可以使用Ansible识别的任何布尔值（例如true/false或yes/no）。为了与ansible-lint保持一致性和兼容性，请将布尔值记录为true/false。

choices:

• 选项值的列表。

• 如果为空，则应不存在。

type:

• 指定选项接受的数据类型，必须与argspec匹配。

• 如果参数为type='bool'，则此字段应设置为type: bool，并且不应指定choices。

• 如果参数为type='list'，则应指定elements。

elements:

• 如果type='list'，则指定列表元素的数据类型。

aliases:

• 可选名称别名的列表。

• 通常不需要。

version_added:

• 仅当在初始Ansible版本发布后扩展此选项时才需要，换句话说，这大于顶级version_added字段。

• 这是一个字符串，而不是浮点数，例如version_added: '2.3'。

• 在集合中，这必须是添加选项的集合版本，而不是Ansible版本。例如，version_added: 1.0.0。

suboptions:

• 如果此选项采用字典或字典列表，则可以在此处定义结构。

• 参见azure.azcollection.azure_rm_securitygroup、azure.azcollection.azure_rm_azurefirewall和openstack.cloud.baremetal_node_action以了解示例。

requirements:

• 需求列表（如果适用）。

• 包括最低版本。

seealso:

• 其他模块、文档或互联网资源的参考列表。

• 在Ansible 2.10及更高版本中，对模块的引用必须使用FQCN或ansible.builtin用于ansible-core中的模块。

• 自ansible-core 2.15起支持插件引用。

• 引用可以采用以下格式之一

  seealso:
  
  # Reference by module name
  - module: cisco.aci.aci_tenant
  
  # Reference by module name, including description
  - module: cisco.aci.aci_tenant
    description: ACI module to create tenants on a Cisco ACI fabric.
  
  # Reference by plugin name
  - plugin: ansible.builtin.file
    plugin_type: lookup
  
  # Reference by plugin name, including description
  - plugin: ansible.builtin.file
    plugin_type: lookup
    description: You can use the ansible.builtin.file lookup to read files on the control node.
  
  # Reference by rST documentation anchor
  - ref: aci_guide
    description: Detailed information on how to manage your ACI infrastructure using Ansible.
  
  # Reference by rST documentation anchor (with custom title)
  - ref: The official Ansible ACI guide <aci_guide>
    description: Detailed information on how to manage your ACI infrastructure using Ansible.
  
  # Reference by Internet resource
  - name: APIC Management Information Model reference
    description: Complete reference of the APIC object model.
    link: https://developer.cisco.com/docs/apic-mim-ref/
  

• 如果您使用ref:链接到与标题无关的锚点，则必须为链接添加标题才能使其正常工作。

attributes:

• 一个字典，将属性名称映射到描述该属性的字典。

• 通常，属性由文档片段提供，例如ansible.builtin.action_common_attributes及其子片段。模块和插件使用相应的文档片段并填写support、details和潜在的特定于属性的其他字段。

description:

• 字符串或字符串列表。每个字符串是一个段落。描述是必需的。

• 对该属性作用的解释。它应该用完整的句子书写。

details:

• 字符串或字符串列表。每个字符串是一个段落。

• 描述支持可能无法按用户预期工作的方式。

• 细节通常是可选的，但如果support为partial，则必须提供细节。

support:

• full、none、partial或N/A之一。这是必需的。

• 指示此模块或插件是否支持此属性。

membership:

• 字符串或字符串列表。

• 只能用于属性action_group，并且必须始终为此属性指定。

• 列出此模块或操作所属的操作组。

platforms:

• 字符串或字符串列表。

• 只能用于属性platform，并且必须始终为此属性指定。

• 列出模块或操作支持的平台。

version_added:

• 仅当在创建模块/插件后扩展此属性的支持时才需要，换句话说，这大于顶级version_added字段。

• 这是一个字符串，而不是浮点数，例如version_added: '2.3'。

• 在集合中，这必须是添加属性支持的集合版本，而不是Ansible版本。例如，version_added: 1.0.0。

notes:

• 任何不适合上述部分的重要信息细节。

• 关于check_mode或diff的信息**不应**在此处列出，而应在attributes中提及。

模块文档内的链接

您可以使用一些预定义的宏，在模块文档中链接到其他模块文档、docs.ansible.com 上的其他资源以及互联网上的其他资源。

• 这些宏的正确格式如下：L() 用于带有标题的链接。例如：See L(Ansible Automation Platform,https://ansible.org.cn/products/automation-platform). 从 Ansible 2.10 开始，请不要在 Ansible 文档和集合文档之间的相对链接中使用 L()。

• U() 用于 URL。例如：See U(https://ansible.org.cn/products/automation-platform) for an overview.

• R() 用于带有标题的交叉引用（在 Ansible 2.10 中添加）。例如：See R(Cisco IOS Platform Guide,ios_platform_options)。使用 RST 锚点进行交叉引用。详情请参见 添加锚点。

• M() 用于模块名称。例如：See also M(ansible.builtin.yum) or M(community.general.apt_rpm)。必须使用 FQCN，简短名称会创建无效链接；对于 ansible-core 中的模块，请使用 ansible.builtin。

• P() 用于插件名称。例如：See also P(ansible.builtin.file#lookup) or P(community.general.json_query#filter)。这也可以引用角色：P(community.sops.install#role)。这自 ansible-core 2.15 起受支持。必须使用 FQCN；对于 ansible-core 中的插件，请使用 ansible.builtin。

注意

对于模块和集合内文档之间的链接，您可以使用上述任何选项。对于集合外部的链接，如果可用，请使用 R()。否则，请使用 U() 或 L() 附带完整 URL（而非相对链接）。对于模块，请使用带有 FQCN 或 ansible.builtin 的 M()，如示例所示。如果您正在创建自己的文档站点，则需要使用 intersphinx 扩展 将 R() 和 M() 转换为正确的链接。

注意

要引用集合中的一组模块，请使用 R()。当集合不是正确的粒度时，请使用 C(..)

• 请参考 R(kubernetes.core 集合, plugins_in_kubernetes.core) 以获取有关管理 kubernetes 集群的信息。

• C(win_*) 模块（分布在多个集合中）允许您管理 Windows 主机的各个方面。

注意

由于它更突出，因此请使用 seealso 来进行一般性引用，而不是使用注释或在描述中添加链接。

模块文档中的语义标记

您可以使用语义标记来突出显示选项名称、选项值和环境变量。标记处理器以统一的方式格式化这些突出显示的术语。使用语义标记，我们可以在不更改底层代码的情况下修改输出的外观。

语义标记的正确格式如下：

• O() 用于选项名称，无论单独提及还是与值一起提及。例如：Required if O(state=present). 和 Use with O(force) to require secure access.

• V() 用于单独提及的选项值。例如：Possible values include V(monospace) and V(pretty).

• RV() 用于返回值名称，无论单独提及还是与值一起提及。例如：The module returns RV(changed=true) in case of changes. 和 Use the RV(stdout) return value for standard output.

• E() 用于环境变量。例如：If not set, the environment variable E(ACME_PASSWORD) will be used.

这些格式化函数的参数可以使用反斜杠进行转义：V(foo(bar="a\\b"\), baz) 将生成格式化的值 foo(bar="a\b"), baz)。

使用 O() 和 RV() 的规则非常严格。您必须遵循语法规则，以便文档呈现器可以分别为选项和返回值创建超链接。

允许的语法如下：

• 要引用当前插件/模块的选项，或当前角色的入口点（在角色入口点文档内），请使用 O(option) 和 O(option=name)。

• 要在角色文档内引用另一个入口点 entrypoint 的选项，请使用 O(entrypoint:option) 和 O(entrypoint:option=name)。入口点信息可以被文档呈现器忽略，转换成指向该入口点的链接，甚至直接指向该入口点的选项。

• 要引用类型为 type 的另一个插件/模块 plugin.fqcn.name 的选项，请使用 O(plugin.fqcn.name#type:option) 和 O(plugin.fqcn.name#type:option=name)。对于模块，请使用 type=module。FQCN 和插件类型可以被文档呈现器忽略，转换成指向该插件的链接，甚至直接指向该插件的选项。

• 要引用另一个角色 role.fqcn.name 的入口点 entrypoint 的选项，请使用 O(role.fqcn.name#role:entrypoint:option) 和 O(role.fqcn.name#role:entrypoint:option=name)。FQCN 和入口点信息可以被文档呈现器忽略，转换成指向该入口点的链接，甚至直接指向该入口点的选项。

• 要引用不存在的选项（例如，在早期版本中已删除的选项），请使用 O(ignore:option) 和 O(ignore:option=name)。ignore: 部分不会显示给用户。

选项名称可以通过列出用点分隔的选项路径来引用子选项。例如，如果您有一个带有子选项 bar 的选项 foo，则必须使用 O(foo.bar) 来引用该子选项。您可以添加诸如 O(foo[].bar) 或甚至 O(foo[-1].bar) 之类的数组指示来指示特定的列表元素。[ 和 ] 对之间的所有内容都将被忽略，以确定选项的真实名称。例如，O(foo[foo | length - 1].bar[]) 与 O(foo.bar) 生成相同的链接，但显示的文本为 foo[foo | length - 1].bar[] 而不是 foo.bar。

相同的语法可用于 RV()，只是它们将引用返回值名称而不是选项名称；例如 RV(ansible.builtin.service_facts#module:ansible_facts.services) 指的是由 ansible.builtin.service_facts 模块 返回的 ansible_facts.services 事实。

模块文档中的格式宏

虽然可以使用标准 Ansible 格式化宏来控制模块文档中其他术语的外观，但您应该谨慎使用。

可能的宏包括：

• C() 用于 monospace（代码）文本。例如：This module functions like the unix command C(foo).

• 使用B()表示粗体文本。

• 使用I()表示斜体文本。

• 使用HORIZONTALLINE表示水平线（<hr> HTML标签），用于分隔较长的描述。

请注意，C()、B()和I()**不允许转义**，因此不能包含值)，因为它总是结束格式化序列。如果您需要在C()内使用)，建议改用V()；请参见上面关于语义标记的部分。

文档片段

如果您正在编写多个相关的模块，它们可能共享公共文档，例如身份验证细节、文件模式设置、notes:或seealso:条目。与其在每个模块的DOCUMENTATION块中重复这些信息，不如将其一次性保存为doc_fragment插件，并在每个模块的文档中使用它。在Ansible中，共享的文档片段包含在lib/ansible/plugins/doc_fragments/或集合中的等效目录中的ModuleDocFragment类中。要包含文档片段，请在您的模块文档中添加extends_documentation_fragment: FRAGMENT_NAME。对于FRAGMENT_NAME，使用完全限定的集合名称（例如，kubernetes.core.k8s_auth_options）。

只有当模块以与导入该片段的现有模块相同的方式实现那里记录的所有接口时，模块才应使用文档片段中的项目。目标是，从文档片段导入的项目在用于导入该文档片段的另一个模块时，其行为应完全相同。

默认情况下，只有文档片段中的DOCUMENTATION属性会被插入到模块文档中。可以在文档片段中定义其他属性，以便仅导入文档片段的某些部分或根据需要进行混合和匹配。如果在文档片段和模块中都定义了属性，则模块值会覆盖文档片段值。

这是一个名为example_fragment.py的文档片段示例

class ModuleDocFragment(object):
    # Standard documentation
    DOCUMENTATION = r'''
    options:
      # options here
    '''

    # Additional section
    OTHER = r'''
    options:
      # other options here
    '''

要在模块中插入OTHER的内容

extends_documentation_fragment: example_fragment.other

或者同时使用两者

extends_documentation_fragment:
  - example_fragment
  - example_fragment.other

2.8版本新增。

从Ansible 2.8开始，您可以通过使用与play或role相邻的doc_fragments目录来使用用户提供的doc_fragments，就像任何其他插件一样。

例如，所有AWS模块都应包含

extends_documentation_fragment:
- aws
- ec2

在集合中使用文档片段描述了如何在集合中包含文档片段。

EXAMPLES 块

在shebang、UTF-8编码、版权声明、许可证部分和DOCUMENTATION块之后，是EXAMPLES块。在这里，您向用户展示您的模块如何通过多行纯文本YAML格式的真实示例工作。最好的示例是用户可以复制并粘贴到playbook中的示例。每次更改模块时，都要检查并更新您的示例。

根据playbook最佳实践，每个示例都应包含name:行

EXAMPLES = r'''
- name: Ensure foo is installed
  namespace.collection.modulename:
    name: foo
    state: present
'''

name:行应大写，并且不包含尾随句点。

使用完全限定的集合名称 (FQCN) 作为模块名称的一部分，如上例所示。对于ansible-core中的模块，使用ansible.builtin.标识符，例如ansible.builtin.debug。

如果您的示例使用布尔选项，请使用yes/no值。由于文档将布尔值生成yes/no，因此示例也使用这些值可以使模块文档更一致。

如果您的模块返回经常需要的facts，则说明如何使用它们的示例可能会有所帮助。

RETURN 块

在shebang、UTF-8编码、版权声明、许可证部分、DOCUMENTATION和EXAMPLES块之后是RETURN块。本节记录模块返回的信息，供其他模块使用。

如果您的模块不返回任何内容（除了标准返回值之外），则模块的此部分应读取：RETURN = r''' # ''' 否则，对于每个返回的值，请提供以下字段。除非另有说明，否则所有字段都是必需的。

返回名称：

返回字段的名称。

description:

此值的详细描述。大写并带尾随句点。

返回：

返回此值的时间，例如always、changed或success。这是一个字符串，可以包含任何人类可读的内容。

type:

数据类型。

elements:

如果type='list'，则指定列表元素的数据类型。

示例：

一个或多个示例。

version_added:

仅当在Ansible初始发布后扩展此返回值时才需要，换句话说，它大于顶级version_added字段。这是一个字符串，而不是浮点数，例如，version_added: '2.3'。

包含：

可选。要描述嵌套返回值，请设置type: dict或type: list/elements: dict，或者如果真的必须，则设置type: complex，并为每个子字段重复上述元素。

这里有两个RETURN部分示例，一个包含三个简单字段，另一个包含一个复杂的嵌套字段

RETURN = r'''
dest:
    description: Destination file/path.
    returned: success
    type: str
    sample: /path/to/file.txt
src:
    description: Source file used for the copy on the target machine.
    returned: changed
    type: str
    sample: /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source
md5sum:
    description: MD5 checksum of the file after running copy.
    returned: when supported
    type: str
    sample: 2a5aeecc61dc98c4d780b14b330e3282
'''

RETURN = r'''
packages:
    description: Information about package requirements.
    returned: success
    type: dict
    contains:
        missing:
            description: Packages that are missing from the system.
            returned: success
            type: list
            elements: str
            sample:
                - libmysqlclient-dev
                - libxml2-dev
        badversion:
            description: Packages that are installed but at bad versions.
            returned: success
            type: list
            elements: dict
            sample:
                - package: libxml2-dev
                  version: 2.9.4+dfsg1-2
                  constraint: ">= 3.0"
'''

Python 导入

在shebang、UTF-8编码、版权声明、许可证以及DOCUMENTATION、EXAMPLES和RETURN部分之后，您可以最终添加Python导入。所有模块都必须使用以下形式的Python导入

from module_utils.basic import AnsibleModule

不再允许使用“通配符”导入，例如from module_utils.basic import *。

测试模块文档

要在本地测试Ansible文档，请遵循说明。要测试集合中的文档，请参见使用antsibull-docs构建文档站点。