如何在Python脚本中高效使用clang-format格式化C++代码片段

基础实现：单代码片段格式化 #

针对单个代码字符串（比如"if(i == 0){return;}"），可以利用clang-format的标准输入输出特性，通过subprocess的communicate方法一次性完成输入输出交互，无需手动操作stdin关闭：

import subprocess

def format_single_snippet(code, clang_format_bin="clang-format-12"):
    # 启动clang-format进程，绑定标准输入输出
    proc = subprocess.Popen(
        [clang_format_bin],
        stdin=subprocess.PIPE,
        stdout=subprocess.PIPE,
        stderr=subprocess.PIPE,
        text=True
    )
    # 传入代码并获取格式化结果
    formatted_code, err_msg = proc.communicate(input=code)
    
    if proc.returncode != 0:
        raise RuntimeError(f"格式化失败: {err_msg.strip()}")
    return formatted_code.strip()

# 测试示例
raw_code = "if(i == 0){return;}"
print(format_single_snippet(raw_code))
# 输出示例：
# if (i == 0) {
#   return;
# }

高效优化：复用clang-format进程处理大量片段 #

频繁启动子进程是效率瓶颈，通过保持一个长期运行的clang-format进程，持续发送代码片段并读取结果，可以大幅提升批量处理的速度。核心思路是用特殊标记分隔不同代码片段，确保能准确拆分格式化后的结果：

import subprocess

class ClangFormatReusable:
    def __init__(self, clang_format_bin="clang-format-12", style="Google"):
        # 启动进程并禁用缓冲，保证实时交互
        self.proc = subprocess.Popen(
            [clang_format_bin, f"-style={style}"],
            stdin=subprocess.PIPE,
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
            text=True,
            bufsize=0
        )
        # 定义不会被格式化的结束标记
        self.end_marker = "/* END_OF_SNIPPET */"

    def format(self, code):
        # 发送代码+结束标记，强制clang-format处理并输出完整结果
        self.proc.stdin.write(f"{code}\n{self.end_marker}\n")
        self.proc.stdin.flush()

        formatted_lines = []
        while True:
            line = self.proc.stdout.readline()
            if not line:
                raise RuntimeError("clang-format进程意外退出")
            # 读取到标记时停止，结束当前片段的结果收集
            if line.strip() == self.end_marker:
                break
            formatted_lines.append(line)
        
        return "".join(formatted_lines).rstrip("\n")

    def close(self):
        # 清理进程资源
        self.proc.stdin.close()
        self.proc.wait()

# 批量使用示例
processor = ClangFormatReusable()
try:
    code_snippets = [
        "if(i == 0){return;}",
        "int a=10;for(int j=0;j<5;j++){a+=j;}",
        "void func(){return;}"
    ]
    for snippet in code_snippets:
        print(f"原代码: {snippet}")
        print(f"格式化后:\n{processor.format(snippet)}")
        print("---")
finally:
    processor.close()

关键注意事项 #

• 可通过-style参数指定格式化风格，比如LLVM、Google，或用-style=file读取当前目录的.clang-format配置文件
• 若代码片段存在语法错误，clang-format会将错误信息输出到stderr，可在类中添加错误捕获逻辑，读取self.proc.stderr内容排查问题
• 确保clang-format的路径正确，部分系统中二进制文件名为clang-format而非clang-format-12

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