Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

Add opt-in strict resolution of explicit `main` labels in `py_binary` and `py_test`

Offen
  • Stimmt etwas nicht?
#4,311 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
45/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
build-system

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Starlark
Sterne
688
Forks
728
Ø Merge
16 Std. 50 Min.
Gemergte PRs (30 T.)
136

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus bazel-contrib/rules_python

Alle Issues in bazel-contrib/rules_python

Ähnliche Issues

Weitere Issues zu Build System

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.