如何在 Python 脚本中正确使用 Jenkins 构建参数

本文详解如何在 jenkins 多配置项目（非 pipeline）的 shell 环境中，将 jenkins 参数安全、可靠地传递并用于 python 脚本，重点解决环境变量未展开、路径拼接错误等常见问题。

在 Jenkins 多配置项目（Matrix Project）中，构建参数（如 REPO_PATH）会以环境变量形式自动注入到执行节点的 Shell 环境中。python 脚本可通过 os.environ 获取这些变量，但必须注意：变量名需与 Jenkins 中定义的参数名完全一致（区分大小写），且不能直接在字符串字面量中硬编码变量名（如 ‘PATH/file.json’），否则 Python 不会解析它为变量值。

你原始代码中的关键错误有两处：

1. 字符串未进行变量插值：’PATH/file.json‘ 是纯文本，其中的 PATH 并非 Python 变量，而是字面字符串 “PATH”；
2. 变量名不一致：Jenkins 参数名为 REPO_PATH，但代码中误用 PATH = os.environ.get(‘REPO_PATH’) 后，又试图用未定义的全局 PATH（易与系统 PATH 环境变量混淆）——虽此处逻辑巧合可行，但语义不清且存在风险。

✅ 正确做法如下：

import json import os  # ✅ 严格匹配 Jenkins 参数名（REPO_PATH），并提供默认值增强健壮性 repo_path = os.environ.get('REPO_PATH', '').strip() if not repo_path:     raise ValueError("Jenkins parameter 'REPO_PATH' is missing or empty")  # ✅ 使用 f-String 或 os.path.join 进行安全路径拼接 json_file = os.path.join(repo_path, 'file.json')  # ✅ 添加文件存在性校验，便于调试 if not os.path.isfile(json_file):     raise FileNotFoundError(f"Expected JSON file not found: {json_file}")  with open(json_file, 'r', encoding='utf-8') as f:     json_text = f.read()  data = json.loads(json_text) print("Loaded data:", data)

? 重要注意事项：

立即学习“Python免费学习笔记（深入）”；

• Jenkins 多配置项目中，参数需在 Configuration Matrix → Configuration 或 this build is parameterized 中正确定义为 String Parameter，名称为 REPO_PATH（无空格、无特殊字符）；
• Shell 构建步骤中，确保 Python 脚本通过 python script.py 执行（而非 ./script.py 未设 shebang 时可能失败）；
• 建议始终添加 encoding=’utf-8′ 避免中文或特殊字符读取异常；
• 生产环境推荐使用 pathlib.Path 替代字符串拼接（更现代、跨平台）：

from pathlib import Path import json  repo_path = Path(os.environ.get('REPO_PATH', '')) json_file = repo_path / 'file.json' if not json_file.is_file():     raise FileNotFoundError(f"JSON file missing: {json_file}") data = json.loads(json_file.read_text(encoding='utf-8'))

掌握这一模式后，你可无缝扩展支持任意 Jenkins 参数（如 BRANCH_NAME、BUILD_NUMBER），实现配置驱动的自动化脚本。