feat(uv): support WORKSPACE builds in the lock() macro (#4360) This makes the uv `lock()` rule work in workspace mode. Since we'll be supporting Bazel 8 for another year, and I'd really like to get rid of the remaining requirements.txt and compile_pip_requirements calls, I figured we should just implement workspace support for it. This is a fairly low-effort conversion of the bzlmod APIs to workspace mode. Fundamentally, the bzlmod API works by obtaining one or more manifests, then using the manifest information to define repos with the uv binaries. Then the names of all those repos are fed into the toolchain hub where the `toolchain()` registrations are. The workspace API more-or-less exposes that same API. The `uv_toolchain_manifest()` function is the equivalent of the first half of the bzlmod phase. All it does is download the manifests so they can be read by subsequent workspace macros and repos. Like the bzlmod API, a manifest per uv version can be registered. The `uv_register_toolchains()` function is the equivalent of the second half of the bzlmod phase. It takes what's in the manifest and defines repos pointing to a particular URL. Like the bzlmod API, it accepts args to customize processing. This function also keeps track of all the created toolchain implementations and creates the toolchain hub with all the `toolchain()` registrations. The args to the functions mirror the bzlmod API, which is basically a list of key-values. Hence the `uv_register_toolchains.configure` arg accepts a list of dicts, where the keys are the same as the attributes of the `uv.configure` tag class. This makes for a somewhat awkward API, but it matches the bzlmod API and makes it easier to integrate into the underlying code. Tested on Bazel 7.x and 8.x in WORKSPACE mode, and on Bazel 7.x, 8.x and 9.x in bzlmod mode (Bazel 9 no longer evaluates WORKSPACE). Work towards #1975
This repository is the home of the core Python rules -- py_library, py_binary, py_test, and related symbols that provide the basis for Python support in Bazel. It also contains package installation rules for integrating with PyPI and other indices.
Documentation for rules_python is at https://rules-python.readthedocs.io and in the Bazel Build Encyclopedia.
Examples live in the examples directory.
The core rules are stable. Their implementation is subject to Bazel's backward compatibility policy. This repository aims to follow semantic versioning.
The Bazel community maintains this repository. Neither Google nor the Bazel team provides support for the code. However, this repository is part of the test suite used to vet new Bazel releases. See How to contribute page for information on our development workflow.
requirements.txt is how users have been defining dependencies for a long time. We support this to support legacy usecases or package managers that we don't support directly. Any additional information that we need will be retrieved from the SimpleAPI during the bzlmod extension evaluation phase. Then it will be written to the MODULE.bazel.lock file for future reuse. We have plans to support uv.lock file directly. uv is recommended for generating a fully locked requirements.txt file and we do provide a rule for it.py_binary, py_test rules should scale to large monorepos and we work hard to minimize the work done during analysis and build phase. What is more, the space requirements for should be minimal, so we strive to use symlinks rather than extracting wheels at build time. This means that for different configurations of the same build, we are not extracting the wheel multiple times thus scaling better over the time. From 2.0 onwards we are creating a virtual env for each target by creating an actual minimal virtual environment using symlinks. We plan on creating the traditional site-packages layout in the future by default.rules_python and this has resulted in a few PEPs supported within pure starlark - PEP440, PEP509.Common misconceptions:
rules_python has to keep backwards compatibility with google3. Whilst this might have been true in the past, rules_python is an open source project and any compatibility needs should come from the community - we have no requirement to keep this compatibility and are allowed to make our decisions. However, we do want to keep backwards compatibility as long as possible to not upset users with never ending migrations.rules_python is not caching pip downloads. With 2.0, we use Bazel's downloader by default and rely on bazel to provide the repository caching mechanisms. This means that for simpler setups this should result in transparent and scalable caching with the most recent bazel versions unless there are issues in the bazel itself.For detailed documentation, see https://rules-python.readthedocs.io
See Bzlmod support for more details.