chore: remove internal usage of deprecated py_binary ad py_test (baze…

…lbuild#2569) This goes together with bazelbuild#2565 to remove the internal usage of the deprecated symbols. This also fixes the compile_pip_requirements symbol to print the correct deprecation message. Builds on top of 611eda8 The example message that would be printed is as follows: ``` The 'py_test' symbol in '@+python+python_3_11//:defs.bzl' is deprecated. It is an alias to the regular rule; use it directly instead: load("@rules_python//python:py_test.bzl", "py_test") py_test( name = "versioned_py_test", srcs = ["dummy.py"], main = "dummy.py", python_version = "3.11.11", ) ``` --------- Co-authored-by: Richard Levasseur <[email protected]>
aignas · Jan 22, 2025 · 188598a · 188598a
1 parent 50a9a2e
commit 188598a
Show file tree

Hide file tree

Showing 22 changed files with 336 additions and 119 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -54,6 +54,9 @@ Unreleased changes template.
 ### Changed
 * (pypi) {obj}`pip.override` will now be ignored instead of raising an error,
   fixes [#2550](https://github.com/bazelbuild/rules_python/issues/2550).
+* (rules) deprecation warnings for deprecated symbols have been turned off by
+  default for now and can be enabled with `RULES_PYTHON_DEPRECATION_WARNINGS`
+  env var.
 
 {#v0-0-0-fixed}
 ### Fixed

diff --git a/MODULE.bazel b/MODULE.bazel
@@ -46,7 +46,12 @@ python.toolchain(
     is_default = True,
     python_version = "3.11",
 )
-use_repo(python, "python_3_11", "python_versions", "pythons_hub")
+use_repo(
+    python,
+    "python_3_11",
+    "pythons_hub",
+    python = "python_versions",
+)
 
 # This call registers the Python toolchains.
 register_toolchains("@pythons_hub//:all")

diff --git a/WORKSPACE b/WORKSPACE
@@ -68,12 +68,12 @@ load("//:internal_dev_setup.bzl", "rules_python_internal_setup")
 
 rules_python_internal_setup()
 
-load("@pythons_hub//:versions.bzl", "MINOR_MAPPING", "PYTHON_VERSIONS")
+load("@pythons_hub//:versions.bzl", "PYTHON_VERSIONS")
 load("//python:repositories.bzl", "python_register_multi_toolchains")
 
 python_register_multi_toolchains(
     name = "python",
-    default_version = MINOR_MAPPING.values()[-3],  # Use 3.11.10
+    default_version = "3.11",
     # Integration tests verify each version, so register all of them.
     python_versions = PYTHON_VERSIONS,
 )

diff --git a/docs/environment-variables.md b/docs/environment-variables.md
@@ -40,6 +40,12 @@ When `1`, bzlmod extensions will print debug information about what they're
 doing. This is mostly useful for development to debug errors.
 :::
 
+:::{envvar} RULES_PYTHON_DEPRECATION_WARNINGS
+
+When `1`, the rules_python will warn users about deprecated functionality that will
+be removed in a subsequent major `rules_python` version. Defaults to `0` if unset.
+:::
+
 :::{envvar} RULES_PYTHON_ENABLE_PYSTAR
 
 When `1`, the rules_python Starlark implementation of the core rules is used

diff --git a/examples/bzlmod/other_module/BUILD.bazel b/examples/bzlmod/other_module/BUILD.bazel
@@ -1,9 +1,10 @@
-load("@python_versions//3.11:defs.bzl", compile_pip_requirements_311 = "compile_pip_requirements")
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 
 # NOTE: To update the requirements, you need to uncomment the rules_python
 # override in the MODULE.bazel.
-compile_pip_requirements_311(
+compile_pip_requirements(
     name = "requirements",
     src = "requirements.in",
+    python_version = "3.11",
     requirements_txt = "requirements_lock_3_11.txt",
 )
diff --git a/examples/bzlmod/other_module/other_module/pkg/BUILD.bazel b/examples/bzlmod/other_module/other_module/pkg/BUILD.bazel
@@ -1,7 +1,4 @@
-load(
-    "@python_3_11//:defs.bzl",
-    py_binary_311 = "py_binary",
-)
+load("@rules_python//python:py_binary.bzl", "py_binary")
 load("@rules_python//python:py_library.bzl", "py_library")
 
 py_library(
@@ -15,11 +12,12 @@ py_library(
 # This is used for testing mulitple versions of Python. This is
 # used only when you need to support multiple versions of Python
 # in the same project.
-py_binary_311(
+py_binary(
     name = "bin",
     srcs = ["bin.py"],
     data = ["data/data.txt"],
     main = "bin.py",
+    python_version = "3.11",
     visibility = ["//visibility:public"],
     deps = [
         ":lib",

diff --git a/examples/bzlmod/tests/BUILD.bazel b/examples/bzlmod/tests/BUILD.bazel
@@ -1,10 +1,6 @@
-load("@python_versions//3.10:defs.bzl", py_binary_3_10 = "py_binary", py_test_3_10 = "py_test")
-load("@python_versions//3.11:defs.bzl", py_binary_3_11 = "py_binary", py_test_3_11 = "py_test")
-load("@python_versions//3.9:defs.bzl", py_binary_3_9 = "py_binary", py_test_3_9 = "py_test")
 load("@pythons_hub//:versions.bzl", "MINOR_MAPPING")
 load("@rules_python//python:py_binary.bzl", "py_binary")
 load("@rules_python//python:py_test.bzl", "py_test")
-load("@rules_python//python/config_settings:transition.bzl", py_versioned_binary = "py_binary", py_versioned_test = "py_test")
 load("@rules_shell//shell:sh_test.bzl", "sh_test")
 
 py_binary(
@@ -13,25 +9,28 @@ py_binary(
     main = "version.py",
 )
 
-py_binary_3_9(
+py_binary(
     name = "version_3_9",
     srcs = ["version.py"],
     main = "version.py",
+    python_version = "3.9",
 )
 
-py_binary_3_10(
+py_binary(
     name = "version_3_10",
     srcs = ["version.py"],
     main = "version.py",
+    python_version = "3.10",
 )
 
-py_binary_3_11(
+py_binary(
     name = "version_3_11",
     srcs = ["version.py"],
     main = "version.py",
+    python_version = "3.11",
 )
 
-py_versioned_binary(
+py_binary(
     name = "version_3_10_versioned",
     srcs = ["version.py"],
     main = "version.py",
@@ -49,21 +48,23 @@ py_test(
     deps = ["//libs/my_lib"],
 )
 
-py_test_3_9(
+py_test(
     name = "my_lib_3_9_test",
     srcs = ["my_lib_test.py"],
     main = "my_lib_test.py",
+    python_version = "3.9",
     deps = ["//libs/my_lib"],
 )
 
-py_test_3_10(
+py_test(
     name = "my_lib_3_10_test",
     srcs = ["my_lib_test.py"],
     main = "my_lib_test.py",
+    python_version = "3.10",
     deps = ["//libs/my_lib"],
 )
 
-py_versioned_test(
+py_test(
     name = "my_lib_versioned_test",
     srcs = ["my_lib_test.py"],
     main = "my_lib_test.py",
@@ -92,33 +93,36 @@ py_test(
     main = "version_test.py",
 )
 
-py_test_3_9(
+py_test(
     name = "version_3_9_test",
     srcs = ["version_test.py"],
     env = {"VERSION_CHECK": "3.9"},
     main = "version_test.py",
+    python_version = "3.9",
 )
 
-py_test_3_10(
+py_test(
     name = "version_3_10_test",
     srcs = ["version_test.py"],
     env = {"VERSION_CHECK": "3.10"},
     main = "version_test.py",
+    python_version = "3.10",
 )
 
-py_versioned_test(
+py_test(
     name = "version_versioned_test",
     srcs = ["version_test.py"],
     env = {"VERSION_CHECK": "3.10"},
     main = "version_test.py",
     python_version = "3.10",
 )
 
-py_test_3_11(
+py_test(
     name = "version_3_11_test",
     srcs = ["version_test.py"],
     env = {"VERSION_CHECK": "3.11"},
     main = "version_test.py",
+    python_version = "3.11",
 )
 
 py_test(
@@ -133,7 +137,7 @@ py_test(
     main = "cross_version_test.py",
 )
 
-py_test_3_10(
+py_test(
     name = "version_3_10_takes_3_9_subprocess_test",
     srcs = ["cross_version_test.py"],
     data = [":version_3_9"],
@@ -143,9 +147,10 @@ py_test_3_10(
         "VERSION_CHECK": "3.10",
     },
     main = "cross_version_test.py",
+    python_version = "3.10",
 )
 
-py_versioned_test(
+py_test(
     name = "version_3_10_takes_3_9_subprocess_test_2",
     srcs = ["cross_version_test.py"],
     data = [":version_3_9"],

diff --git a/examples/multi_python_versions/requirements/BUILD.bazel b/examples/multi_python_versions/requirements/BUILD.bazel
@@ -1,28 +1,29 @@
-load("@python//3.10:defs.bzl", compile_pip_requirements_3_10 = "compile_pip_requirements")
-load("@python//3.11:defs.bzl", compile_pip_requirements_3_11 = "compile_pip_requirements")
-load("@python//3.8:defs.bzl", compile_pip_requirements_3_8 = "compile_pip_requirements")
-load("@python//3.9:defs.bzl", compile_pip_requirements_3_9 = "compile_pip_requirements")
+load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 
-compile_pip_requirements_3_8(
+compile_pip_requirements(
     name = "requirements_3_8",
     src = "requirements.in",
+    python_version = "3.8",
     requirements_txt = "requirements_lock_3_8.txt",
 )
 
-compile_pip_requirements_3_9(
+compile_pip_requirements(
     name = "requirements_3_9",
     src = "requirements.in",
+    python_version = "3.9",
     requirements_txt = "requirements_lock_3_9.txt",
 )
 
-compile_pip_requirements_3_10(
+compile_pip_requirements(
     name = "requirements_3_10",
     src = "requirements.in",
+    python_version = "3.10",
     requirements_txt = "requirements_lock_3_10.txt",
 )
 
-compile_pip_requirements_3_11(
+compile_pip_requirements(
     name = "requirements_3_11",
     src = "requirements.in",
+    python_version = "3.11",
     requirements_txt = "requirements_lock_3_11.txt",
 )