如何在SCons构建前自动清理过时的中间文件？

问题场景 #

项目构建分两步：先通过脚本把原始模板文件（比如some-header.hh.template）转成中间源文件（比如some-header.hh），再编译中间文件。修改或新增模板文件时，SCons能正常重建对应中间文件，但删除模板文件后，生成的中间文件不会自动删掉，导致明明应该失败的构建却能成功，出现误判。

试过用Glob获取旧中间文件、删除不在当前模板对应列表里的文件，但这个方案有问题：删除时机太晚，SCons已经感知到文件存在，报错信息来自SCons而非C++编译器，还不确定会不会影响SCons稳定性。

规范解决方案 #

方法1：绑定依赖+Clean机制

让中间文件和原始模板文件建立强依赖，同时给中间文件配置清理规则，从根源上解决问题：

1. 定义生成中间文件的Builder
   明确中间文件的依赖是对应的模板文件，示例代码：

   def generate_header(target, source, env):
       # 这里替换成你的脚本逻辑，比如读取模板文件生成中间文件
       with open(str(source[0]), 'r') as f_in, open(str(target[0]), 'w') as f_out:
           f_out.write(f_in.read().replace('{{PLACEHOLDER}}', 'actual_value'))
   
   # 注册自定义Builder
   generate_header_builder = Builder(action=generate_header, suffix='.hh', src_suffix='.template')
   env.Append(BUILDERS={'GenerateHeader': generate_header_builder})
   
   # 遍历模板文件生成中间文件，并绑定清理规则
   template_files = Glob('*.hh.template')
   for template in template_files:
       header = env.GenerateHeader(template)
       # 把中间文件加入clean目标的清理列表
       env.Clean('clean', header)
   

   这么做之后，只要模板文件被删除，SCons会发现中间文件的依赖缺失，构建直接报错；执行scons clean时，所有生成的中间文件也会被自动清理。

方法2：预构建阶段主动清理过时文件

在SCons开始分析依赖前，先检查所有中间文件是否有对应的模板文件，删掉没有对应模板的中间文件：

import os

# 拿到当前所有模板文件的文件名集合
template_files = set(os.path.basename(f) for f in Glob('*.hh.template'))
# 拿到已生成的中间文件列表
header_files = Glob('*.hh')

for header in header_files:
    # 推导对应的模板文件名
    template_name = f"{os.path.basename(header)}.template"
    if template_name not in template_files:
        os.remove(str(header))
        print(f"已删除过时中间文件: {header}")

把这段代码放在SConscript的最开头，确保在SCons开始构建分析前完成清理，这样SCons就不会再看到过时的中间文件，构建时会因为缺少必要文件而正确报错（报错来自编译器或自定义Builder）。

方法3：自定义清理Alias

如果需要更灵活的手动清理方式，可以加一个clean-outdated的自定义目标：

def clean_outdated_files(env):
    template_files = set(os.path.basename(f) for f in Glob('*.hh.template'))
    header_files = Glob('*.hh')
    for header in header_files:
        template_name = f"{os.path.basename(header)}.template"
        if template_name not in template_files:
            os.remove(str(header))
            print(f"已删除过时文件: {header}")
    return 0

# 注册自定义Alias
env.Alias('clean-outdated', [], action=lambda target, source, env: clean_outdated_files(env))

使用时执行scons clean-outdated就能清理所有无对应模板的中间文件，之后再执行scons就会因缺少中间文件正确失败。

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