使用和开发模块实用程序

Ansible 提供了一些模块实用程序或共享代码片段，这些代码片段提供了在开发您自己的模块时可以使用的辅助函数。 basic.py 模块实用程序提供用于访问 Ansible 库的主要入口点，并且所有 Python Ansible 模块都必须从 ansible.module_utils 中导入某些内容。 一个常见的选择是导入 AnsibleModule

from ansible.module_utils.basic import AnsibleModule

ansible.module_utils 命名空间不是一个普通的 Python 包：它是在每次任务调用时动态构建的，方法是提取导入并针对从活动配置派生的 搜索路径 解决与命名空间匹配的那些导入。

为了减少集合或本地模块中的维护负担，您可以将重复的代码提取到一个或多个模块实用程序中，并将它们导入到您的模块中。 例如，如果您有自己的自定义模块，这些模块导入了一个 my_shared_code 库，您可以将其放入 ./module_utils/my_shared_code.py 文件中，如下所示

from ansible.module_utils.my_shared_code import MySharedCodeClient

当您运行 ansible-playbook 时，Ansible 会将您本地 module_utils 目录中的所有文件合并到 ansible.module_utils 命名空间中，合并顺序由 Ansible 搜索路径 定义。

命名和查找模块实用程序

通常，您可以从模块实用程序的名称和/或位置判断其功能。 通用实用程序（由许多不同类型的模块共享的代码）位于主 ansible/ansible 代码库中，位于 common 子目录或 lib/ansible/module_utils 的根目录中。 由特定模块集使用的实用程序通常与这些模块位于同一个集合中。 例如

  • lib/ansible/module_utils/urls.py 包含用于解析 URL 的共享代码

  • openstack.cloud.plugins.module_utils.openstack.py 包含用于与 OpenStack 实例一起工作的模块的实用程序

  • ansible.netcommon.plugins.module_utils.network.common.config.py 包含供网络模块使用的实用程序函数

按照此模式使用您自己的模块实用程序可以使所有内容易于查找和使用。

标准模块实用程序

Ansible 附带了广泛的 module_utils 文件库。 您可以在主 Ansible 路径下的 lib/ansible/module_utils 目录中找到模块实用程序源代码。 我们将在下面描述最常用的实用程序。 有关任何特定模块实用程序的更多详细信息，请参阅 module_utils 的源代码。

注意

许可要求 Ansible 强制执行以下许可要求

  • 实用程序（lib/ansible/module_utils/ 中的文件）可能有两种许可证之一

    • module_utils 中的文件仅用于特定供应商的硬件、提供商或服务，可以根据 GPLv3+ 许可。

    • 所有其他 module_utils 必须根据 BSD 许可，以便 GPL 许可的第三方和 Galaxy 模块可以使用它们。

    • 如果对 module_utils 中文件的适当许可证有疑问，则 Ansible Core 团队将在 Ansible Core 社区会议期间做出决定。

  • 与 Ansible 一起提供的其他所有文件，包括所有模块，必须根据 GPL 许可证（GPLv3 或更高版本）获得许可。

  • 现有的许可要求仍然适用于 ansible/ansible（ansible-core）中的内容。

  • 以前位于 ansible/ansible 或集合中，并且已移至新集合的内容必须保留其在先前存储库中的许可证。

  • 以前提交者提供的版权条目也必须保留在任何移动的文件中。

  • api.py - 支持通用 API 模块

  • basic.py - Ansible 模块的一般定义和辅助实用程序

  • common/dict_transformations.py - 字典转换的辅助函数

  • common/file.py - 用于处理文件的辅助函数

  • common/text/ - 用于转换和格式化文本的辅助函数

  • common/parameters.py - 用于处理模块参数的辅助函数

  • common/sys_info.py - 用于获取发行版和平台信息的函数

  • common/validation.py - 用于根据模块参数规范验证模块参数的辅助函数

  • facts/ - 返回事实的模块的实用程序目录。 有关更多信息，请参阅 PR 23012

  • json_utils.py - 用于过滤模块 JSON 输出周围无关输出的实用程序，例如开头和结尾行

  • powershell/ - Windows PowerShell 模块的定义和辅助函数目录

  • pycompat24.py - Python 2.4 的异常解决方法

  • service.py - 用于使模块能够与 Linux 服务一起工作的实用程序（占位符，未使用）

  • six/__init__.py - Six Python 库 的捆绑副本，用于帮助编写与 Python 2 和 Python 3 都兼容的代码

  • splitter.py - 用于处理 Jinja2 模板的字符串拆分和操作实用程序

  • urls.py - 用于处理 http 和 https 请求的实用程序

几个常用的实用程序在 Ansible 2.10 中迁移到集合，包括

  • ismount.py 迁移到 ansible.posix.plugins.module_utils.mount.py - 修复 os.path.ismount 的单个辅助函数

  • known_hosts.py 迁移至 community.general.plugins.module_utils.known_hosts.py - 用于处理 known_hosts 文件的实用程序

有关迁移内容及其目标集合的列表，请参阅 runtime.yml 文件。