refactor(uv): move around uv implementation files (#2580)
This PR starts establishing a structure that will eventually become a
part of our API. This is a prerequisite for #2578 which removes the
versions.bzl file in favour of a more dynamic configuration of the
extension. We also remove the `defs.bzl` to establish a one symbol per
file convention.
Things that I wish we could change is `//python/uv:extensions.bzl` and
the fact that we have `extensions` in the load path. I think it cannot
be removed, because that may break the BCR test. On the other hand,
maybe we could remove it and do an alpha release to verify this
assumption.
Work towards #1975
diff --git a/python/uv/BUILD.bazel b/python/uv/BUILD.bazel
index 383bdfc..7ce6ce0 100644
--- a/python/uv/BUILD.bazel
+++ b/python/uv/BUILD.bazel
@@ -27,9 +27,6 @@
visibility = ["//:__subpackages__"],
)
-# For stardoc to reference the files
-exports_files(["defs.bzl"])
-
toolchain_type(
name = "uv_toolchain_type",
visibility = ["//visibility:public"],
@@ -48,34 +45,33 @@
)
bzl_library(
- name = "defs",
- srcs = ["defs.bzl"],
+ name = "lock_bzl",
+ srcs = ["lock.bzl"],
# EXPERIMENTAL: Visibility is restricted to allow for changes.
visibility = ["//:__subpackages__"],
+ deps = ["//python/uv/private:lock_bzl"],
)
bzl_library(
- name = "extensions",
- srcs = ["extensions.bzl"],
+ name = "uv_bzl",
+ srcs = ["uv.bzl"],
# EXPERIMENTAL: Visibility is restricted to allow for changes.
visibility = ["//:__subpackages__"],
- deps = [":repositories"],
+ deps = ["//python/uv/private:uv_bzl"],
)
bzl_library(
- name = "repositories",
- srcs = ["repositories.bzl"],
+ name = "uv_toolchain_bzl",
+ srcs = ["uv_toolchain.bzl"],
# EXPERIMENTAL: Visibility is restricted to allow for changes.
visibility = ["//:__subpackages__"],
- deps = [
- "//python/uv/private:toolchains_repo",
- "//python/uv/private:versions",
- ],
+ deps = ["//python/uv/private:uv_toolchain_bzl"],
)
bzl_library(
- name = "toolchain",
- srcs = ["toolchain.bzl"],
+ name = "uv_toolchain_info_bzl",
+ srcs = ["uv_toolchain_info.bzl"],
# EXPERIMENTAL: Visibility is restricted to allow for changes.
visibility = ["//:__subpackages__"],
+ deps = ["//python/uv/private:uv_toolchain_info_bzl"],
)
diff --git a/python/uv/defs.bzl b/python/uv/lock.bzl
similarity index 76%
copy from python/uv/defs.bzl
copy to python/uv/lock.bzl
index 20b426a..edffe47 100644
--- a/python/uv/defs.bzl
+++ b/python/uv/lock.bzl
@@ -1,4 +1,4 @@
-# Copyright 2024 The Bazel Authors. All rights reserved.
+# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -12,12 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""
+"""The `uv` locking rule.
+
EXPERIMENTAL: This is experimental and may be removed without notice
-
-A toolchain for uv
"""
-load("//python/uv/private:providers.bzl", _UvToolchainInfo = "UvToolchainInfo")
+load("//python/uv/private:lock.bzl", _lock = "lock")
-UvToolchainInfo = _UvToolchainInfo
+lock = _lock
diff --git a/python/uv/private/BUILD.bazel b/python/uv/private/BUILD.bazel
index 80fd239..006c856 100644
--- a/python/uv/private/BUILD.bazel
+++ b/python/uv/private/BUILD.bazel
@@ -21,20 +21,62 @@
)
bzl_library(
- name = "current_toolchain",
+ name = "current_toolchain_bzl",
srcs = ["current_toolchain.bzl"],
visibility = ["//python/uv:__subpackages__"],
)
bzl_library(
- name = "toolchain_types",
+ name = "lock_bzl",
+ srcs = ["lock.bzl"],
+ visibility = ["//python/uv:__subpackages__"],
+ deps = [
+ "//python:py_binary_bzl",
+ "//python/private:bzlmod_enabled_bzl",
+ "@bazel_skylib//rules:write_file",
+ ],
+)
+
+bzl_library(
+ name = "toolchain_types_bzl",
srcs = ["toolchain_types.bzl"],
visibility = ["//python/uv:__subpackages__"],
)
bzl_library(
- name = "toolchains_repo",
- srcs = ["toolchains_repo.bzl"],
+ name = "uv_bzl",
+ srcs = ["uv.bzl"],
+ visibility = ["//python/uv:__subpackages__"],
+ deps = [":uv_repositories_bzl"],
+)
+
+bzl_library(
+ name = "uv_repositories_bzl",
+ srcs = ["uv_repositories.bzl"],
+ visibility = ["//python/uv:__subpackages__"],
+ deps = [
+ ":toolchain_types_bzl",
+ ":uv_toolchains_repo_bzl",
+ ":versions_bzl",
+ ],
+)
+
+bzl_library(
+ name = "uv_toolchain_bzl",
+ srcs = ["uv_toolchain.bzl"],
+ visibility = ["//python/uv:__subpackages__"],
+ deps = [":uv_toolchain_info_bzl"],
+)
+
+bzl_library(
+ name = "uv_toolchain_info_bzl",
+ srcs = ["uv_toolchain_info.bzl"],
+ visibility = ["//python/uv:__subpackages__"],
+)
+
+bzl_library(
+ name = "uv_toolchains_repo_bzl",
+ srcs = ["uv_toolchains_repo.bzl"],
visibility = ["//python/uv:__subpackages__"],
deps = [
"//python/private:text_util_bzl",
@@ -42,7 +84,7 @@
)
bzl_library(
- name = "versions",
+ name = "versions_bzl",
srcs = ["versions.bzl"],
visibility = ["//python/uv:__subpackages__"],
)
diff --git a/python/uv/private/lock.bzl b/python/uv/private/lock.bzl
index f4dfa36..e0491b2 100644
--- a/python/uv/private/lock.bzl
+++ b/python/uv/private/lock.bzl
@@ -26,9 +26,14 @@
"//conditions:default": [],
}) if BZLMOD_ENABLED else ["@platforms//:incompatible"]
-def lock(*, name, srcs, out, upgrade = False, universal = True, python_version = None, args = [], **kwargs):
+def lock(*, name, srcs, out, upgrade = False, universal = True, args = [], **kwargs):
"""Pin the requirements based on the src files.
+ Differences with the current {obj}`compile_pip_requirements` rule:
+ - This is implemented in shell and uv.
+ - This does not error out if the output file does not exist yet.
+ - Supports transitions out of the box.
+
Args:
name: The name of the target to run for updating the requirements.
srcs: The srcs to use as inputs.
@@ -36,15 +41,8 @@
upgrade: Tell `uv` to always upgrade the dependencies instead of
keeping them as they are.
universal: Tell `uv` to generate a universal lock file.
- python_version: Tell `rules_python` to use a particular version.
- Defaults to the default py toolchain.
- args: Extra args to pass to the rule.
- **kwargs: Extra kwargs passed to the binary rule.
-
- Differences with the current pip-compile rule:
- - This is implemented in shell and uv.
- - This does not error out if the output file does not exist yet.
- - Supports transitions out of the box.
+ args: Extra args to pass to `uv`.
+ **kwargs: Extra kwargs passed to the {obj}`py_binary` rule.
"""
pkg = native.package_name()
update_target = name + ".update"
@@ -92,10 +90,6 @@
Label("//python:current_py_toolchain"),
],
)
- if python_version:
- py_binary_rule = lambda *args, **kwargs: py_binary(python_version = python_version, *args, **kwargs)
- else:
- py_binary_rule = py_binary
# Write a script that can be used for updating the in-tree version of the
# requirements file
@@ -116,7 +110,7 @@
],
)
- py_binary_rule(
+ py_binary(
name = update_target,
srcs = [update_target + ".py"],
main = update_target + ".py",
diff --git a/python/uv/extensions.bzl b/python/uv/private/uv.bzl
similarity index 84%
rename from python/uv/extensions.bzl
rename to python/uv/private/uv.bzl
index 82560eb..886e7fe 100644
--- a/python/uv/extensions.bzl
+++ b/python/uv/private/uv.bzl
@@ -18,15 +18,18 @@
A module extension for working with uv.
"""
-load("//python/uv:repositories.bzl", "uv_register_toolchains")
+load(":uv_repositories.bzl", "uv_repositories")
_DOC = """\
A module extension for working with uv.
"""
-uv_toolchain = tag_class(attrs = {
- "uv_version": attr.string(doc = "Explicit version of uv.", mandatory = True),
-})
+uv_toolchain = tag_class(
+ doc = "Configure uv toolchain for lock file generation.",
+ attrs = {
+ "uv_version": attr.string(doc = "Explicit version of uv.", mandatory = True),
+ },
+)
def _uv_toolchain_extension(module_ctx):
for mod in module_ctx.modules:
@@ -38,7 +41,7 @@
"NOTE: We may wish to enforce a policy where toolchain configuration is only allowed in the root module, or in rules_python. See https://github.com/bazelbuild/bazel/discussions/22024",
)
- uv_register_toolchains(
+ uv_repositories(
uv_version = toolchain.uv_version,
register_toolchains = False,
)
diff --git a/python/uv/repositories.bzl b/python/uv/private/uv_repositories.bzl
similarity index 87%
rename from python/uv/repositories.bzl
rename to python/uv/private/uv_repositories.bzl
index 0125b20..24fb9c2 100644
--- a/python/uv/repositories.bzl
+++ b/python/uv/private/uv_repositories.bzl
@@ -18,13 +18,13 @@
Create repositories for uv toolchain dependencies
"""
-load("//python/uv/private:toolchain_types.bzl", "UV_TOOLCHAIN_TYPE")
-load("//python/uv/private:toolchains_repo.bzl", "uv_toolchains_repo")
-load("//python/uv/private:versions.bzl", "UV_PLATFORMS", "UV_TOOL_VERSIONS")
+load(":toolchain_types.bzl", "UV_TOOLCHAIN_TYPE")
+load(":uv_toolchains_repo.bzl", "uv_toolchains_repo")
+load(":versions.bzl", "UV_PLATFORMS", "UV_TOOL_VERSIONS")
UV_BUILD_TMPL = """\
# Generated by repositories.bzl
-load("@rules_python//python/uv:toolchain.bzl", "uv_toolchain")
+load("@rules_python//python/uv:uv_toolchain.bzl", "uv_toolchain")
uv_toolchain(
name = "uv_toolchain",
@@ -77,13 +77,13 @@
},
)
-# buildifier: disable=unnamed-macro
-def uv_register_toolchains(uv_version = None, register_toolchains = True):
+def uv_repositories(name = "uv_toolchains", uv_version = None, register_toolchains = True):
"""Convenience macro which does typical toolchain setup
Skip this macro if you need more control over the toolchain setup.
Args:
+ name: {type}`str` The name of the toolchains repo.
uv_version: The uv toolchain version to download.
register_toolchains: If true, repositories will be generated to produce and register `uv_toolchain` targets.
"""
@@ -109,7 +109,7 @@
toolchain_compatible_with_by_toolchain[toolchain_name] = UV_PLATFORMS[platform].compatible_with
uv_toolchains_repo(
- name = "uv_toolchains",
+ name = name,
toolchain_type = str(UV_TOOLCHAIN_TYPE),
toolchain_names = toolchain_names,
toolchain_labels = toolchain_labels_by_toolchain,
@@ -117,4 +117,4 @@
)
if register_toolchains:
- native.register_toolchains("@uv_toolchains//:all")
+ native.register_toolchains("@{}/:all".format(name))
diff --git a/python/uv/toolchain.bzl b/python/uv/private/uv_toolchain.bzl
similarity index 96%
rename from python/uv/toolchain.bzl
rename to python/uv/private/uv_toolchain.bzl
index 3cd5850..3b51f5f 100644
--- a/python/uv/toolchain.bzl
+++ b/python/uv/private/uv_toolchain.bzl
@@ -18,7 +18,7 @@
This module implements the uv toolchain rule
"""
-load("//python/uv/private:providers.bzl", "UvToolchainInfo")
+load(":uv_toolchain_info.bzl", "UvToolchainInfo")
def _uv_toolchain_impl(ctx):
uv = ctx.attr.uv
diff --git a/python/uv/private/providers.bzl b/python/uv/private/uv_toolchain_info.bzl
similarity index 100%
rename from python/uv/private/providers.bzl
rename to python/uv/private/uv_toolchain_info.bzl
diff --git a/python/uv/private/toolchains_repo.bzl b/python/uv/private/uv_toolchains_repo.bzl
similarity index 100%
rename from python/uv/private/toolchains_repo.bzl
rename to python/uv/private/uv_toolchains_repo.bzl
diff --git a/python/uv/defs.bzl b/python/uv/uv.bzl
similarity index 67%
copy from python/uv/defs.bzl
copy to python/uv/uv.bzl
index 20b426a..d72ab9d 100644
--- a/python/uv/defs.bzl
+++ b/python/uv/uv.bzl
@@ -1,4 +1,4 @@
-# Copyright 2024 The Bazel Authors. All rights reserved.
+# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -12,12 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""
-EXPERIMENTAL: This is experimental and may be removed without notice
+""" EXPERIMENTAL: This is experimental and may be removed without notice.
-A toolchain for uv
+The uv toolchain extension.
"""
-load("//python/uv/private:providers.bzl", _UvToolchainInfo = "UvToolchainInfo")
+load("//python/uv/private:uv.bzl", _uv = "uv")
-UvToolchainInfo = _UvToolchainInfo
+uv = _uv
diff --git a/python/uv/defs.bzl b/python/uv/uv_toolchain.bzl
similarity index 75%
copy from python/uv/defs.bzl
copy to python/uv/uv_toolchain.bzl
index 20b426a..a4b466c 100644
--- a/python/uv/defs.bzl
+++ b/python/uv/uv_toolchain.bzl
@@ -1,4 +1,4 @@
-# Copyright 2024 The Bazel Authors. All rights reserved.
+# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -12,12 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""
+"""The `uv_toolchain` rule.
+
EXPERIMENTAL: This is experimental and may be removed without notice
-
-A toolchain for uv
"""
-load("//python/uv/private:providers.bzl", _UvToolchainInfo = "UvToolchainInfo")
+load("//python/uv/private:uv_toolchain.bzl", _uv_toolchain = "uv_toolchain")
-UvToolchainInfo = _UvToolchainInfo
+uv_toolchain = _uv_toolchain
diff --git a/python/uv/defs.bzl b/python/uv/uv_toolchain_info.bzl
similarity index 78%
rename from python/uv/defs.bzl
rename to python/uv/uv_toolchain_info.bzl
index 20b426a..1ae8963 100644
--- a/python/uv/defs.bzl
+++ b/python/uv/uv_toolchain_info.bzl
@@ -1,4 +1,4 @@
-# Copyright 2024 The Bazel Authors. All rights reserved.
+# Copyright 2025 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@@ -12,12 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""
+"""The `UvToolchainInfo` provider.
+
EXPERIMENTAL: This is experimental and may be removed without notice
-
-A toolchain for uv
"""
-load("//python/uv/private:providers.bzl", _UvToolchainInfo = "UvToolchainInfo")
+load("//python/uv/private:uv_toolchain_info.bzl", _UvToolchainInfo = "UvToolchainInfo")
UvToolchainInfo = _UvToolchainInfo
