Skip to content

fix: add runfiles root for system_python bootstrap #3423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix: add runfiles root for system_python bootstrap #3423

wants to merge 3 commits into from
+55 −7

Conversation

@rickeylev
Copy link
Collaborator

@rickeylev rickeylev commented Nov 22, 2025 •
edited
Loading

When the system_bootstrap code was changed to using the site init for adding to sys.path,
importing bazel_tools.tools.python.runfiles stopped working. This is because the
runfiles root was no longer being added to sys.path.

This is somewhat WAI because:

  1. Always adding the runfiles root to sys.path is a deprecated legacy behavior because
    it can interfere with Python imports (a repo name can mask a legitimate import).
  2. Under bzlmod, repo directory names aren't importable Python names, so having the
    runfiles root on sys.path doesn't do much.

An exception to (2) is bazel_tools: this is special cased to use the directory
name bazel_tools in runfiles. This is where the legacy runfiles library for
Python is.

In any case, forgetting the runfiles root on sys.path for the system_python bootstrap
was an oversight, as the intention was to be a more no-op refactoring.

Fixes #3422

@rickeylev rickeylev requested a review from aignas as a code owner November 22, 2025 01:59
@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Nov 22, 2025

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 resolves an issue where Python executables using the system_python bootstrap could no longer import modules from bazel_tools.tools.python.runfiles. The fix involves explicitly re-adding the runfiles root to the Python sys.path during the bootstrap process, but only for system_python implementations, to ensure bazel_tools modules are discoverable. A new test has been introduced to validate this critical import functionality.

Highlights

  • Restored bazel_tools importability: The primary change re-enables the import of bazel_tools.tools.python.runfiles for system_python bootstraps, which was broken after a previous refactoring.
  • Conditional sys.path modification: The runfiles root is now conditionally added to sys.path only when system_python bootstrap is used, addressing a specific need without reverting to a deprecated global behavior.
  • New test for bazel_tools imports: A dedicated test case, bazel_tools_importable_system_python_test, has been added to ensure the correct import behavior of bazel_tools modules under the system_python bootstrap.
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. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Nov 22, 2025
View reviewed changes
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 addresses an issue where bazel_tools.tools.python.runfiles could not be imported when using the system_python bootstrap implementation, due to the runfiles root not being on sys.path. The fix correctly adds the runfiles root to sys.path conditionally for this bootstrap method. The changes are logical and include a new test to verify the fix. My feedback focuses on improving code clarity and maintainability in the new test file and a related template file.

@rickeylev rickeylev force-pushed the allow.bazel.tools.import branch from f20f1bb to 447eb15 Compare November 22, 2025 02:04
@rickeylev rickeylev mentioned this pull request Nov 22, 2025
Open
rickeylev and others added 2 commits November 21, 2025 18:50
@rickeylev
update doc
4e50366
@rickeylev @gemini-code-assist
Update tests/bootstrap_impls/bazel_tools_importable_test.py
ddfa322 
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aignas aignas aignas approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

bazel_tools import issues with python_rule version 1.7.0-rc4

2 participants

@rickeylev @aignas