如何將轉義斜杠傳遞給 subprocess.run

Question

嘗試從 Python 腳本運行命令：

gh api "/search/code?q=somecode" --jq ".items[] | { "file": .path, "repo": .repository[\"full_name\"] } "

通過：

output = subprocess.run( [ 'gh', f'api "/search/code?q={CODE}"', '--jq ".items[] | {{ "file": .path, "repo": .repository[{}] }} "'.format('\\"full_name\\"') ])

無濟於事。

我也試過：

.format(r'\"full_name\"')

afaik，應該可以工作，但我明白了

Command '['gh', 'api "/search/code?q=somecode"', '--jq ".items[] | { "file": .path, "repo": .repository[\\"full_name\\"] } "']' returned non-zero exit status 1.

使用.format(repr('\"full_name\"'))產生：

Command '['gh', 'api "/search/code?q=staging-procore-tech-docs+org:procore"', '--jq ".items[] | { "file": .path, "repo": .repository[\'"full_name"\'] } "']' returned non-zero exit status 1.

在此先感謝，我已經花了至少 3 個小時閱讀文檔，所以問朋友

Answer 1

我同樣在我的 Mac OS X（M1 芯片）上嘗試過這個並在我這邊遇到了類似的問題。 我最初通過自制軟件 ( brew ) 安裝了GitHub CLI ( gh )。

我有幾點建議修復：

1. 使用shlex.split （明確地）將多詞 arguments 拆分為 arguments 的列表
2. 將完整路徑傳遞給命令，您可以通過在終端中運行which gh來獲取該命令
3. 使用rf''模板或 f- 字符串，其中r用於原始字符串，因此反斜杠\會自動轉義

把所有這些放在一起：

from __future__ import annotations

import shlex
import subprocess

CODE = 'somecode'

# full path to `gh` command
GH_BINARY = '/opt/homebrew/bin/gh'

cmd: list[str] = shlex.split(rf'{GH_BINARY} api "/search/code?q={CODE}" --jq ".items[] | {{ "file": .path, "repo": .repository[\"full_name\"]}} "')
result = subprocess.run(cmd, capture_output=True)

print('Return Code:', result.returncode)
print('Output:', result.stdout.decode())

Output（編輯）：

Return Code: 0
Output: {"file":"tuixiangzi-control/Debug/tuixiangzi-control.Build.CppClean.log","repo":"ChaoFeng-alone/tuixiangzi"}
{"file":"tuixiangzi-easyx/Debug/tuixiangzi-easyx.Build.CppClean.log","repo":"ChaoFeng-alone/tuixiangzi"}
...