如何将Pylint配置为Bazel run/build命令？并标准化同类工具流程

核心思路是利用Bazel的Aspect机制批量处理目标，结合.bazelrc统一配置命令行参数，实现工具调用的标准化，同时为后续Black、Buildifier扩展预留一致的结构。

1. 统一配置命令行触发规则 #

在项目根目录的.bazelrc中定义各工具的config，让bazel run/build --config=<tool>直接触发对应逻辑：

# Pylint 配置
build:pylint --aspects=//tools/lint:pylint.bzl%pylint_aspect
build:pylint --output_groups=+pylint_report
run:pylint --aspects=//tools/lint:pylint.bzl%pylint_aspect
run:pylint --output_groups=+pylint_report

# Black 配置（后续扩展用）
build:black --aspects=//tools/format:black.bzl%black_aspect
build:black --output_groups=+black_report
run:black --aspects=//tools/format:black.bzl%black_aspect
run:black --output_groups=+black_report

# Buildifier 配置（后续扩展用）
build:buildifier --aspects=//tools/format:buildifier.bzl%buildifier_aspect
build:buildifier --output_groups=+buildifier_report
run:buildifier --aspects=//tools/format:buildifier.bzl%buildifier_aspect
run:buildifier --output_groups=+buildifier_report

2. 编写通用Aspect规则 #

Aspect可以自动为匹配的目标（如Python源文件、BUILD文件）添加检查/格式化动作，无需逐个目标手动配置。

以Pylint为例实现Aspect #

创建//tools/lint/pylint.bzl：

def _pylint_aspect_impl(target, ctx):
    # 过滤出包含Python源文件的目标（py_library/py_binary等）
    if not hasattr(ctx.rule.attr, "srcs"):
        return []

    py_files = [f for f in ctx.rule.attr.srcs if f.path.endswith(".py")]
    if not py_files:
        return []

    # 生成Pylint报告文件
    report = ctx.actions.declare_file(f"{target.label.name}_pylint_report.txt")
    ctx.actions.run(
        executable = ctx.executable._pylint,
        arguments = [
            "--output-format=text",
            "--reports=no",
            *[f.path for f in py_files],
            f"--output={report.path}",
        ],
        inputs = py_files,
        outputs = [report],
        tools = [ctx.executable._pylint],
    )

    # 暴露输出组，让bazel build/run能获取报告
    return [OutputGroupInfo(pylint_report = depset([report]))]

pylint_aspect = aspect(
    implementation = _pylint_aspect_impl,
    attrs = {
        "_pylint": attr.label(
            executable = True,
            cfg = "exec",
            default = Label("//tools/lint:pylint"),
        ),
    },
)

再创建//tools/lint/BUILD定义Pylint工具目标（假设用pip管理依赖）：

load("@pip_deps//:requirements.bzl", "requirement")

py_binary(
    name = "pylint",
    main = "pylint",
    deps = [requirement("pylint")],
)

适配格式化工具（如Black） #

对于Black这类需要修改源文件的工具，调整Aspect逻辑区分build和run行为：

• bazel run --config=black：原地格式化源文件
• bazel build --config=black：生成格式化后的文件作为输出

示例//tools/format/black.bzl：

def _black_aspect_impl(target, ctx):
    if not hasattr(ctx.rule.attr, "srcs"):
        return []

    py_files = [f for f in ctx.rule.attr.srcs if f.path.endswith(".py")]
    if not py_files:
        return []

    if ctx.var.get("BUILD_MODE") == "run":
        # Run模式：原地格式化
        ctx.actions.run(
            executable = ctx.executable._black,
            arguments = ["--in-place", *[f.path for f in py_files]],
            inputs = py_files,
            outputs = py_files,
            tools = [ctx.executable._black],
        )
    else:
        # Build模式：生成格式化后的文件
        formatted_files = []
        for f in py_files:
            formatted = ctx.actions.declare_file(f"{f.basename}_formatted.py")
            ctx.actions.run(
                executable = ctx.executable._black,
                arguments = [f.path, f"--output={formatted.path}"],
                inputs = [f],
                outputs = [formatted],
                tools = [ctx.executable._black],
            )
            formatted_files.append(formatted)
        return [OutputGroupInfo(black_report = depset(formatted_files))]

    return []

black_aspect = aspect(
    implementation = _black_aspect_impl,
    attrs = {
        "_black": attr.label(
            executable = True,
            cfg = "exec",
            default = Label("//tools/format:black"),
        ),
    },
)

同时在.bazelrc的run配置中添加--define=BUILD_MODE=run来标识运行模式。

3. 标准化目录结构 #

为便于扩展维护，统一工具存放结构：

tools/
├── lint/          # 静态检查工具（Pylint等）
│   ├── BUILD
│   └── pylint.bzl
└── format/        # 格式化工具（Black、Buildifier等）
    ├── BUILD
    ├── black.bzl
    └── buildifier.bzl

4. 验证命令 #

• 运行Pylint检查：bazel build --config=pylint //...，报告生成在bazel-bin对应目录；bazel run --config=pylint //...直接输出检查结果
• 运行Black格式化：bazel run --config=black //...自动格式化目标Python文件

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