Add opt-in strict resolution of explicit `main` labels in `py_binary` and `py_test`
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 45/100
- Issue 類型
- 功能
- 描述清晰度
- 描述清楚
- 活躍度
- 活躍
- 技術堆疊
- python
- 領域
- build-system
研究方向
Read python/private/py_executable.bzl, especially determine_main in the version linked by the issue, and trace how py_binary and py_test pass main and srcs into entrypoint selection. Implementing this needs analysis-time artifact comparison, validation, and compatibility with generated outputs and aliases. Done means strict mode is opt-in, rejects mismatched artifacts with a clear diagnostic, preserves default behavior, and has coverage for the listed cases.
由索引模型根據 Issue 內容生成。
描述
Relevant Rules
py_binary and py_test.
Description
The main attribute is label-valued, but entrypoint selection uses only ctx.attr.main.label.name to suffix-match files in srcs. Consequently, the explicit label does not necessarily identify the file selected as the entrypoint.
For example, suppose shared/entry.py exists and is exported by //shared, while app/entry.py does not exist:
# app/BUILD.bazel
load("@rules_python//python:defs.bzl", "py_binary")
py_binary(
name = "app",
srcs = ["//shared:entry.py"],
main = "entry.py",
)
Bazel resolves main to //app:entry.py, but the rule selects //shared:entry.py through filename matching. The query graph can nevertheless contain a source-file target for the nonexistent //app:entry.py. Tools that consume this graph and inspect source files, such as bazel-diff, can then report missing-file warnings even though the actual entrypoint is correctly supplied through srcs.
There is also an ambiguity case:
py_binary(
name = "app",
srcs = [
"//foo:entry.py",
"//bar:entry.py",
],
main = "//foo:entry.py",
)
Filename matching finds two candidates even though the explicit label identifies one file unambiguously.
In 2.4.3, the latest stable release, determine_main retains this filename-matching behavior. I recognize that it is intentional; this request is for an optional stricter contract, not an incompatible change to the default.
Describe the solution you'd like
Add an opt-in strict mode, for example a strict_main attribute defaulting to False. The specific API is open to discussion; enabling it through project-owned wrappers would allow gradual adoption.
When strict mode is enabled and main is explicitly provided:
- Resolve the full label to its file artifact and use that artifact as the entrypoint.
- Require that artifact to be among the files supplied by
srcs. - Fail during analysis with a clear diagnostic if the requirement is not satisfied, rather than selecting a different file with a matching name.
- Compare resolved artifacts rather than label strings, preserving support for aliases, single-file filegroups, and generated sources.
- Preserve applicable entrypoint file-type validation.
Validation should compare the resolved main and srcs artifacts during analysis, including declared generated outputs. Bazel's normal build-time input and output checks should remain responsible for enforcing file availability. For example, a generated entrypoint is valid when both attributes resolve to the same declared output artifact; its generating action need not have run yet.
When main is omitted, retain the existing default-entrypoint inference. When strict mode is disabled, preserve existing behavior.
This would let projects enforce that explicit entrypoint labels accurately describe their dependencies without requiring an immediate migration for all users.
Describe alternatives you've considered
Correct individual declarations. Using main = "//shared:entry.py" fixes the first example's misleading graph entry. This is a useful immediate workaround, but the rule still accepts future mismatches, and fully qualified labels do not resolve the second example's filename ambiguity.
Project-local linting or analysis checks. These could enforce the policy locally, but would require separate tooling to validate the relationship between the resolved main and srcs artifacts. Enforcing the contract in the executable rule would provide a direct diagnostic where the entrypoint is selected.
Make exact label resolution the default immediately. This would be a breaking change for configurations that rely on the documented filename-matching behavior. An opt-in mode provides a compatibility-preserving adoption path.
- 主要語言
- Starlark
- 星號
- 688
- 分支
- 728
- 平均合併
- 17 小時 24 分鐘
- 30 天內合併 PR
- 131
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
bazel-contrib/rules_python 的其他 Issue
-
難度 1/5 1 小時以內 新手友好度 82/100
bazel-contrib/rules_python#4319 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
bazel-contrib/rules_python#4251 · 1 個 reaction ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 78/100
bazel-contrib/rules_python#4164 · 1 則留言 ·
維護者通常 1 天內回覆
-
need: repro
難度 5/5 一週以上 新手友好度 35/100
bazel-contrib/rules_python#4315 · 1 則留言 ·
維護者通常 1 天內回覆
-
pip.parse ignores uv.lock dependency-edge platform markers可能已有人在做 @kdelalic 於 6 天前認領。 未關閉
難度 4/5 3-5 天 新手友好度 20/100
bazel-contrib/rules_python#4287 ·
維護者通常 1 天內回覆
查看 bazel-contrib/rules_python 的全部 Issue
相似的 Issue
-
bug triage
難度 2/5 1-3 小時 新手友好度 66/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 62/100
-
難度 2/5 1-3 小時 新手友好度 65/100
NVIDIA/flare-local-inference#90 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 70/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 66/100
osam-cologne/archlinux-proaudio#917 ·
維護者通常 1 天內回覆