consolidate the config and group libraries

Author: aignas

examples/pip_parse_vendored/requirements.bzl

@@ -91,7 +91,7 @@ def install_deps(**whl_library_kwargs):
         for requirement in group_requirements
     }
 
-    group_repo = "my_project_pip_deps_vendored__groups"
+    group_repo = "my_project_pip_deps_vendored__config"
     group_library(
         name = group_repo,
         repo_prefix = "my_project_pip_deps_vendored_",

python/pip_install/pip_repository.bzl

@@ -14,14 +14,13 @@
 
 ""
 
-load("//python/private/pypi:group_library.bzl", _group_library = "group_library")
 load("//python/private/pypi:package_annotation.bzl", _package_annotation = "package_annotation")
 load("//python/private/pypi:pip_repository.bzl", _pip_repository = "pip_repository")
 load("//python/private/pypi:whl_config_repository.bzl", _whl_config_repository = "whl_config_repository")
 load("//python/private/pypi:whl_library.bzl", _whl_library = "whl_library")
 
 # Re-exports for backwards compatibility
-group_library = _group_library
+group_library = _whl_config_repository
 pip_repository = _pip_repository
 whl_library = _whl_library
 whl_config_repository = _whl_config_repository

python/private/pypi/group_library.bzl

@@ -203,24 +203,19 @@ def _pip_repository_impl(rctx):
 
     rctx.file("BUILD.bazel", _BUILD_FILE_CONTENTS)
     rctx.template("requirements.bzl", rctx.attr._template, substitutions = {
-        "    # %%CONFIG_LIBRARY%%": """\
+        "    # %%CONFIG_REPO%%": """\
     config_repo = "{name}__config"
     whl_config_repository(
         name = config_repo,
+        repo_prefix = "{name}_",
+        groups = all_requirement_groups,
         whl_map = {{
             p: ""
             for p in all_whl_requirements_by_package
         }},
     )""".format(name = rctx.attr.name) if not rctx.attr.use_hub_alias_dependencies else """\
     config_repo = "{name}"
 """.format(name = rctx.attr.name),
-        "    # %%GROUP_LIBRARY%%": """\
-    group_repo = "{name}__groups"
-    group_library(
-        name = group_repo,
-        repo_prefix = "{name}_",
-        groups = all_requirement_groups,
-    )""".format(name = rctx.attr.name) if not rctx.attr.use_hub_alias_dependencies else "",
         "%%ALL_DATA_REQUIREMENTS%%": render.list([
             macro_tmpl.format(p, "data")
             for p in bzl_packages

python/private/pypi/pip_repository.bzl

@@ -52,9 +52,7 @@ def install_deps(**whl_library_kwargs):
         for requirement in group_requirements
     }
 
-    # %%GROUP_LIBRARY%%
-
-    # %%CONFIG_LIBRARY%%
+    # %%CONFIG_REPO%%
 
     # Install wheels which may be participants in a group
     whl_config = dict(_config)

python/private/pypi/requirements.bzl.tmpl.workspace

@@ -1,19 +1,31 @@
-""
+"""whl_config_library implementation for WORKSPACE setups."""
 
 load("//python/private:text_util.bzl", "render")
+load(":generate_group_library_build_bazel.bzl", "generate_group_library_build_bazel")
 
 def _impl(rctx):
+    build_file_contents = generate_group_library_build_bazel(
+        repo_prefix = rctx.attr.repo_prefix,
+        groups = rctx.attr.groups,
+    )
+    rctx.file("_groups/BUILD.bazel", build_file_contents)
     rctx.file("BUILD.bazel", "")
     rctx.template(
         "config.bzl",
         rctx.attr._config_template,
         substitutions = {
-            "%%PACKAGES%%": render.dict(rctx.attr.whl_map, value_repr = lambda x: "None"),
+            "%%PACKAGES%%": render.dict(rctx.attr.whl_map or {}, value_repr = lambda x: "None"),
         },
     )
 
 whl_config_repository = repository_rule(
     attrs = {
+        "groups": attr.string_list_dict(
+            doc = "A mapping of group names to requirements within that group.",
+        ),
+        "repo_prefix": attr.string(
+            doc = "Prefix used for the whl_library created components of each group",
+        ),
         "whl_map": attr.string_dict(
             mandatory = True,
             doc = """\
@@ -25,6 +37,11 @@ in the pip.parse tag class.
             default = ":config.bzl.tmpl.bzlmod",
         ),
     },
-    doc = """A rule for WORKSPACE to ensure correct whl_repository configuration. PRIVATE USE ONLY.""",
+    doc = """
+Create a package containing only wrapper py_library and whl_library rules for implementing dependency groups.
+This is an implementation detail of dependency groups and should not be used alone.
+
+PRIVATE USE ONLY, only used in WORKSPACE.
+    """,
     implementation = _impl,
 )

python/private/pypi/whl_config_repository.bzl

@@ -274,12 +274,18 @@ def whl_library_targets(
     if group_name and "//:" in dep_template:
         # This is the legacy behaviour where the group library is outside the hub repo
         label_tmpl = dep_template.format(
-            name = "_groups",
+            name = "_config",
             target = normalize_name(group_name) + "_{}",
+        ).replace(
+            "//:",
+            "//_groups:",
         )
         impl_vis = [dep_template.format(
-            name = "_groups",
+            name = "_config",
             target = "__pkg__",
+        ).replace(
+            "//:",
+            "//_groups:",
         )]
 
         native.alias(

python/private/pypi/whl_library_targets.bzl

@@ -168,6 +168,7 @@ def _test_simple(env):
     }})
     pypi.whl_libraries().contains_exactly({
         "pypi_315_simple": {
+            "config_load": "@pypi//:config.bzl",
             "dep_template": "@pypi//{name}:{target}",
             "python_interpreter_target": "unit_test_interpreter_target",
             "requirement": "simple==0.0.1 --hash=sha256:deadbeef --hash=sha256:deadbaaf",

tests/pypi/extension/extension_tests.bzl

@@ -37,7 +37,7 @@ whl_library_targets(
         "exclude_via_attr",
         "data_exclude_all",
     ],
-    dep_template = "@pypi//{name}:{target}",
+    dep_template = "@pypi_{name}//:{target}",
     dependencies = ["foo"],
     dependencies_by_platform = {
         "baz": ["bar"],
@@ -59,7 +59,7 @@ whl_library_targets(
 # SOMETHING SPECIAL AT THE END
 """
     actual = generate_whl_library_build_bazel(
-        dep_template = "@pypi//{name}:{target}",
+        dep_template = "@pypi_{name}//:{target}",
         name = "foo.whl",
         dependencies = ["foo"],
         dependencies_by_platform = {"baz": ["bar"]},
@@ -83,9 +83,74 @@ whl_library_targets(
 
 _tests.append(_test_all_legacy)
 
+def _test_all_workspace(env):
+    want = """\
+load("@pypi//:config.bzl", "packages")
+load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets_from_requires")
+
+package(default_visibility = ["//visibility:public"])
+
+whl_library_targets_from_requires(
+    copy_executables = {
+        "exec_src": "exec_dest",
+    },
+    copy_files = {
+        "file_src": "file_dest",
+    },
+    data = ["extra_target"],
+    data_exclude = [
+        "exclude_via_attr",
+        "data_exclude_all",
+    ],
+    dep_template = "@pypi//{name}:{target}",
+    entry_points = {
+        "foo": "bar.py",
+    },
+    group_deps = [
+        "foo",
+        "fox",
+        "qux",
+    ],
+    group_name = "qux",
+    include = packages,
+    name = "foo.whl",
+    requires_dist = [
+        "foo",
+        "bar-baz",
+        "qux",
+    ],
+    srcs_exclude = ["srcs_exclude_all"],
+)
+
+# SOMETHING SPECIAL AT THE END
+"""
+    actual = generate_whl_library_build_bazel(
+        dep_template = "@pypi//{name}:{target}",
+        name = "foo.whl",
+        requires_dist = ["foo", "bar-baz", "qux"],
+        entry_points = {
+            "foo": "bar.py",
+        },
+        data_exclude = ["exclude_via_attr"],
+        annotation = struct(
+            copy_files = {"file_src": "file_dest"},
+            copy_executables = {"exec_src": "exec_dest"},
+            data = ["extra_target"],
+            data_exclude_glob = ["data_exclude_all"],
+            srcs_exclude_glob = ["srcs_exclude_all"],
+            additive_build_content = """# SOMETHING SPECIAL AT THE END""",
+        ),
+        config_load = "@pypi//:config.bzl",
+        group_name = "qux",
+        group_deps = ["foo", "fox", "qux"],
+    )
+    env.expect.that_str(actual.replace("@@", "@")).equals(want)
+
+_tests.append(_test_all_workspace)
+
 def _test_all(env):
     want = """\
-load("@pypi//:requirements.bzl", "packages")
+load("@pypi//:config.bzl", "packages")
 load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets_from_requires")
 
 package(default_visibility = ["//visibility:public"])
@@ -140,6 +205,7 @@ whl_library_targets_from_requires(
             srcs_exclude_glob = ["srcs_exclude_all"],
             additive_build_content = """# SOMETHING SPECIAL AT THE END""",
         ),
+        config_load = "@pypi//:config.bzl",
         group_name = "qux",
         group_deps = ["foo", "fox", "qux"],
     )
@@ -149,7 +215,7 @@ _tests.append(_test_all)
 
 def _test_all_with_loads(env):
     want = """\
-load("@pypi//:requirements.bzl", "packages")
+load("@pypi//:config.bzl", "packages")
 load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets_from_requires")
 
 package(default_visibility = ["//visibility:public"])
@@ -205,6 +271,7 @@ whl_library_targets_from_requires(
             additive_build_content = """# SOMETHING SPECIAL AT THE END""",
         ),
         group_name = "qux",
+        config_load = "@pypi//:config.bzl",
         group_deps = ["foo", "fox", "qux"],
     )
     env.expect.that_str(actual.replace("@@", "@")).equals(want)