Skip to content

refactor(pypi): factor out a simple implementation of the PyPI cache#3639

Merged
aignas merged 2 commits intobazel-contrib:mainfrom
aignas:aignas.refactor.add_cache_instance
Feb 27, 2026
Merged

refactor(pypi): factor out a simple implementation of the PyPI cache#3639
aignas merged 2 commits intobazel-contrib:mainfrom
aignas:aignas.refactor.add_cache_instance

Conversation

@aignas
Copy link
Collaborator

@aignas aignas commented Feb 27, 2026

We want to keep a dict like interface and later we would like to use
the same interface to also do more things. I expect the cache key to
become different in the future (i.e. include requested versions in it)
so that we can check if we have the right versions in the
MODULE.bazel.lock file or if we should actually call to PyPI.

Work towards #2731

We want to keep a `dict` like interface and later we would like to use
the same interface to also do more things. I expect the cache key to
become different in the future (i.e. include requested versions in it)
so that we can check if we have the right versions in the
MODULE.bazel.lock file or if we should actually call to PyPI.

Work towards bazel-contrib#2731
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 refactors the PyPI index content caching mechanism by extracting the caching logic into a dedicated pypi_cache.bzl module. This change replaces the previous dictionary-based cache with a more structured and extensible implementation, preparing for future enhancements like incorporating version information into cache keys and storing results in MODULE.bazel.lock. The refactoring aims to prevent redundant PyPI calls and improve cache management.

Highlights

  • Introduced a dedicated PyPI cache module: A new pypi_cache.bzl file was added to encapsulate the logic for caching PyPI index query results, providing get and setdefault methods.
  • Refactored simpleapi_cache initialization: The simpleapi_cache in extension.bzl now uses the pypi_cache() constructor instead of a simple dictionary, leveraging the new structured caching mechanism.
  • Updated cache usage in simpleapi_download: The simpleapi_download.bzl module was modified to interact with the new pypi_cache interface, specifically using its get method for retrieving cached results.
  • Enhanced cache documentation: The documentation for the cache parameter in simpleapi_download.bzl was updated to reflect the new opaque object implementation and its benefits.

🧠 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/pypi/BUILD.bazel
    • Added pypi_cache_bzl to the bzl_library dependencies.
  • python/private/pypi/extension.bzl
    • Imported the new pypi_cache module.
    • Initialized simpleapi_cache using the pypi_cache() function.
  • python/private/pypi/pypi_cache.bzl
    • Added a new file defining the pypi_cache function, which provides setdefault and get methods for managing an in-memory store.
  • python/private/pypi/simpleapi_download.bzl
    • Updated the documentation for the cache parameter to describe the new opaque pypi_cache object.
    • Modified the cache lookup logic to use cache.get() instead of direct dictionary access.
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 refactors the PyPI cache from a simple dictionary to a more structured object, which is a good step towards better encapsulation and future enhancements. The implementation is sound, but I have one suggestion to further improve the new cache implementation by using a more idiomatic Starlark pattern for creating objects with state.

Copy link
Collaborator

@rickeylev rickeylev left a comment

Choose a reason for hiding this comment

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

This change looks too simple?

The cache is changing from a dict to custom object. How is this working? Ah, is it because it just happens that only e.g. get() and setdefault() are used, not [] ?

def pypi_cache():
"""The cache for PyPI index queries."""
self = struct(
store = {},
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this be _store to indicate its internal, and that the setdefault/get methods re supposed to be used?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

OK, will do that.

@aignas
Copy link
Collaborator Author

aignas commented Feb 27, 2026

Yeah, I wanted to first create a seam and change the usage to not assume a dict.

Later this will grow more meat.

@aignas aignas added this pull request to the merge queue Feb 27, 2026
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Feb 27, 2026
@aignas aignas added this pull request to the merge queue Feb 27, 2026
Merged via the queue into bazel-contrib:main with commit bc64f06 Feb 27, 2026
4 checks passed
@aignas aignas deleted the aignas.refactor.add_cache_instance branch February 27, 2026 10:12
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.

2 participants