Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(toolchains): split the implementation of toolchain rules to separate files #2232

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/bzlmod/MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion python/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,11 @@ bzl_library(
name = "repositories_bzl",
srcs = ["repositories.bzl"],
deps = [
"//python/private:python_repositories_bzl",
"//python/private:is_standalone_interpreter_bzl",
"//python/private:py_repositories_bzl",
"//python/private:python_register_multi_toolchains_bzl",
"//python/private:python_register_toolchains_bzl",
"//python/private:python_repository_bzl",
],
)

Expand Down
59 changes: 49 additions & 10 deletions python/private/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,14 @@ bzl_library(
deps = [":bzlmod_enabled_bzl"],
)

bzl_library(
name = "is_standalone_interpreter_bzl",
srcs = ["is_standalone_interpreter.bzl"],
deps = [
":repo_utils_bzl",
],
)

bzl_library(
name = "normalize_name_bzl",
srcs = ["normalize_name.bzl"],
Expand All @@ -143,22 +151,53 @@ bzl_library(
)

bzl_library(
name = "python_repositories_bzl",
srcs = ["python_repositories.bzl"],
name = "py_repositories_bzl",
srcs = ["py_repositories.bzl"],
deps = [
":bazel_tools_bzl",
":internal_config_repo_bzl",
"//python/private/pypi:deps_bzl",
],
)

bzl_library(
name = "python_register_toolchains_bzl",
srcs = ["python_register_toolchains.bzl"],
deps = [
":auth_bzl",
":bazel_tools_bzl",
":bzlmod_enabled_bzl",
":coverage_deps_bzl",
":full_version_bzl",
":internal_config_repo_bzl",
":python_repository_bzl",
":toolchains_repo_bzl",
"//python:versions_bzl",
"//python/private:auth_bzl",
"//python/private:bazel_tools_bzl",
"//python/private:bzlmod_enabled_bzl",
"//python/private:coverage_deps_bzl",
"//python/private:full_version_bzl",
"//python/private:internal_config_repo_bzl",
"//python/private:repo_utils_bzl",
"//python/private:toolchains_repo_bzl",
"//python/private/pypi:deps_bzl",
],
)

bzl_library(
name = "python_repository_bzl",
srcs = ["python_repository.bzl"],
deps = [
":auth_bzl",
":repo_utils_bzl",
":text_util_bzl",
"//python:versions_bzl",
],
)

bzl_library(
name = "python_register_multi_toolchains_bzl",
srcs = ["python_register_multi_toolchains.bzl"],
deps = [
":python_register_toolchains_bzl",
":toolchains_repo_bzl",
"//python:versions_bzl",
],
)

bzl_library(
name = "pythons_hub_bzl",
srcs = ["pythons_hub.bzl"],
Expand Down
50 changes: 50 additions & 0 deletions python/private/is_standalone_interpreter.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Copyright 2024 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.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This file contains repository rules and macros to support toolchain registration.
"""

load(":repo_utils.bzl", "repo_utils")

STANDALONE_INTERPRETER_FILENAME = "STANDALONE_INTERPRETER"

def is_standalone_interpreter(rctx, python_interpreter_path, *, logger = None):
"""Query a python interpreter target for whether or not it's a rules_rust provided toolchain
Comment on lines +22 to +23
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you happen to know the history of this function? It's always struck me as a bit strange.


Args:
rctx: {type}`repository_ctx` The repository rule's context object.
python_interpreter_path: {type}`path` A path representing the interpreter.
logger: Optional logger to use for operations.

Returns:
{type}`bool` Whether or not the target is from a rules_python generated toolchain.
"""

# Only update the location when using a hermetic toolchain.
if not python_interpreter_path:
return False

# This is a rules_python provided toolchain.
return repo_utils.execute_unchecked(
rctx,
op = "IsStandaloneInterpreter",
arguments = [
"ls",
"{}/{}".format(
python_interpreter_path.dirname,
STANDALONE_INTERPRETER_FILENAME,
),
],
logger = logger,
).return_code == 0
49 changes: 49 additions & 0 deletions python/private/py_repositories.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Copyright 2024 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.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This file contains macros to be called during WORKSPACE evaluation."""

load("@bazel_tools//tools/build_defs/repo:http.bzl", _http_archive = "http_archive")
load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
load("//python/private/pypi:deps.bzl", "pypi_deps")
load(":internal_config_repo.bzl", "internal_config_repo")

def http_archive(**kwargs):
maybe(_http_archive, **kwargs)

def py_repositories():
"""Runtime dependencies that users must install.

This function should be loaded and called in the user's WORKSPACE.
With bzlmod enabled, this function is not needed since MODULE.bazel handles transitive deps.
"""
maybe(
internal_config_repo,
name = "rules_python_internal",
)
http_archive(
name = "bazel_skylib",
sha256 = "74d544d96f4a5bb630d465ca8bbcfe231e3594e5aae57e1edbf17a6eb3ca2506",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/bazel-skylib/releases/download/1.3.0/bazel-skylib-1.3.0.tar.gz",
"https://github.com/bazelbuild/bazel-skylib/releases/download/1.3.0/bazel-skylib-1.3.0.tar.gz",
],
)
http_archive(
name = "rules_cc",
urls = ["https://github.com/bazelbuild/rules_cc/releases/download/0.0.9/rules_cc-0.0.9.tar.gz"],
sha256 = "2037875b9a4456dce4a79d112a8ae885bbc4aad968e6587dca6e64f3a0900cdf",
strip_prefix = "rules_cc-0.0.9",
)
pypi_deps()
2 changes: 1 addition & 1 deletion python/private/pypi/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -306,9 +306,9 @@ bzl_library(
":patch_whl_bzl",
":pypi_repo_utils_bzl",
":whl_target_platforms_bzl",
"//python:repositories_bzl",
"//python/private:auth_bzl",
"//python/private:envsubst_bzl",
"//python/private:is_standalone_interpreter_bzl",
"//python/private:repo_utils_bzl",
],
)
Expand Down
2 changes: 1 addition & 1 deletion python/private/pypi/whl_library.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

load("//python/private:auth.bzl", "AUTH_ATTRS", "get_auth")
load("//python/private:envsubst.bzl", "envsubst")
load("//python/private:python_repositories.bzl", "is_standalone_interpreter")
load("//python/private:is_standalone_interpreter.bzl", "is_standalone_interpreter")
load("//python/private:repo_utils.bzl", "REPO_DEBUG_ENV_VAR", "repo_utils")
load(":attrs.bzl", "ATTRS", "use_isolated")
load(":deps.bzl", "all_repo_names")
Expand Down
2 changes: 1 addition & 1 deletion python/private/python.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"Python toolchain module extensions for use with bzlmod"

load("@bazel_features//:features.bzl", "bazel_features")
load("//python:repositories.bzl", "python_register_toolchains")
load("//python:versions.bzl", "MINOR_MAPPING", "TOOL_VERSIONS")
load(":full_version.bzl", "full_version")
load(":python_register_toolchains.bzl", "python_register_toolchains")
load(":pythons_hub.bzl", "hub_repo")
load(":repo_utils.bzl", "repo_utils")
load(":text_util.bzl", "render")
Expand Down
75 changes: 75 additions & 0 deletions python/private/python_register_multi_toolchains.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# Copyright 2024 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.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""This file contains repository rules and macros to support toolchain registration.
"""

load("//python:versions.bzl", "MINOR_MAPPING")
load(":python_register_toolchains.bzl", "python_register_toolchains")
load(":toolchains_repo.bzl", "multi_toolchain_aliases")

def python_register_multi_toolchains(
name,
python_versions,
default_version = None,
minor_mapping = None,
**kwargs):
"""Convenience macro for registering multiple Python toolchains.

Args:
name: {type}`str` base name for each name in {obj}`python_register_toolchains` call.
python_versions: {type}`list[str]` the Python versions.
default_version: {type}`str` the default Python version. If not set,
the first version in python_versions is used.
minor_mapping: {type}`dict[str, str]` mapping between `X.Y` to `X.Y.Z`
format. Defaults to the value in `//python:versions.bzl`.
**kwargs: passed to each {obj}`python_register_toolchains` call.
"""
if len(python_versions) == 0:
fail("python_versions must not be empty")

minor_mapping = minor_mapping or MINOR_MAPPING

if not default_version:
default_version = python_versions.pop(0)
for python_version in python_versions:
if python_version == default_version:
# We register the default version lastly so that it's not picked first when --platforms
# is set with a constraint during toolchain resolution. This is due to the fact that
# Bazel will match the unconstrained toolchain if we register it before the constrained
# ones.
continue
python_register_toolchains(
name = name + "_" + python_version.replace(".", "_"),
python_version = python_version,
set_python_version_constraint = True,
minor_mapping = minor_mapping,
**kwargs
)
python_register_toolchains(
name = name + "_" + default_version.replace(".", "_"),
python_version = default_version,
set_python_version_constraint = False,
minor_mapping = minor_mapping,
**kwargs
)

multi_toolchain_aliases(
name = name,
python_versions = {
python_version: name + "_" + python_version.replace(".", "_")
for python_version in (python_versions + [default_version])
},
minor_mapping = minor_mapping,
)
Loading