如何在Bazel中基于文件时间戳控制目标重建时机？

不用折腾genrule的平台兼容问题，直接用Starlark写自定义规则，配合Python脚本实现跨平台的文件修改时间检查，完全适配Bazel的增量构建逻辑。

实现思路 #

核心是通过自定义规则调用Python脚本，计算文件当前时间与最后修改时间的差值，生成一个标记文件。Bazel会根据这个标记文件的内容变化（0或1）来判断是否触发下游目标的重建——当文件超过设定时长未修改时，标记文件内容变更，触发重建；否则保持不变，跳过重建。

分步实现 #

1. 编写自定义规则（timestamp_rules.bzl） #

这个规则负责接收输入文件、时效参数，调用检查脚本并生成标记文件：

def _timestamp_check_impl(ctx):
    input_file = ctx.file.src
    output_stamp = ctx.actions.declare_file(f"{ctx.label.name}.stamp")

    # 构造脚本参数：文件路径、最大允许时长（秒）、输出标记文件路径
    args = ctx.actions.args()
    args.add(input_file.path)
    args.add(ctx.attr.max_age_seconds)
    args.add(output_stamp.path)

    # 执行检查脚本
    ctx.actions.run(
        inputs = [input_file],
        outputs = [output_stamp],
        executable = ctx.executable._check_script,
        arguments = [args],
    )

    return [DefaultInfo(files = depset([output_stamp]))]

timestamp_check_rule = rule(
    implementation = _timestamp_check_impl,
    attrs = {
        "src": attr.label(allow_single_file = True, mandatory = True),
        "max_age_seconds": attr.int(default = 21600),  # 默认6小时（21600秒）
        "_check_script": attr.label(
            default = Label("//tools:check_timestamp.py"),
            executable = True,
            cfg = "exec",
        ),
    },
)

2. 跨平台时间检查脚本（tools/check_timestamp.py） #

用Python实现跨平台的时间计算，避免shell脚本的平台差异：

import os
import time
import sys

def main():
    if len(sys.argv) != 4:
        print("参数错误：需要 <输入文件路径> <最大时长（秒）> <输出标记文件路径>", file=sys.stderr)
        sys.exit(1)

    input_path, max_age_str, output_path = sys.argv[1], sys.argv[2], sys.argv[3]
    max_age = int(max_age_str)

    # 获取文件最后修改时间戳
    file_mtime = os.path.getmtime(input_path)
    current_time = time.time()

    # 判断是否需要重建：文件修改时间距当前超过设定时长则返回1，否则0
    need_rebuild = 1 if (current_time - file_mtime) > max_age else 0

    # 将结果写入标记文件，Bazel通过文件内容变化感知是否需要重建
    with open(output_path, "w") as f:
        f.write(str(need_rebuild))

if __name__ == "__main__":
    main()

3. 在BUILD文件中使用 #

将检查规则作为依赖，下游目标（比如genrule、自定义规则等）会根据标记文件的变化决定是否重建：

load("//tools:timestamp_rules.bzl", "timestamp_check_rule")

# 定义文件时效检查目标
timestamp_check_rule(
    name = "check_data_file",
    src = "data.txt",
    max_age_seconds = 21600,  # 6小时
)

# 依赖检查结果的业务目标
genrule(
    name = "process_data",
    srcs = [":check_data_file", "data.txt"],
    outs = ["processed_data.txt"],
    cmd = "cp $(location data.txt) $@",
)

优势对比 #

• 跨平台兼容：Python脚本无需区分Windows/Linux/macOS，Bazel会自动处理执行环境。
• 符合Bazel构建模型：通过标记文件的内容变化触发重建，完全适配Bazel的增量构建逻辑，不会出现误判。
• 可维护性高：规则逻辑和检查逻辑分离，比嵌套复杂shell命令的genrule更易调试和修改。

注意事项 #

• 确保Bazel能访问Python环境：可以在.bazelrc中通过build --python_path=/usr/bin/python3指定路径，或者使用rules_python管理Python依赖。
• 标记文件的作用：Bazel会缓存标记文件的内容，只有当内容变化时才会触发下游目标重建，避免不必要的重复构建。

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