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

Deprecate and remove implicit py_binary zipapp support

Offen
  • Stimmt etwas nicht?
#3,567 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
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Refactoring
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
python
Bereich
build-system

Rechercherichtung

Durchsuche das Repository nach build_python_zip und python_zip_file und untersuche anschließend die referenzierten BUILD-Dateien, my_rule.bzl-Implementierungen und rule.bzl-Transitions. Vergleiche jede Verwendung mit den Migrationsfällen in diesem Issue und identifiziere die betroffenen Bazel-Ziele. Erledigt bedeutet, dass alte implizite zipapp-Pfade entfernt oder zu py_zipapp_binary oder py_zipapp_test migriert wurden, ohne die relevanten Builds zu beeinträchtigen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

The implicit zipapp support of py_binary and py_test is being deprecated and removed. It is replaced by the py_zipapp_binary and py_zipapp_test rules. There are several ways the implicit zipapp logic may be activated.

For reference, these are the two loads you're most likely to need:

load("@rules_python//python/zipapp:py_zipapp_binary.bzl", "py_zipapp_binary")
load("@rules_python//python/zipapp:py_zipapp_test.bzl", "py_zipapp_test")

The flag name you want to look for is build_python_zip.

Windows-specific note: Windows enables zipapp by default, so the absence of the flag is the same as --build_python_zip=true !

Migration guide

This guide tries to give information on how to handle all possible cases of what may need to be migrated. Most changes are small, should be transparent, and can be done incrementally.

In practice, the most likely scenario you'll need to fix is using the
--build_python_zip flag on the command line -- see the "Migrate explicit --build_python_zip" section for that case.

Disable legacy zipapp flag

Add common --build_python_zip=false --@rules_python//python/config_settings:build_python_zip=false to your .bazelrc

Windows-specific note: Windows enables zipapp by default

Migrate explicit --build_python_zip usage

TLDR: Replace --build_python_zip on the command line with a py_zipapp_binary target in a BUILD file.

Replace this:

# File: BUILD

py_binary(name="bin")

# Command line
bazel build //:bin --build_python_zip

With this:

# File: BUILD
load("@rules_python//python/zipapp:py_zipapp_binary", "py_zipapp_binary")

py_binary(name="bin")
py_zipapp_binary(name = "bin_zipapp", binary=":bin")

# Command line
bazel build //:bin_zipapp

Migrate py_binary using config_settings with py_zipapp rule

TLDR: Add py_zipapp_binary for each py_binary you want as a zipapp

Replace this:

py_binary(
  name = "bin"
  config_settings = {
    "@rules_python//python/config:build_python_zip": "true",
    "//command_line_option:build_python_zip": "true",
  },
  ...
)

With this:

load("@rules_python//python/zipapp:py_zipapp_binary", "py_zipapp_binary")

py_binary(
  name = "bin"
  ...
)

py_zipapp_binary(
  name = "bin.zipapp",
  binary = ":bin",
)

Migrate filegroup using python_zip_file output group

Replace this:

TLDR: Add py_zipapp_binary and point the filegroup to it.

py_binary(name = "bin", ...)

filegroup(
  name = "bin_zip_file",
  output_group = "python_zip_file",
  srcs = [":bin"],
)

With this:

load("@rules_python//python/zipapp:py_zipapp_binary", "py_zipapp_binary")

py_binary(name = "bin", ...)
py_zipapp_binary(name = "bin_zipapp", binary=":bin")
filegroup(
  name = "bin_zip_file",
  output_group = "python_zip_file",
  srcs = [":bin_zipapp"],
)

Migrate Starlark using python_zip_file output group

TLDR: Add py_zipapp target and use it as the input target instead.

Replace this:

# File: my_rule.bzl
def _my_rule_impl(ctx):
  zip_file = ctx.attr.binary[OutputGroupInfo]["python_zip_file"].to_list()[0]

# File: BUILD.bazel
py_binary(name="bin", ...)
my_rule(name = "mytarget", binary=":bin", ...)

With this:

# File: my_rule.bzl

def _my_rule_impl(ctx):
  zip_file = ctx.attr.binary[OutputGroupInfo]["python_zip_file"].to_list()[0]

# File: BUILD.bazel
load("@rules_python//python/zipapp:py_zipapp_binary", "py_zipapp_binary")
py_binary(name="bin", ...)
py_zipapp_binary(name = "bin_zipapp", binary=":bin")
my_rule(name = "mytarget", binary=":bin_zipapp", ...)

Migration transitions setting build_python_zip flags

TLDR: Remove the build_python_zip flags from the transition and refactor into a separate target.

Replace this:

# File: rule.bzl
my_transition = transition(
   outputs = [
      "//command_line_settings:build_python_zip",
      "@rules_python//python/config_settings:build_python_zip",
   ],
   ...
)
my_rule(cfg = my_transition, ...)

# File: BUILD
py_binary(name="bin", ...)
my_rule(target=":bin")

With this:

# File: rule.bzl
my_transition = transition(
   outputs = [],
   ...
)
my_rule(cfg = my_transition, ...)

# File: BUILD
load("@rules_python//python/zipapp:py_zipapp_binary", "py_zipapp_binary")
py_binary(name="bin", ...)
py_zipapp_binary(name="bin_zipapp", binary=":bin")
my_rule(target=":bin_zipapp")
Vorherrschende Sprache
Starlark
Sterne
687
Forks
726
Ø Merge
1 T. 7 Std.
Gemergte PRs (30 T.)
77

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.