在使用python的`subprocess.run`函数执行外部命令行工具并捕获其标准输出时，开发者可能会遇到一个常见但令人困惑的问题：虽然在终端直接打印捕获到的输出看起来正常且格式良好，但当尝试对原始字符串进行进一步处理（例如解析json）时，却发现其中混杂了形如`\x1b[1;38m`的特殊字符。这些字符并非乱码，而是ansi转义码，它们的作用是在支持ansi的终端中控制文本的颜色、样式等显示效果。本教程旨在解释这一现象，并提供两种主流且高效的策略来处理这些转义码，从而获取纯净、可解析的cli输出。
理解ANSI转义码及其出现原因
许多现代命令行工具为了提升用户体验，会在其输出中嵌入ANSI转义码，以实现文本高亮、颜色区分等功能。例如，gh api命令在默认情况下可能会为JSON响应添加颜色，使其在终端中更易读。当subprocess.run以text=True模式捕获这些输出时，它会按字面意义将包含ANSI码的字符串存储起来。虽然print()函数在大多数支持ANSI的终端上能够正确解释并显示这些颜色，但对于程序内部的数据处理而言，这些控制字符是无用的噪声，会干扰JSON解析器等工具的正常工作。
原始问题中展示的输出：
'\x1b[1;38m[\x1b[m\n \x1b[1;38m{\x1b[m\n \x1b[1;34m"name"\x1b[m\x1b[1;38m:\x1b[m \x1b[32m"Devs"\x1b[m\x1b[1;38m,\x1b[m\n ...'这些\x1b开头的序列就是ANSI转义码。
解决方案一：从源头抑制CLI工具的颜色输出（推荐）
最优雅且推荐的解决方案是，在执行命令行工具时，通过其自身的参数或环境变量来禁用颜色输出。这样可以直接获取到纯净的数据流，避免后续处理的复杂性。
立即学习“Python免费学习笔记（深入）”；
应用场景： 当您调用的CLI工具提供了控制输出格式的选项时。
示例：使用gh api获取无颜色JSON
对于gh CLI工具，通常可以通过以下方式获取纯净的JSON输出：
-
使用--jq .参数： gh api命令支持--jq参数，它允许您使用jq工具对API响应进行处理。如果只希望获取原始JSON而不进行任何过滤，--jq .是一个非常有效的方法，它通常会抑制颜色输出。
import subprocess import json org_name = "your_organization" command = f"gh api --jq . /orgs/{org_name}/teams" try: # 使用text=True确保输出为字符串，并指定编码 result = subprocess.run(command, shell=True, capture_output=True, text=True, check=True, encoding='utf-8') # 此时result.stdout应该已经不包含ANSI颜色码 json_output = result.stdout # 解析JSON data = json.loads(json_output) print("成功解析的JSON数据示例：") print(data[0]['name']) # 假设输出是团队列表，获取第一个团队的名称 except subprocess.CalledProcessError as e: print(f"命令执行失败: {e}") print(f"标准错误输出: {e.stderr}") except json.JSONDecodeError as e: print(f"JSON解析失败: {e}") print(f"原始输出: {json_output[:200]}...") # 打印部分原始输出以便调试 -
检查CLI工具的文档： 许多CLI工具都提供了禁用颜色或获取机器可读输出的选项，例如：
在执行subprocess.run之前，可以设置环境变量：
import subprocess import os env = os.environ.copy() env["NO_COLOR"] = "1" # 尝试禁用颜色输出 command = "your_cli_command_with_colors" result = subprocess.run(command, shell=True, capture_output=True, text=True, env=env, encoding='utf-8') # ... 后续处理
优点： 这种方法最可靠，因为它是CLI工具自身提供的机制，能够保证输出格式的正确性，并且通常比手动移除转义码更高效。
解决方案二：使用正则表达式移除ANSI转义码
如果CLI工具不提供禁用颜色输出的选项，或者您需要处理的是已经包含ANSI转义码的字符串，那么使用正则表达式是另一种有效的清理方法。
应用场景： 当CLI工具没有提供直接禁用颜色输出的选项，或您需要处理任何可能包含ANSI码的文本时。
示例：使用Python正则表达式清理字符串
ANSI转义码通常遵循特定的模式，最常见的是\x1b[...m，其中...是数字和分号的序列。
import subprocess
import re
import json
def strip_ansi_codes(s: str) -> str:
"""
使用正则表达式移除字符串中的ANSI转义码。
"""
# 这个正则表达式可以匹配常见的ANSI颜色/样式代码
# 更健壮的正则可能需要考虑更多复杂的ANSI序列，
# 但对于颜色代码，这个通常足够。
ansi_escape = re.compile(r'\x1b\[[0-9;]*m')
return ansi_escape.sub('', s)
org_name = "your_organization"
# 假设此命令在默认情况下会输出带颜色的JSON
command = f"gh api /orgs/{org_name}/teams"
try:
result = subprocess.run(command, shell=True, capture_output=True, text=True, check=True, encoding='utf-8')
raw_output = result.stdout
print("原始输出（包含ANSI码）：")
print(raw_output[:200]) # 打印部分原始输出
clean_output = strip_ansi_codes(raw_output)
print("\n清理后的输出（不含ANSI码）：")
print(clean_output[:200]) # 打印部分清理后的输出
# 解析JSON
data = json.loads(clean_output)
print("\n成功解析的JSON数据示例：")
print(data[0]['name'])
except subprocess.CalledProcessError as e:
print(f"命令执行失败: {e}")
print(f"标准错误输出: {e.stderr}")
except json.JSONDecodeError as e:
print(f"JSON解析失败: {e}")
print(f"原始输出: {clean_output[:200]}...")正则表达式说明：
- \x1b: 匹配ASCII转义字符（Escape character）。
- \[: 匹配字面量的左方括号。
- [0-9;]*: 匹配零个或多个数字或分号。
- m: 匹配字面量的字母'm'，表示SGR（Select Graphic Rendition）参数的结束。
注意事项：
- 正则表达式的健壮性： 上述正则表达式可以处理大多数常见的颜色代码。然而，ANSI转义序列的种类繁多，如果遇到更复杂的序列（例如光标控制、屏幕擦除等），可能需要更复杂的正则表达式来确保所有控制字符都被移除。例如，一个更全面的正则表达式可能是re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')，但这通常超出了仅仅移除颜色代码的需求。
- 编码： 确保subprocess.run的encoding参数与CLI工具的实际输出编码一致，通常utf-8是一个安全的选择。text=True会自动处理字节到字符串的转换，但指定正确的编码可以避免潜在的解码错误。
总结
处理subprocess.run输出中的ANSI转义码是数据清洗的重要一环。优先选择通过CLI工具自身的参数来抑制颜色输出，这能够确保获取到最纯净、最符合预期的原始数据。当此方法不可行时，使用正则表达式进行后处理是可靠的备选方案。无论采用哪种方法，最终目标都是为了获得一个干净、可解析的字符串，以便后续进行数据结构化（如JSON解析）或其他业务逻辑处理。在实际应用中，建议结合具体CLI工具的特性和需求，选择最适合的策略。
