VSCode调试Ansible自定义模块时module_utils导入问题及优化方案问询

方案1：通过VSCode调试配置设置Ansible环境变量（推荐） #

Ansible运行时会自动识别角色目录下的library和module_utils，但VSCode调试时需要手动指定这些路径。修改.vscode/launch.json，添加对应的环境变量，让Python解释器能找到自定义的模块工具库：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Ansible Module Debug",
            "type": "python",
            "request": "launch",
            "program": "${file}", // 当前调试的模块文件（library下的dl_script）
            "env": {
                "ANSIBLE_LIBRARY": "${workspaceFolder}/library",
                "ANSIBLE_MODULE_UTILS": "${workspaceFolder}/module_utils"
            },
            "console": "integratedTerminal"
        }
    ]
}

配置完成后，直接使用原来的导入代码即可，无需修改模块逻辑：

from ansible.module_utils.dt_script2 import DTScript2
from ansible.module_utils.dt_script3 import DTScript3

方案2：改进路径添加逻辑（无需修改VSCode配置） #

如果不想依赖VSCode配置，可以优化代码中的路径处理逻辑，避免字符串替换的不可靠性，通过路径拼接的方式动态获取module_utils目录：

try:
    # 优先使用Ansible原生导入方式
    from ansible.module_utils.dt_script2 import DTScript2
    from ansible.module_utils.dt_script3 import DTScript3
except ImportError:
    import sys
    import os
    # 获取当前模块所在library目录的父目录（角色根目录）
    role_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    # 将module_utils目录加入Python搜索路径
    sys.path.insert(0, os.path.join(role_root, 'module_utils'))
    # 从本地module_utils导入
    from dt_script2 import DTScript2
    from dt_script3 import DTScript3

这种方式通过os.path.dirname逐层获取父目录，再拼接module_utils路径，比字符串替换更稳定，不会因为路径中包含其他library字样而出错。

方案3：将角色目录转为Python包（不推荐） #

在角色根目录、library、module_utils目录下创建空的__init__.py文件，将其转为Python包，然后使用相对导入：

try:
    from ansible.module_utils.dt_script2 import DTScript2
    from ansible.module_utils.dt_script3 import DTScript3
except ImportError:
    from ..module_utils.dt_script2 import DTScript2
    from ..module_utils.dt_script3 import DTScript3

但需要注意调试时VSCode的工作目录要设置为角色根目录，否则仍会出现相对导入错误。此外，这种方式可能和Ansible的默认运行逻辑冲突，因此不推荐作为首选方案。

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