add a new macro for setting up aliases

Author: aignas

examples/bzlmod/MODULE.bazel.lock

@@ -0,0 +1,46 @@
+# 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.
+
+"""pkg_aliases is a macro to generate aliases for selecting the right wheel for the right target platform.
+
+This is used in bzlmod and non-bzlmod setups."""
+
+load(
+    ":labels.bzl",
+    #"DATA_LABEL",
+    #"DIST_INFO_LABEL",
+    #"PY_LIBRARY_IMPL_LABEL",
+    "PY_LIBRARY_PUBLIC_LABEL",
+    #"WHEEL_FILE_IMPL_LABEL",
+    #"WHEEL_FILE_PUBLIC_LABEL",
+)
+
+def pkg_aliases(
+        *,
+        name,
+        actual,
+        native = native):
+    """Create aliases for an actual package.
+
+    Args:
+        name: {type}`str` The name of the package.
+        actual: {type}`dict[Label, str]` The config settings for the package
+            mapping to repositories.
+        native: {type}`struct` used in unit tests
+    """
+    _ = actual  # buildifier: @unused
+    native.alias(
+        name = name,
+        actual = ":" + PY_LIBRARY_PUBLIC_LABEL,
+    )

python/private/pypi/pkg_aliases.bzl

@@ -117,9 +117,17 @@ def _render_whl_library_alias(
         **kwargs
     )
 
+def _render_pkg_aliases(name, actual):
+    return """pkg_aliases(
+    name = "{name}",
+    actual = {actual},
+)""".format(name = name, actual = repr(actual))
+
 def _render_common_aliases(*, name, aliases, extra_aliases = [], group_name = None):
     lines = [
-        """load("@bazel_skylib//lib:selects.bzl", "selects")""",
+        """\
+load("@bazel_skylib//lib:selects.bzl", "selects")
+load("@rules_python//python/private/pypi:pkg_aliases.bzl", "pkg_aliases")""",
         """package(default_visibility = ["//visibility:public"])""",
     ]
 
@@ -140,9 +148,9 @@ def _render_common_aliases(*, name, aliases, extra_aliases = [], group_name = No
         ))
 
     lines.append(
-        render.alias(
+        _render_pkg_aliases(
             name = name,
-            actual = repr(":pkg"),
+            actual = ":pkg",
         ),
     )
     lines.extend(

python/private/pypi/render_pkg_aliases.bzl

@@ -0,0 +1,3 @@
+load(":pkg_aliases_test.bzl", "pkg_aliases_test_suite")
+
+pkg_aliases_test_suite(name = "pkg_aliases_tests")

tests/pypi/pkg_aliases/BUILD.bazel

@@ -0,0 +1,53 @@
+# 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.
+
+"""pkg_aliases tests"""
+
+load("@rules_testing//lib:test_suite.bzl", "test_suite")
+load(
+    "//python/private/pypi:pkg_aliases.bzl",
+    "pkg_aliases",
+)  # buildifier: disable=bzl-visibility
+
+_tests = []
+
+def _test_empty(env):
+    actual = []
+    pkg_aliases(
+        name = "foo",
+        actual = "repo",
+        native = struct(
+            alias = lambda **kwargs: actual.append(kwargs),
+        ),
+    )
+
+    want = [
+        # buildifier: disable=unsorted-dict-items
+        {
+            "name": "foo",
+            "actual": ":pkg",
+        },
+    ]
+
+    env.expect.that_collection(actual).contains_exactly(want)
+
+_tests.append(_test_empty)
+
+def pkg_aliases_test_suite(name):
+    """Create the test suite.
+
+    Args:
+        name: the name of the test suite
+    """
+    test_suite(name = name, basic_tests = _tests)

tests/pypi/pkg_aliases/pkg_aliases_test.bzl

@@ -75,10 +75,11 @@ def _test_legacy_aliases(env):
     want_key = "foo/BUILD.bazel"
     want_content = """\
 load("@bazel_skylib//lib:selects.bzl", "selects")
+load("@rules_python//python/private/pypi:pkg_aliases.bzl", "pkg_aliases")
 
 package(default_visibility = ["//visibility:public"])
 
-alias(
+pkg_aliases(
     name = "foo",
     actual = ":pkg",
 )
@@ -120,6 +121,7 @@ def _test_bzlmod_aliases(env):
     want_key = "bar_baz/BUILD.bazel"
     want_content = """\
 load("@bazel_skylib//lib:selects.bzl", "selects")
+load("@rules_python//python/private/pypi:pkg_aliases.bzl", "pkg_aliases")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -140,7 +142,7 @@ If the value is missing, then the "default" Python version is being used,
 which has a "null" version value and will not match version constraints.
 \"\"\"
 
-alias(
+pkg_aliases(
     name = "bar_baz",
     actual = ":pkg",
 )
@@ -222,6 +224,7 @@ def _test_bzlmod_aliases_with_no_default_version(env):
     want_key = "bar_baz/BUILD.bazel"
     want_content = """\
 load("@bazel_skylib//lib:selects.bzl", "selects")
+load("@rules_python//python/private/pypi:pkg_aliases.bzl", "pkg_aliases")
 
 package(default_visibility = ["//visibility:public"])
 
@@ -243,7 +246,7 @@ If the value is missing, then the "default" Python version is being used,
 which has a "null" version value and will not match version constraints.
 \"\"\"
 
-alias(
+pkg_aliases(
     name = "bar_baz",
     actual = ":pkg",
 )