自定义Ansible模块如何限制必填参数不接收None空值

问题本质 #

Ansible模块参数默认的required=True校验规则，仅判断参数是否在任务中被显式声明，不会校验传入值的有效性。YAML语法中键名后留空（即复现示例里的protocol:写法）等价于传入null值，对应Python层面的None，会绕过默认的必填校验，最终模块拿到的参数值为None。

实现方案 #

方案1：原生参数规范配置（推荐，适用于Ansible 2.10及以上版本） #

直接在protocol的参数定义中添加none=False属性，该属性会明确告知Ansible参数校验逻辑：当前参数不接受None值，一旦检测到空传/None值会直接抛出校验错误，终止模块执行，无需编写额外自定义校验代码。
修改后的参数定义代码如下：

module_args = dict(
        protocol=dict(type='str', required=True, none=False),
        protocol_metadata=dict(type='dict', default={})
    )

配置生效后，提供的复现任务在执行时会直接在参数校验阶段失败，提示protocol参数不允许为None值。
如果需要同时拦截空字符串，可以额外增加empty=False属性，写法为protocol=dict(type='str', required=True, none=False, empty=False)，即可同时过滤None值和长度为0的空字符串。

方案2：自定义校验逻辑（兼容Ansible 2.10以下版本） #

如果运行环境的Ansible版本较低不支持none=False属性，可以在模块初始化完成后，手动增加参数值校验逻辑，检测到空值直接调用fail_json抛出错误即可。
完整示例代码：

from ansible.module_utils.basic import AnsibleModule

def main():
    module_args = dict(
        protocol=dict(type='str', required=True),
        protocol_metadata=dict(type='dict', default={})
    )
    module = AnsibleModule(argument_spec=module_args)

    # 手动校验protocol非None/非空字符串
    protocol_val = module.params.get('protocol')
    if protocol_val is None or (isinstance(protocol_val, str) and protocol_val.strip() == ''):
        module.fail_json(msg="参数'protocol'为必填字符串，不允许传入空值或None")

    # 后续模块业务逻辑写在这里
    # ...

if __name__ == '__main__':
    main()

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