Skip to content

fix: make imports attribute target-relative for venv mode#3572

Open
rickeylev wants to merge 7 commits intobazel-contrib:mainfrom
rickeylev:fix.venv.imports.attr
Open

fix: make imports attribute target-relative for venv mode#3572
rickeylev wants to merge 7 commits intobazel-contrib:mainfrom
rickeylev:fix.venv.imports.attr

Conversation

@rickeylev
Copy link
Collaborator

The imports attribute is treated as target-relative in non-venv mode, but venv-mode
was passing the value through without the target-relative processing. This went unnoticed
because the main use case, pypi packages, are a the repo root, so target and repo
relative paths are the same.

To fix, use join the input value to the target's path, as done in the non-venv
get_imports() function.

Fixes #3571

@rickeylev rickeylev requested a review from aignas as a code owner February 7, 2026 03:07
@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 addresses a critical bug in the handling of the imports attribute when using virtual environments. Previously, this attribute was not correctly interpreted as target-relative, causing path discrepancies. The changes align the venv mode's imports processing with the non-venv mode, ensuring consistent and accurate resolution of import paths within Bazel's Python rules and fixing the reported issue.

Highlights

  • Imports Attribute Fix: Corrected an issue where the imports attribute in venv mode was not treated as target-relative, leading to incorrect path resolution, especially for packages not at the repository root.
  • Path Calculation Alignment: Ensured that the imports attribute in venv mode now correctly joins the input value with the target's path, mirroring the behavior in non-venv mode for consistent path resolution.
  • New Module Import: Introduced an import for py_internal.bzl in py_library.bzl to facilitate the new target-relative path calculation logic.

🧠 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.

Changelog
  • python/private/py_library.bzl
    • Added load(":py_internal.bzl", "py_internal") to import the py_internal module.
    • Modified the _get_imports_and_venv_symlinks function to calculate site_packages_root by joining py_internal.get_label_repo_runfiles_path(ctx.label) with the imports[0] value, ensuring target-relative path resolution.
  • python/private/venv_runfiles.bzl
    • Updated the docstring for the site_packages_root parameter in _get_file_venv_path to explicitly state it is a "repo-relative path".
Activity
  • No human activity has been recorded on this pull request yet.
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

The pull request aims to correctly handle the imports attribute as target-relative when venvs_site_packages is enabled, aligning its behavior with non-venv mode. However, the newly computed site_packages_root is not passed to the get_venv_symlinks function, effectively negating the intended fix. This incomplete implementation introduces a security risk by lacking path traversal protections, which could allow for the injection of arbitrary directories into the PYTHONPATH. A positive change is the documentation update in venv_runfiles.bzl clarifying the site_packages_root parameter.

@rickeylev rickeylev enabled auto-merge February 7, 2026 04:01
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