Skip to content

Conversation

@rickeylev
Copy link
Collaborator

This adds Python zipapp support as a separate rule that works with a py_binary.

This will eventually replace the zipapp logic that is directly part of py_binary.

The high level behavior should be the same, but there's a few differences and improvements:

Changes:

  • Output name is {name}.pyz
  • Whether the output is executable is controlled by attribute, not flag.

Improvements:

  • Compression level can be explicitly controlled.
  • Re-unzipping optimization: only unzip if the zip's hash changed
  • Zip output is more deterministic (input order doesn't affect output)
  • runfiles.symlinks, runfiles.root_symlinks, and raw symlinks are supported
  • Zipping venv-based binary is supported
  • Lower analysis-phase cost
  • Self-execution doesn't require python itself

@rickeylev rickeylev requested a review from aignas as a code owner January 25, 2026 00:41
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @rickeylev, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a comprehensive overhaul of Python zip application (zipapp) support within the Bazel rules. By extracting zipapp creation into new, dedicated py_zipapp_binary and py_zipapp_test rules, the change aims to provide a more robust, feature-rich, and performant mechanism for packaging Python applications. It enhances control over the build process, improves determinism, and lays the groundwork for future advancements in Python binary distribution.

Highlights

  • New Zipapp Rules Introduced: Dedicated py_zipapp_binary and py_zipapp_test rules have been added to replace the existing zipapp logic within py_binary and py_test. These new rules offer enhanced functionality and improved build performance.
  • Improved Zipapp Features: The new zipapp rules provide explicit control over compression levels, optimize re-unzipping by checking the zip's hash, ensure more deterministic zip output, and support various symlink types (runfiles.symlinks, runfiles.root_symlinks, and raw symlinks). They also support zipping venv-based binaries.
  • Output and Executability: Generated zipapps now have a .pyz extension, and their executability is controlled via a dedicated attribute rather than a flag, offering more granular control.
  • Refactored Internal Logic: Significant internal refactoring has occurred, including the introduction of maybe_create_repo_mapping and actions_run functions in common.bzl, and a more detailed PyExecutableInfo provider to support the new zipapp structure and its various components like app_runfiles and stage2_bootstrap.
  • New Tools and Templates: New Python scripts (zipper.py, exe_zip_maker.py) and shell/Python templates (zip_shell_template.sh, zipapp_stage2_bootstrap_template.py) have been added to facilitate the creation and execution of these advanced zipapps.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a significant new feature: dedicated rules for creating Python zipapps (py_zipapp_binary and py_zipapp_test). This is a substantial refactoring that moves zipapp creation logic out of the generic py_binary rule, improving modularity and adding features like explicit compression control and enhanced determinism. The changes are extensive, touching many parts of the Python rules, including common utilities, executable creation, and providers. The new tooling for zipping and creating executables is well-designed and thoroughly tested.

Overall, the implementation is of high quality. However, I've identified a couple of critical issues in the new macros that would lead to build failures due to missing imports. I've also found a logic bug in a shell script template that affects a debugging feature. I've provided suggestions to fix these issues. The rest of the changes, including the refactoring of runfiles handling and the new actions_run helper, are excellent improvements.

@@ -0,0 +1,14 @@
"""`py_zipapp_binary` macro."""

load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_binary_rule = "py_zipapp_binary")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The function add_tag is called on line 11 but is not defined or loaded in this file. This will cause a build failure. It should be loaded from //python/private:util.bzl.

Suggested change
load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_binary_rule = "py_zipapp_binary")
load("//python/private:util.bzl", "add_tag")
load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_binary_rule = "py_zipapp_binary")

@@ -0,0 +1,14 @@
"""`py_zipapp_test` macro."""

load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_test = "py_zipapp_test")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The function add_tag is called on line 11 but is not defined or loaded in this file. This will cause a build failure. It should be loaded from //python/private:util.bzl.

Suggested change
load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_test = "py_zipapp_test")
load("//python/private:util.bzl", "add_tag")
load("//python/private/zipapp:py_zipapp_rule.bzl", _py_zipapp_test = "py_zipapp_test")

Comment on lines +51 to +54
if [[ -n "$zip_dir" && -z "${RULES_PYTHON_BOOTSTRAP_VERBOSE:-}" ]]; then
trap 'rm -fr "$zip_dir"' EXIT
fi
trap 'rm -rf "$zip_dir"' EXIT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The trap logic for cleaning up the temporary directory appears to be incorrect. The unconditional trap on line 54 overrides the conditional one on line 52. This results in the temporary directory always being removed, even when RULES_PYTHON_BOOTSTRAP_VERBOSE is set for debugging purposes. The likely intention is to preserve the directory for inspection in verbose mode.

The logic should be consolidated into a single conditional trap.

Suggested change
if [[ -n "$zip_dir" && -z "${RULES_PYTHON_BOOTSTRAP_VERBOSE:-}" ]]; then
trap 'rm -fr "$zip_dir"' EXIT
fi
trap 'rm -rf "$zip_dir"' EXIT
if [[ -n "$zip_dir" && -z "${RULES_PYTHON_BOOTSTRAP_VERBOSE:-}" ]]; then
trap 'rm -rf "$zip_dir"' EXIT
fi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant