如何在脚本式Jenkinsfile中调用带参数与返回值的Python脚本

实现方案 #

在脚本式Jenkinsfile中，通过sh步骤执行Python脚本，利用标准输出传递返回数据，同时捕获输出结果供后续步骤使用，具体实现如下：

完整Jenkinsfile示例 #

node {
    stage('Code Test Run') {
        // 执行测试生成XML结果，替换为你的实际测试命令
        sh 'your-test-execution-command'
        // 假设生成的XML文件路径为 ./test-output/results.xml
    }

    stage('Parse XML') {
        // 调用Python脚本1，传入XML文件路径，捕获解析结果
        def parsedXml = sh(
            script: "python3 parse_xml.py ./test-output/results.xml",
            returnStdout: true
        ).trim()

        // 将解析结果存入环境变量，实现跨stage数据共享
        env.PARSED_XML_DATA = parsedXml
        echo "XML解析完成，结果长度：${parsedXml.length()}"
    }

    stage('Publish to website') {
        // 调用Python脚本2，传入解析后的XML数据，捕获API调用状态
        def apiCallStatus = sh(
            script: "python3 publish_to_api.py '${env.PARSED_XML_DATA}'",
            returnStdout: true
        ).trim()

        echo "API调用状态：${apiCallStatus}"
        // 非成功状态直接终止流水线
        if (apiCallStatus != 'success') {
            error "发布失败，API返回状态：${apiCallStatus}"
        }
    }
}

关键细节说明 #

• 参数传递：直接在Python脚本路径后追加命令行参数，若参数包含空格或特殊字符，需用单引号包裹避免解析错误。
• 返回值捕获：sh步骤设置returnStdout: true可捕获脚本的标准输出，.trim()用于清理输出首尾的换行、空格等冗余字符。
• Python脚本适配：

  • 脚本需通过print()输出返回结果（不要混入日志等无关输出，否则会干扰返回值捕获）。

  • 用sys.argv接收命令行参数，示例脚本如下：
    parse_xml.py

    import sys
    import xml.etree.ElementTree as ET
    
    def parse_xml(xml_file_path):
        tree = ET.parse(xml_file_path)
        root = tree.getroot()
        # 自定义解析逻辑，返回需要的字符串格式结果
        return ET.tostring(root, encoding='utf-8').decode('utf-8')
    
    if __name__ == "__main__":
        input_path = sys.argv[1]
        parsed_result = parse_xml(input_path)
        print(parsed_result)
    

    publish_to_api.py

    import sys
    import requests
    
    def send_to_api(parsed_data):
        // 替换为你的实际API调用逻辑
        response = requests.post("https://your-target-api.com/publish", data={"content": parsed_data})
        return "success" if response.ok else "failed"
    
    if __name__ == "__main__":
        input_data = sys.argv[1]
        api_status = send_to_api(input_data)
        print(api_status)
    

• 跨stage数据共享：通过Jenkins环境变量（env.XXX）存储中间结果，避免直接传递长字符串可能引发的格式问题。

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