Skip to content

feat(pypi): support importing uv.lock file#3785

Draft
aignas wants to merge 33 commits into
bazel-contrib:mainfrom
aignas:aignas.feat.uv-lock
Draft

feat(pypi): support importing uv.lock file#3785
aignas wants to merge 33 commits into
bazel-contrib:mainfrom
aignas:aignas.feat.uv-lock

Conversation

@aignas

@aignas aignas commented May 16, 2026

Copy link
Copy Markdown
Collaborator

Part of this is vibe coded, but I thought that the approach might have been rigorous
enough to submit a PR.

The strategy was:

  • First add a way for us to create a uv.lock file from the lock rule.
  • Then add a uv.lock file to JSON converter.
  • Then add a way to read the uv.lock file together with the requirements file
    and verify things are OK.
  • Reuse most of the code.

Extra things that we could do:

  • Full test suite for various uv.lock scenarios and ensure parity with
    requirements.txt files.
  • Call the PyPI index to understand if the packages are yanked or not - lock
    file does not have that information.
  • Read the pyproject.toml file to get the index values for each package.

Summary:

  • feat(pypi): add uv.lock parsing support to parse_requirements
  • test(pypi): add tests for uv.lock parsing in parse_requirements
  • test(uv): add lock rule integration tests for uv.lock format
  • test: add uv_pypi end-to-end integration test
  • docs: add uv.lock documentation and sample files

Closes #3557
Work towards #2787

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

Copy link
Copy Markdown
Contributor

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 adds support for uv.lock files in rules_python, introducing a toml2json conversion utility and updating the lock rule and requirement parsing logic. The review identifies critical compatibility issues, specifically the toml2json tool's reliance on Python 3.11's tomllib and missing serialization for date/time objects. Furthermore, the feedback highlights logic errors in how package extras are handled—which could lead to dependency bloat or failed consistency checks—and suggests improvements for platform resolution and path handling in shell scripts.

"""Parse requirements using uv.lock as the primary source."""
ret = _parse_uv_lock_json(
uv_lock_json = uv_lock_json,
all_platforms = _get_all_platforms(requirements_by_platform) if requirements_by_platform else [],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

If requirements_by_platform is empty (which is common when using uv.lock as the primary source), all_platforms will be an empty list. This results in all packages having empty target_platforms, which will likely cause issues in downstream rules that expect platform information for wheel selection.

Suggested change
all_platforms = _get_all_platforms(requirements_by_platform) if requirements_by_platform else [],
all_platforms = _get_all_platforms(requirements_by_platform) if requirements_by_platform else sorted(platforms.keys()),

Comment on lines +192 to +194
for extra in pkg.get("provides-extras", pkg.get("extras", [])):
if extra not in entry["extras"]:
entry["extras"][extra] = None

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

Including all provides-extras in the requirement line for every package is likely incorrect. provides-extras lists all extras a package defines, not necessarily what was resolved or requested. Including all of them will force the installation of all optional dependencies for every package in the lock file, leading to significant dependency bloat. It might be better to omit extras from the requirement line if the lock file already provides the specific version and URL, or only include the extras that were part of the resolution.

Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread tools/toml2json/toml2json.py Outdated
Comment thread python/uv/private/lock.bzl Outdated
Comment thread tools/toml2json/toml2json.py Outdated
aignas added 2 commits May 17, 2026 02:18
- tomllib: try/except fallback to tomli for Python <3.11
- json_serializer: add datetime.date and datetime.time support
- all_platforms: use sorted(platforms.keys()) fallback
- $PWD/ path: check if python_path is absolute
- extra_pip_args: pass through to _parse_uv_lock_json
- Add uv_lock tests: multiple packages, extra_pip_args, multi-os
- Update plan.md with review cycle instructions
@aignas

aignas commented May 16, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed all review comments. Please re-review when you get a chance. @gemini-code-assist

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

Copy link
Copy Markdown
Contributor

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 support for uv.lock files in rules_python, adding a new lock_format attribute to the lock rule and a toml2json utility for parsing. It also implements a consistency check between uv.lock and requirements files. The reviewer identified a potential runtime error in the uv.lock parser due to unsafe dictionary access for optional hash keys and suggested simplifying redundant logic during hash extraction.

Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread python/private/pypi/parse_requirements.bzl Outdated
aignas added 3 commits May 17, 2026 03:38
- Add python_3_14 toolchain in MODULE.bazel
- Always use Python 3.14 interpreter for uv.lock JSON conversion
- Remove tomli fallback from toml2json.py (Python 3.14 has tomllib)
- Simplify convert_uv_lock_to_json to use fixed interpreter
- Add bazel-in-bazel integration test under tests/integration/uv_lock/
- Test converts uv.lock TOML to JSON using toml2json tool
- Remove dead uv_pypi test data (placeholder only)
- Restore tomli fallback in toml2json.py for backward compatibility
@aignas

aignas commented May 16, 2026

Copy link
Copy Markdown
Collaborator Author

Addressed all review comments and added Python 3.14 toolchain + integration test. Please re-review. @gemini-code-assist

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

Copy link
Copy Markdown
Contributor

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 support for uv.lock files as a primary metadata source in rules_python. Key additions include a toml2json tool for parsing, a new uv_lock format for the lock rule, and consistency checks within parse_requirements. Reviewer feedback suggests adopting more idiomatic Starlark dictionary access, implementing safer hash prefix stripping, and improving the portability of shell commands by replacing hardcoded environment variables with Bazel-provided paths.

Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread python/private/pypi/parse_requirements.bzl Outdated
Comment thread python/uv/private/lock.bzl Outdated
@jvolkman

Copy link
Copy Markdown
Contributor

The latest release of toml.bzl makes bazel_lib a dev dependency. It now uses skylib for the bzl_library rules.

aignas added 2 commits May 18, 2026 22:11
Remove the old toml2json Python tool and uv_lock.bzl in favor of the
pure Starlark toml.bzl decoder. Update tests to pass toml_decode mock,
remove is_rules_python_root references, and fix virtual package test
expectations. Clean up BUILD.bazel files that referenced deleted targets.
Comment thread python/private/pypi/extension.bzl
),
logger = logger,
),
uv_lock = pip_attr.uv_lock,

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Add a test to ensure this is tested.

Comment thread MODULE.bazel Outdated
Comment thread MODULE.bazel Outdated
aignas added 5 commits May 19, 2026 20:51
… lock support

Remove the lock_format attribute and detect whether to use uv lock or
uv pip compile from the output file extension (.lock = uv lock, else
requirements). Add a Windows bat template for uv lock support. The
python interpreter is passed through --python flag consistently.

@rickeylev rickeylev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Overall LGTM. Some minor questions and nits. But overall, this fit in rather nicely with the pipstar code you've written, nice!

Comment thread python/uv/private/lock.bzl
Comment thread python/uv/private/lock.bzl Outdated
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/pypi/parse_requirements.bzl
Comment thread python/private/py_repositories.bzl
@rickeylev

rickeylev commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

(agent comment) Addressed the second review cycle comments (enforcing uv.lock suffix, renaming _template attribute, restoring requirement parsing comments, and registering missing Stardoc TOML dependencies). Please re-review @gemini-code-assist @rickeylev

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

Copy link
Copy Markdown
Contributor

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 implements support for uv.lock files in rules_python, allowing them to be used as the primary source for package metadata and introducing a rule to generate them. The feedback identifies several issues: a potential path resolution failure in lock.bzl when the Python interpreter path is absolute, an undefined repository error caused by exposing virtual packages with no sources in the hub, and a version mismatch for the toml.bzl dependency between MODULE.bazel and py_repositories.bzl.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread python/uv/private/lock.bzl Outdated
Comment on lines +206 to +215
item = struct(
name = norm_name,
is_exposed = True,
is_multiple_versions = len(versions) > 1,
# TODO @aignas 2026-05-17: use the default index that is used in parsing the
# requirements if it is not known in the uv.lock file. We need to get this from the
# pyproject.toml file uv.tool configuration.
index_url = "",
srcs = pkg_srcs,
)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Setting is_exposed = True for virtual packages (which have no sources, i.e., srcs = []) causes the hub repository to expose them as targets. However, since they have no sources, no corresponding whl_library repository is created for them. This leads to undefined repository errors (e.g., @hub_virtual_pkg not found) when Bazel attempts to resolve or query the hub's targets. We should set is_exposed to len(pkg_srcs) > 0 so that virtual packages without sources are not exposed in the hub.

Suggested change
item = struct(
name = norm_name,
is_exposed = True,
is_multiple_versions = len(versions) > 1,
# TODO @aignas 2026-05-17: use the default index that is used in parsing the
# requirements if it is not known in the uv.lock file. We need to get this from the
# pyproject.toml file uv.tool configuration.
index_url = "",
srcs = pkg_srcs,
)
item = struct(
name = norm_name,
is_exposed = len(pkg_srcs) > 0,
is_multiple_versions = len(versions) > 1,
# TODO @aignas 2026-05-17: use the default index that is used in parsing the
# requirements if it is not known in the uv.lock file. We need to get this from the
# pyproject.toml file uv.tool configuration.
index_url = "",
srcs = pkg_srcs,
)

Comment on lines +1199 to +1205
struct(
name = "virtual_pkg",
index_url = "",
is_exposed = True,
is_multiple_versions = False,
srcs = [],
),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Update the unit test expectation to match the corrected is_exposed behavior for virtual packages (which should be False since they have no sources).

Suggested change
struct(
name = "virtual_pkg",
index_url = "",
is_exposed = True,
is_multiple_versions = False,
srcs = [],
),
struct(
name = "virtual_pkg",
index_url = "",
is_exposed = False,
is_multiple_versions = False,
srcs = [],
)

Comment thread python/private/py_repositories.bzl
@rickeylev

Copy link
Copy Markdown
Collaborator

Addressed the remaining unresolved review threads (adopting str.removeprefix(), syncing toml.bzl to 0.4.1 in py_repositories.bzl, adding absolute path check in lock.bzl, formatting uv_lock docstrings with VERSION_NEXT_FEATURE, and removing temporary Python 3.14 toolchains). Please re-review @gemini-code-assist @rickeylev

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

Copy link
Copy Markdown
Contributor

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 support for using uv.lock files as the primary source of package metadata in rules_python. It integrates a pure Starlark TOML decoder to parse uv.lock and extract packages, versions, extras, and sources (wheels, sdists, VCS, and direct URLs). Additionally, it updates the lock rule to support generating uv.lock files and adds comprehensive unit tests. The code review identified critical issues where the shell and batch scripts fail when copying uv.lock onto itself, a correctness bug where assigning all platforms to multiple versions of a package causes repository conflicts during hub building, and an issue where git revisions are not appended to VCS URLs, leading to unpinned dependencies.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread python/uv/private/lock_uv_lock.sh Outdated
Comment thread python/uv/private/template/uv_lock.bat Outdated
distribution = info["distribution"],
extra_pip_args = extra_pip_args or [],
requirement_line = requirement_line,
target_platforms = list(all_platforms),

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

Setting target_platforms = list(all_platforms) for all package versions in _parse_uv_lock introduces a correctness bug when a package has multiple versions in uv.lock (e.g., due to different Python versions or environment markers).

Because all versions of the package are assigned the exact same target_platforms, they will all generate the same config settings in _add_whl_library. This causes a conflict during the hub building phase, resulting in a build failure: attempting to override an existing repo '...' for config setting '...' with a new repo '...'.

To fix this, we should parse and evaluate the resolution-markers (or package-level markers) for each package version against the configured platforms to determine the correct subset of target_platforms for each version. If no markers are present, we can default to all_platforms.

Comment thread python/private/pypi/parse_requirements.bzl

@rickeylev rickeylev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Fixed a variety of comments

Comment thread python/private/py_repositories.bzl
Comment thread python/uv/private/lock.bzl Outdated
Comment thread python/private/pypi/extension.bzl
Comment thread python/private/pypi/parse_requirements.bzl
@rickeylev rickeylev force-pushed the aignas.feat.uv-lock branch 2 times, most recently from 7c98eb2 to 67c6b23 Compare June 8, 2026 07:45
@rickeylev rickeylev marked this pull request as ready for review June 9, 2026 06:48
@rickeylev

Copy link
Copy Markdown
Collaborator

@aignas PTAL -- CI is happy! But the unresolved comments from Gemini I think might be valid?

@aignas aignas force-pushed the aignas.feat.uv-lock branch from a19879b to fad0083 Compare June 20, 2026 04:05
aignas added 2 commits June 20, 2026 13:13
- Fix the condition in lock() macro to match '.lock' suffix instead of
  'uv.lock', so that uv.lock format files with custom names are handled
  correctly.
- Add missing load for native_test in lock_tests.bzl
- Rename uv_lock_expected.txt to uv_lock_expected.lock to match the
  output filename used by the uv_lock_test test.
@aignas

aignas commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator Author

test this please

@aignas aignas marked this pull request as draft June 20, 2026 09:12
@aignas

aignas commented Jun 20, 2026

Copy link
Copy Markdown
Collaborator Author

It seems that the extras are defined in a different way than requirements.txt files and it means that we should handle it slightly differently from what we have today. The good news is that it will benefit us in many other ways, but the drawback is that it makes the uv.lock implementation a little bit more work.

The gist is that each package in the lock file has its dependencies encoded per extra. The good news is that we can just feed this dependency tree to the hub repo, then do the cycles resolution and then we don't need the requirements_cycles definition. #1975 had code how we could deal with this sort of stuff.

Since the dep graph is coming from uv.lock itself, we have the following options:

  • Generate the requirements lines based on what extras we are using in the uv.lock. This would allow us to easily plug into what we already have. However, implementing that is almost the same as export a uv.lock file to requirements.txt file. Which I assume may have some challenges. We could just invoke the uv in the repo phase to do this.
  • Generate one whl_library per Python dependency. Then we would need to do some smart stuff in order to handle cycles in the hub repository, but the main idea would be to actually have the dependency graph in the hub repository so that we can correctly select the minimum set of whl_library targets that have to be present here.

We could already do this if we read the whl_metadata from the SimpleAPI and pulled the RequirementsDist values for each package. That way we would not need to depend on the uv.lock format (which could change many times in the future). That would also mean that we could work the same way if py.lock file was used with pip.parse.

So this uv.lock file consumption only works if we:

  • Don't have extras usage in the lock file
  • convert the uv.lock file into requirements.txt in starlark or execute uv itself.

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.

3 participants