Skip to content

feat: add package metadata for wheel libraries #3531

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.

Sign up for GitHub

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

Open
stevebarrau wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −3
Open

feat: add package metadata for wheel libraries #3531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ module(

bazel_dep(name = "bazel_features", version = "1.21.0")
bazel_dep(name = "bazel_skylib", version = "1.8.2")
bazel_dep(name = "rules_cc", version = "0.1.5")
bazel_dep(name = "package_metadata", version = "0.0.6")
bazel_dep(name = "platforms", version = "0.0.11")
bazel_dep(name = "rules_cc", version = "0.1.5")

# Those are loaded only when using py_proto_library
# Use py_proto_library directly from protobuf repository
Expand Down
13 changes: 12 additions & 1 deletion python/private/pypi/generate_whl_library_build_bazel.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ _TEMPLATE = """\

package(default_visibility = ["//visibility:public"])

package_metadata(
name = "package_metadata",
purl = {purl},
visibility = ["//:__subpackages__"],
)

{fn}(
{kwargs}
)
Expand All @@ -50,6 +56,7 @@ def generate_whl_library_build_bazel(
*,
annotation = None,
default_python_version = None,
purl = None,
**kwargs):
"""Generate a BUILD file for an unzipped Wheel

Expand All @@ -63,7 +70,10 @@ def generate_whl_library_build_bazel(
A complete BUILD file as a string
"""

loads = []
loads = [
"""load("@package_metadata//rules:package_metadata.bzl", "package_metadata")""",
]

if kwargs.get("tags"):
fn = "whl_library_targets"

Expand Down Expand Up @@ -132,6 +142,7 @@ def generate_whl_library_build_bazel(
"{} = {},".format(k, _RENDER.get(k, repr)(v))
for k, v in sorted(kwargs.items())
])),
purl = repr(purl),
),
] + additional_content,
)
Expand Down
14 changes: 13 additions & 1 deletion python/private/pypi/whl_library.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,6 +506,11 @@ def _whl_library_impl(rctx):
entry_points[entry_point_without_py] = entry_point_script_name

namespace_package_files = pypi_repo_utils.find_namespace_package_files(rctx, rctx.path("site-packages"))
purl = "pkg:pypi/{}@{}".format(
Copy link
Collaborator

@aignas aignas Jan 23, 2026

Choose a reason for hiding this comment

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

What happens if we have private packages in here? Is pkg:pypi/{}@{} only a type of registry or the actual public PyPI?

# https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md#name-definition
metadata["name"].replace("_", "-").lower(),
metadata["version"],
)

build_file_contents = generate_whl_library_build_bazel(
name = whl_path.basename,
Expand All @@ -526,14 +531,21 @@ def _whl_library_impl(rctx):
"pypi_version={}".format(metadata["version"]),
],
namespace_package_files = namespace_package_files,
purl = purl,
Copy link
Collaborator

@aignas aignas Jan 23, 2026

Choose a reason for hiding this comment

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

This also needs to be added above, in the other branch of the code.

)

# Delete these in case the wheel had them. They generally don't cause
# a problem, but let's avoid the chance of that happening.
rctx.file("WORKSPACE")
rctx.file("WORKSPACE.bazel")
rctx.file("MODULE.bazel")
rctx.file("REPO.bazel")
rctx.file("REPO.bazel", """\
repo(
default_package_metadata = [
"//:package_metadata",
],
)
""")

paths = list(rctx.path(".").readdir())
for _ in range(10000000):
Expand Down