使用python-jenkins调用server.delete_build删除Jenkins构建时报错求解
python-jenkins调用delete_build异常处理
场景说明
通过python-jenkins封装库对接Jenkins服务执行操作时,调用server.delete_build删除指定历史构建,每次执行均触发异常。
复现代码
import jenkins def build_job(para_value): server = jenkins.Jenkins('http://localhost:8080', username='username', password='password') if not server.job_exists('job_name'): server.create_job('job_name', jenkins.EMPTY_CONFIG_XML) server.build_job('job_name', parameters={'para1': para_value}) def delete_build(jobID): print(jobID) server = jenkins.Jenkins('http://localhost:8080', username='username', password='password') server.delete_build('job_name', jobID)
错误栈信息
实际运行触发的调用栈如下:
File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/jenkins/__init__.py", line 1415, in delete_build self.jenkins_open(requests.Request('POST', File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/jenkins/__init__.py", line 557, in jenkins_open return self.jenkins_request(req, add_crumb, resolve_auth).text File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/jenkins/__init__.py", line 573, in jenkins_request self.maybe_add_crumb(req) File "/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages/jenkins/__init__.py", line 379, in maybe_add_crumb req.headers[self.crumb['crumbRequestField']] = self.crumb['crumb']
报错根因
该异常本质是Jenkins连接实例的CSRF防护校验令牌(crumb)未被正确加载,当触发POST类操作(如删除构建)时,代码尝试读取空的crumb字典字段,触发键值读取错误。常见触发原因包括:
- 传入的认证凭证无效,初始化连接时无法通过Jenkins权限校验拉取crumb值
- python-jenkins库的crumb拉取逻辑和当前Jenkins服务版本不兼容,惰性加载机制导致crumb字段为空
- 传入的构建号参数格式不符合接口要求,触发路由匹配异常后连带引发crumb加载失败
可落地解决方案
- 校验认证凭证有效性
优先使用Jenkins个人中心生成的API Token替代账号明文密码做认证,确认凭证拥有对应任务的删除权限。初始化连接后可通过打印server.crumb字段,确认crumb值被正确拉取,若拉取失败会直接暴露权限配置问题。 - 手动触发crumb加载
初始化Jenkins连接实例后,手动调用server.get_crumb()方法强制拉取一次crumb值,解决惰性加载导致的空值问题。修改后的delete_build函数参考:def delete_build(jobID): server = jenkins.Jenkins('http://localhost:8080', username='username', password='password') # 强制拉取crumb,避免空值触发后续操作异常 server.get_crumb() server.delete_build('job_name', int(jobID)) - 版本适配调整
若使用的是版本较老的Jenkins服务,升级python-jenkins库到和服务端版本匹配的稳定版本,避免crumb接口字段不兼容的问题;初始化连接时可显式传入超时参数,避免网络请求超时导致crumb拉取失败。 - 参数格式校验
确认传入delete_build的构建号为整数类型,避免字符串格式的构建号导致接口路由匹配异常。
内容的提问来源于stack exchange,提问作者AqeelAsks
相关产品推荐
相关产品推荐

