开发Ansible集合模块时，如何正确导入共享代码及本地测试？

1. 共享代码的正确导入格式 #

正确的导入方式是短路径导入：

from ansible.module_utils.utils import helper_function

• 这是Ansible官方文档明确推荐的标准写法，因为Ansible在执行集合模块时，会自动将当前集合的plugins/module_utils目录注入到ansible.module_utils的搜索路径中，短路径可被正确解析。
• 部分开源集合（如amazon.aws）使用完整路径是历史遗留原因：早期Ansible版本对集合的module_utils路径处理不完善，需要用完整路径确保兼容性；当前Ansible 2.10+版本已完全支持短路径导入，无需再使用冗长的完整路径。

2. 直接用Python测试Ansible模块的正确方法 #

直接运行python plugins/modules/module_one.py /tmp/args.json报错，是因为普通Python环境无法识别Ansible专属的模块导入机制，正确的测试方式有两种：

方式一：使用官方ansible-test工具（推荐） #

这是Ansible官方提供的标准测试工具，能自动处理模块依赖路径，支持单元测试、静态检查等场景：

# 运行单个模块的单元测试
ansible-test modules plugins/modules/module_one.py -m pytest

# 执行静态代码导入检查
ansible-test sanity --test import plugins/modules/module_one.py

方式二：手动设置PYTHONPATH #

如果需要直接运行模块脚本，需手动将Ansible核心库路径和集合的module_utils路径添加到PYTHONPATH中：

PYTHONPATH="/path/to/ansible/lib:/path/to/your/collection/plugins" python plugins/modules/module_one.py /tmp/args.json

注意替换命令中的实际路径：

• /path/to/ansible/lib是Ansible核心库的目录（通常在Python site-packages下的ansible目录，或源码克隆的ansible/lib目录）
• /path/to/your/collection/plugins是当前集合的plugins目录路径

内容的提问来源于stack exchange，提问作者Nick