fix(bzlmod)!: support X.Y or X.Y.Z versions in python.toolchain

aignas · aignas · commit 0e93efbb1dd5 · 2023-07-24T13:10:04.000+09:00
Before this PR the `bzlmod` example would only work if the Python interpreter version is specified in the `X.Y` format. However, users may desire to use the full version (`X.Y.Z`) for reproducibility reasons and expect everything to continue to work. This fixes the versions used everywhere by leveraging functionality introduced in #1328 and fixes the `python_versions` to always contain `@python_versions//X.Y:defs.bzl` imports. NOTE, #1328 also fixed the case where the Python-version specific `pip` hub repos would be named `<hub_name>_XYZ` as opposed to the `<hub_name>_XY`, which is expected across the codebase. Breaking for `bzlmod` users who previously used `@python_versions//X.Y.Z:defs.bzl` in their BUILD.bazel files and/or depended on the `@pip_XYZ//:requirements.bzl`. This essentially limits the users of the `@python_versions` to a single `X.Y` toolchain version, whilst the full functionality should still be available by using the `python_version` parameter in the `py_binary` and `py_library` rules. Fixes #1339.
diff --git a/examples/bzlmod/MODULE.bazel b/examples/bzlmod/MODULE.bazel
@@ -32,7 +32,8 @@ python.toolchain(
 # work in progress.
 python.toolchain(
     configure_coverage_tool = True,
-    python_version = "3.10",
+    # One can also provide the full Python version.
+    python_version = "3.10.9",
 )
 
 # You only need to load this repositories if you are using multiple Python versions.
diff --git a/python/extensions/python.bzl b/python/extensions/python.bzl
@@ -17,6 +17,7 @@
 load("//python:repositories.bzl", "python_register_toolchains")
 load("//python/extensions/private:pythons_hub.bzl", "hub_repo")
 load("//python/private:toolchains_repo.bzl", "multi_toolchain_aliases")
+load("//python/private:version_label.bzl", "version_label")
 
 # This limit can be increased essentially arbitrarily, but doing so will cause a rebuild of all
 # targets using any of these toolchains due to the changed repository name.
@@ -75,7 +76,7 @@ def _python_impl(module_ctx):
 
         for toolchain_attr in mod.tags.toolchain:
             toolchain_version = toolchain_attr.python_version
-            toolchain_name = "python_" + toolchain_version.replace(".", "_")
+            toolchain_name = "python_" + version_label(toolchain_version, sep = "_")
 
             # Duplicate versions within a module indicate a misconfigured module.
             if toolchain_version in module_toolchain_versions:
@@ -165,7 +166,9 @@ def _python_impl(module_ctx):
     multi_toolchain_aliases(
         name = "python_versions",
         python_versions = {
-            version: entry.toolchain_name
+            # NOTE @aignas 2023-07-24: we are effectively using the
+            # version_label function to drop the patch version information.
+            version_label(version, sep = "."): entry.toolchain_name
             for version, entry in global_toolchain_versions.items()
         },
     )

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,8 @@ python.toolchain(`
`32`	`32`	`# work in progress.`
`33`	`33`	`python.toolchain(`
`34`	`34`	`configure_coverage_tool = True,`
`35`		`- python_version = "3.10",`
	`35`	`+ # One can also provide the full Python version.`
	`36`	`+ python_version = "3.10.9",`
`36`	`37`	`)`
`37`	`38`
`38`	`39`	`# You only need to load this repositories if you are using multiple Python versions.`