通过Pipeline调用Git API传递字符串时遭遇Python语法错误

问题 #

在Pipeline运行中通过Git API调用向Git页面传递字符串时，触发Python语法错误，报错代码及相关信息如下：

报错代码：

gitCheckInputString = '''{"name":"''' + gitCheckName + '''","output":{"title":"''' + gitCheckName + '''","summary":"''' + message + '''","text":"''' + "The summary:\n{ unaudited: " + str($(params.unaudited)) + "\n    live: " + str($(params.live)) + "\n    real: " + str($(params.real)) + "  }" + "\n " + [Click on the link to see results on the Tekton build pipeline](''' + pipelineURL + ''') + '''"}}'''

print(gitCheckInputString)

错误提示：

SyntaxError: invalid syntax. Perhaps you forgot a comma?

预期输出：

Click on the link to see results on the Tekton build

The summary: 

{ unaudited: 10
  
  live: 0
  
  real: 9
}

解决方案 #

错误根源 #

1. Markdown链接语法误用：代码中直接写[Click on...](pipelineURL)属于Python语法错误——这是Markdown链接格式，但Python会将[Click...]识别为列表语法，直接触发解析错误。
2. 引号拼接混乱：嵌套的三重单引号与普通单引号混合拼接，容易出现引号闭合错误，导致语法解析失败。
3. Pipeline参数引用错误：$(params.unaudited)是Pipeline的参数语法，无法直接在Python代码中使用，需要转换为对应的Python变量。

修正后的代码 #

推荐使用Python的f-string格式化字符串来简化拼接，避免引号混乱，同时正确处理内容格式：

# 先将Pipeline参数转为Python变量（示例值，实际替换为Pipeline传递的真实参数）
unaudited = 10
live = 0
real = 9
gitCheckName = "示例检查任务"
message = "检查结果摘要"
pipelineURL = "http://your-pipeline-url.com"

# 构造文本内容，用f-string填充变量，双大括号表示输出普通大括号
text_content = f"""Click on the link to see results on the Tekton build pipeline

The summary: 

{{ unaudited: {unaudited}
  
  live: {live}
  
  real: {real}
}}
"""

# 构造最终的JSON格式字符串
gitCheckInputString = f'''{{"name":"{gitCheckName}","output":{{"title":"{gitCheckName}","summary":"{message}","text":"{text_content}"}}}}'''

print(gitCheckInputString)

关键注意事项 #

• Markdown链接处理：如果需要在文本中包含可点击链接，直接写成字符串形式[链接文本]({pipelineURL})即可，比如将text_content修改为：

  text_content = f"""[Click on the link to see results on the Tekton build pipeline]({pipelineURL})
  
  The summary: 
  
  {{ unaudited: {unaudited}
    
    live: {live}
    
    real: {real}
  }}
  """
  

• 大括号转义：f-string中若要输出普通的{}，必须写成双大括号{{}}，避免被识别为变量占位符。
• 参数转换：确保Pipeline的params参数已正确转换为Python变量，不能直接在代码中保留$(params.xxx)格式。

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