如何清理gh api命令输出的ANSI控制字符以解析JSON数据？

问题场景 #

通过Python的subprocess调用GitHub CLI的gh api命令获取组织团队数据，代码如下：

import subprocess
j = subprocess.run("gh api /orgs/{__org__}/teams", shell=True, stdout=subprocess.PIPE, text=True)

执行后j.stdout包含API响应，但原始字符串里混有大量ANSI控制字符（如\x1b），导致无法直接解析为JSON。手动清理控制字符未成功，需要获取干净的JSON数据转为字典列表。

解决方法 #

方法1：让gh api直接输出纯JSON（推荐） #

GitHub CLI的gh api默认会输出带颜色的格式化内容，只需添加--plain-text参数禁用颜色输出，就能得到无ANSI控制字符的纯JSON：

import subprocess
import json

# 添加--plain-text参数禁用颜色输出
result = subprocess.run(
    "gh api /orgs/{__org__}/teams --plain-text",
    shell=True,
    stdout=subprocess.PIPE,
    text=True,
    stderr=subprocess.PIPE  # 可选：捕获错误输出
)

# 直接解析JSON为字典列表
teams = json.loads(result.stdout)
print(teams)

也可以用--jq '.'参数强制输出原始JSON结构，效果一致：

gh api /orgs/{__org__}/teams --jq '.'

方法2：用Python正则清理ANSI控制字符 #

如果无法修改gh api命令，可通过正则表达式匹配并移除所有ANSI转义序列：

import subprocess
import json
import re

result = subprocess.run(
    "gh api /orgs/{__org__}/teams",
    shell=True,
    stdout=subprocess.PIPE,
    text=True
)

# 匹配并移除所有ANSI控制字符
cleaned_output = re.sub(r'\x1b\[[0-9;]*[a-zA-Z]', '', result.stdout)

# 解析为字典列表
teams = json.loads(cleaned_output)
print(teams)

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