用途:该技能用于在 Windmill 平台上编写 Python 脚本,规范脚本结构、资源引用、元数据管理与本地测试流程。
主要能力与约定:脚本至少包含一个名为 main 的函数,且不要主动调用它;依赖库自动安装,无需展示安装步骤。凭据与配置存放在资源中并以参数传入 main,需要的资源类型须在 main 之前用 TypedDict 重新定义,类型名必须全小写,仅包含实际需要的类型;若导入名与资源类型冲突,应重命名导入而非类型。可 import wmill 调用平台客户端。预处理脚本的函数名为 preprocessor 并接收 event 参数。支持 S3 对象操作,如 wmill.load_s3_file、load_s3_file_reader、write_s3_file。
常用用法:本地迭代用 wmill script preview <script_path>,不部署;运行已部署版本用 wmill script run <path>,仅在用户明确要求测试服务器版本时使用。改动导入或 main 参数后运行 wmill generate-metadata 更新本地 .script.yaml、.lock 及 wmill-lock.yaml 哈希;无路径时只重建哈希漂移的项,可用 --dry-run 查看原因,rehash 仅重记哈希。部署仅通过 git push 或 wmill sync push,且只在用户明确要求部署/发布/推送时执行。可通过 wmill resource-type list --schema 发现可用资源类型。
适用场景:在 Windmill 工作区开发、测试、同步 Python 脚本及预处理脚本,需要资源类型、S3 集成或 wmill SDK 交互时。
限制与提醒:preview 不部署但会真实执行脚本并可能产生副作用;generate-metadata 只写本地文件,但会重新解析依赖,可能升级未锁定版本,建议先征得用户同意再运行;部署是唯一会改动远程状态的步骤。