0

0

如何在 Ansible Filter Plugin 中正确复用本地工具函数

花韻仙語

花韻仙語

发布时间:2026-01-02 15:48:08

|

362人浏览过

|

来源于php中文网

原创

如何在 Ansible Filter Plugin 中正确复用本地工具函数

ansible 的 filter plugin 不支持直接导入同目录下的普通 python 模块,需通过自定义 collection 结构,将共享逻辑放入 module_utils 目录,再以标准命名空间方式导入,从而实现跨 filter 的代码复用

在 Ansible 中,filter plugin 本质上是被动态加载的 Python 模块,其加载机制严格限定于 filter_plugins/ 目录下的合法插件文件(即必须含 FilterModule 类且实现 filters() 方法)。因此,工具函数放在同一目录下的 tools.py 中并尝试 import tools 是无效的——Ansible 会将其误判为待加载的插件(触发 FilterModule 属性缺失警告),而 Python 解释器也无法通过常规路径解析该模块。

官方明确不支持 filter_plugins/ 内部模块互导,也未提供类似 module_utils 对 filter 的原生支持(该机制仅适用于 modules/)。但幸运的是,Ansible Collections 提供了标准化、可复用、且被完整支持的替代方案:将 filter plugin 与共享工具代码共同组织为一个本地 collection,并利用 collection 内部的 plugins/module_utils/ 目录存放可导入的工具模块

✅ 正确实践结构如下(以 larsks.myplugins 为例):

./
├── playbook.yaml
└── collections/
    └── ansible_collections/
        └── larsks/
            └── myplugins/
                └── plugins/
                    ├── filter/
                    │   └── myfilter.py      # 实际 filter 插件
                    └── module_utils/
                        └── tools.py         # 共享工具函数(含 __init__.py 可选)

其中 collections/ansible_collections/larsks/myplugins/plugins/module_utils/tools.py 内容示例:

# tools.py
def shared_function(data_to_process):
    """通用数据处理逻辑,可在多个 filter 中复用"""
    return data_to_process.strip().replace(" ", "_").lower()

对应 filter 插件 myfilter.py:

Amazon Nova
Amazon Nova

亚马逊云科技(AWS)推出的一系列生成式AI基础模型

下载
# myfilter.py
from ansible_collections.larsks.myplugins.plugins.module_utils.tools import shared_function

class FilterModule:
    def filters(self):
        return {
            'normalize': lambda s: shared_function(s),
            'prefix_upper': lambda s: f"PREFIX_{shared_function(s).upper()}"
        }

在 playbook 中使用时,需带上 collection 命名空间:

- hosts: localhost
  gather_facts: false
  tasks:
    - debug:
        msg: "{{ 'Hello World' | larsks.myplugins.normalize }}"
    - debug:
        msg: "{{ 'Test Data' | larsks.myplugins.prefix_upper }}"

⚠️ 注意事项:

  • collections/ 目录必须与 playbook 文件同级,且路径必须严格为 collections/ansible_collections/{namespace}/{collection_name}/...;
  • module_utils/ 下的模块无需 __init__.py(Ansible 2.10+ 自动识别),但添加空 __init__.py 也不影响;
  • 所有导入语句必须使用完整 collection 命名空间路径(ansible_collections.{ns}.{coll}.plugins.module_utils.xxx),不可简写;
  • 本地 collection 无需发布或安装,Ansible 运行时自动发现并加载;
  • 若需多 filter 复用,可将 tools.py 拆分为多个模块(如 string_utils.py, json_utils.py),保持高内聚低耦合。

该方案符合 Ansible 最佳实践,具备可移植性、可测试性与团队协作友好性,是解决 filter 插件代码复用问题的唯一推荐路径。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

720

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

627

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

744

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1236

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

575

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

700

2023.08.11

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

74

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.7万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.0万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号