Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 30 additions & 1 deletion BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
# See the License for the specific language governing permissions and
# limitations under the License.

load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
load("@package_metadata//licenses/rules:license.bzl", "license")
load("@package_metadata//purl:purl.bzl", "purl")
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")

# Resolve rules_cc Starlark libraries to their correct targets
# gazelle:resolve starlark @rules_cc//cc/common:cc_info.bzl @rules_cc//cc/common:common
# gazelle:resolve starlark @rules_cc//cc/common:cc_common.bzl @rules_cc//cc/common:common
Expand Down Expand Up @@ -51,6 +56,24 @@ package(default_visibility = ["//visibility:public"])

licenses(["notice"])

package_metadata(
name = "package_metadata",
attributes = [
":license",
],
purl = purl.bazel(
module_name() or "rules_python",
module_version(),
),
visibility = ["//visibility:public"],
)

license(
name = "license",
kind = "@package_metadata//licenses/spdx:Apache-2.0",
text = ":LICENSE",
)

exports_files([
".clippy.toml",
"LICENSE",
Expand All @@ -68,7 +91,11 @@ exports_files(
)

exports_files(
glob(["*.md"]),
glob(
["*.md"],
# Not all files are present when used as an integration test fixture
allow_empty = True,
),
visibility = ["//docs:__subpackages__"],
)

Expand Down Expand Up @@ -100,7 +127,9 @@ filegroup(
name = "distribution",
srcs = [
"BUILD.bazel",
"LICENSE",
"MODULE.bazel",
"REPO.bazel",
"WORKSPACE",
"WORKSPACE.bzlmod",
"internal_dev_deps.bzl",
Expand Down
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module(

bazel_dep(name = "bazel_features", version = "1.55.0")
bazel_dep(name = "bazel_skylib", version = "1.8.2")
bazel_dep(name = "package_metadata", version = "0.0.7")
bazel_dep(name = "package_metadata", version = "0.0.13")
Comment thread
aignas marked this conversation as resolved.
Resolved
bazel_dep(name = "platforms", version = "0.0.11")
bazel_dep(name = "rules_cc", version = "0.2.17")
bazel_dep(name = "toml.bzl", version = "0.4.1")
Expand Down
7 changes: 7 additions & 0 deletions REPO.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
"""File declaring metadata applying to all packages and targets in the Bazel module."""

repo(
default_package_metadata = [
"//:package_metadata",
],
)
5 changes: 5 additions & 0 deletions news/4276.changed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
(workspace) **BREAKING** `rules_python` now requires `package_metadata` 0.0.13
or newer. WORKSPACE users who define `@package_metadata` themselves (e.g. via
another dependency) must update it, e.g. with an `http_archive` of
`package_metadata-0.0.13` (`strip_prefix = "package_metadata-0.0.13/metadata"`).
([#4276](https://github.com/bazel-contrib/rules_python/pull/4276))
6 changes: 3 additions & 3 deletions python/private/py_repositories.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ def py_repositories(transition_settings = []):
)
http_archive(
name = "package_metadata",
sha256 = "8f27dc7393e3f3bdc793bdc4ba36d67a63c22cc9d38cc65d3204654974ea4563",
strip_prefix = "supply-chain-0.0.7/metadata",
url = "https://github.com/bazel-contrib/supply-chain/releases/download/v0.0.7/supply-chain-v0.0.7.tar.gz",
sha256 = "755bd6c8a3751982e2555d96c913ec070954ca9d01f935563392255da4ebad72",
strip_prefix = "package_metadata-0.0.13/metadata",
url = "https://github.com/bazel-contrib/supply-chain/releases/download/package_metadata-0.0.13/package_metadata-0.0.13.tar.gz",
)

# Needed by rules_cc, triggered by @rules_java_prebuilt in Bazel by using @rules_cc//cc:defs.bzl
Expand Down
9 changes: 9 additions & 0 deletions python/private/pypi/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,15 @@ bzl_library(
],
)

bzl_library(
name = "whl_package_metadata",
srcs = ["whl_package_metadata.bzl"],
deps = [
"@package_metadata//purl:srcs",
"@package_metadata//rules:srcs",
],
)

bzl_library(
name = "argparse",
srcs = ["argparse.bzl"],
Expand Down
22 changes: 12 additions & 10 deletions python/private/pypi/generate_whl_library_build_bazel.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,9 @@ package(default_visibility = ["//visibility:public"])
)
"""

_PURL = """\
package_metadata(
name = "package_metadata",
purl = {purl},
visibility = ["//:__subpackages__"],
_PACKAGE_METADATA = """\
whl_package_metadata(
{kwargs}
)
"""

Expand All @@ -66,7 +64,8 @@ def generate_whl_library_build_bazel(
metadata_version: The version to use for tag generation.
annotation: The annotation for the build file.
config_load: {type}`str` The location from where to load the config.
purl: The purl.
purl: {type}`dict[str, str] | None` The fields of the PyPI PURL passed
to {obj}`whl_package_metadata`.
requires_dist: {type}`list[str]` The list of dependencies from the METADATA file.
**kwargs: Extra args serialized to be passed to the
{obj}`whl_library_targets`.
Expand All @@ -75,9 +74,7 @@ def generate_whl_library_build_bazel(
A complete BUILD file as a string
"""

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

if kwargs.get("repo"):
fn = "whl_library_deps_targets"
Expand All @@ -103,6 +100,8 @@ def generate_whl_library_build_bazel(
loads.extend([
"""load("@rules_python//python/private/pypi:{}.bzl", "{}")""".format(fn, fn),
])
if purl:
loads.append("""load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata")""")

additional_content = []
if annotation:
Expand All @@ -124,7 +123,10 @@ def generate_whl_library_build_bazel(
for k, v in sorted(kwargs.items())
])),
),
] + ([_PURL.format(purl = repr(purl))] if purl else []) + additional_content,
] + ([_PACKAGE_METADATA.format(kwargs = render.indent("\n".join([
"{} = {},".format(k, repr(v))
for k, v in sorted(purl.items())
])))] if purl else []) + additional_content,
)

# NOTE: Ensure that we terminate with a new line
Expand Down
18 changes: 11 additions & 7 deletions python/private/pypi/patch_and_extract_whl.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,25 @@ def _move_scripts_needing_shebang_rewrite(rctx, entry_points):

def _to_purl(*, index, metadata, filename):
"""
Produce a PyPI PURL from the metadata.
Return the fields of the PyPI PURL from the metadata.

The PURL is built in the generated BUILD file, so that `@package_metadata`
is not loaded by the repository rules.

https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md
"""

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

qualifiers = {}
purl = {
"distribution": normalize_name(metadata.name).replace("_", "-"),
"version": metadata.version,
}
if index:
qualifiers["repository_url"] = index
purl["repository_url"] = index
if filename:
qualifiers["file_name"] = filename
purl["file_name"] = filename

return "pkg:pypi/{}@{}?{}".format(name, metadata.version, "&".join(["{}={}".format(key, val) for key, val in qualifiers.items()]))
return purl

def _remove_files(rctx, *basenames):
paths = list(rctx.path(".").readdir())
Expand Down
39 changes: 39 additions & 0 deletions python/private/pypi/whl_package_metadata.bzl
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""The package metadata for the whl repositories.

This is loaded only by the generated `BUILD.bazel` files of the whl
repositories, so that the `@package_metadata` repository is not needed when
loading the repository rules, e.g. in `WORKSPACE`.
"""

load("@package_metadata//purl:purl.bzl", "purl")
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")

def whl_package_metadata(
*,
distribution,
version,
repository_url = None,
file_name = None,
name = "package_metadata"):
"""Create the `package_metadata` target with a PyPI PURL.

See https://github.com/package-url/purl-spec/blob/main/types-doc/pypi-definition.md

Args:
distribution: {type}`str` the normalized name of the distribution.
version: {type}`str` the version of the package.
repository_url: {type}`str | None` the index URL.
file_name: {type}`str | None` the name of the whl or sdist file.
name: {type}`str` the name of the target.
"""
builder = purl.builder().type("pypi").name(distribution).version(version)
if repository_url:
builder.add_qualifier("repository_url", repository_url)
if file_name:
builder.add_qualifier("file_name", file_name)

package_metadata(
name = name,
purl = builder.build(),
visibility = ["//:__subpackages__"],
)
3 changes: 2 additions & 1 deletion tests/integration/bzlmod_lockfile/MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/integration/whl_library/MODULE.bazel
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module(name = "integration_test")

bazel_dep(name = "package_metadata", version = "0.0.7")
bazel_dep(name = "package_metadata", version = "0.0.13")
bazel_dep(name = "rules_python", version = "0.0.0")
local_path_override(
module_name = "rules_python",
Expand Down
4 changes: 4 additions & 0 deletions tests/integration/whl_library/test_contents.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ def test_whl_deps_ar_the_same(self):
"@whl_archive//:site-packages/requests/structures.py",
"@whl_archive//:site-packages/requests/utils.py",
"@whl_archive//:srcs",
"@package_metadata//licenses/spdx:Apache-2.0",
"@rules_python//:LICENSE",
"@rules_python//:license",
"@rules_python//:package_metadata",
"@rules_python//python:none",
"@rules_python//python/config_settings:_is_venvs_site_packages_yes",
"@rules_python//python/config_settings:add_srcs_to_runfiles",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ _tests = []

def _test_all_workspace(env):
want = """\
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")
load("@pypi//:config.bzl", "packages")
load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets")
load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata")

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

Expand Down Expand Up @@ -61,10 +61,10 @@ whl_library_targets(
],
)

package_metadata(
name = "package_metadata",
purl = "foo",
visibility = ["//:__subpackages__"],
whl_package_metadata(
distribution = "foo",
file_name = "foo.whl",
version = "0",
)

# SOMETHING SPECIAL AT THE END
Expand All @@ -87,17 +87,17 @@ package_metadata(
config_load = "@pypi//:config.bzl",
group_name = "qux",
group_deps = ["foo", "fox", "qux"],
purl = "foo",
purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"},
)
env.expect.that_str(actual.replace("@@", "@")).equals(want)

_tests.append(_test_all_workspace)

def _test_all(env):
want = """\
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")
load("@pypi//:config.bzl", "packages")
load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets")
load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata")

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

Expand Down Expand Up @@ -135,10 +135,10 @@ whl_library_targets(
],
)

package_metadata(
name = "package_metadata",
purl = "foo",
visibility = ["//:__subpackages__"],
whl_package_metadata(
distribution = "foo",
file_name = "foo.whl",
version = "0",
)

# SOMETHING SPECIAL AT THE END
Expand All @@ -160,7 +160,7 @@ package_metadata(
),
config_load = "@pypi//:config.bzl",
group_name = "qux",
purl = "foo",
purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"},
group_deps = ["foo", "fox", "qux"],
)
env.expect.that_str(actual.replace("@@", "@")).equals(want)
Expand All @@ -169,9 +169,9 @@ _tests.append(_test_all)

def _test_all_with_loads(env):
want = """\
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")
load("@pypi//:config.bzl", "packages")
load("@rules_python//python/private/pypi:whl_library_targets.bzl", "whl_library_targets")
load("@rules_python//python/private/pypi:whl_package_metadata.bzl", "whl_package_metadata")

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

Expand Down Expand Up @@ -209,10 +209,10 @@ whl_library_targets(
],
)

package_metadata(
name = "package_metadata",
purl = "foo",
visibility = ["//:__subpackages__"],
whl_package_metadata(
distribution = "foo",
file_name = "foo.whl",
version = "0",
)

# SOMETHING SPECIAL AT THE END
Expand All @@ -235,15 +235,14 @@ package_metadata(
group_name = "qux",
config_load = "@pypi//:config.bzl",
group_deps = ["foo", "fox", "qux"],
purl = "foo",
purl = {"distribution": "foo", "file_name": "foo.whl", "version": "0"},
)
env.expect.that_str(actual.replace("@@", "@")).equals(want)

_tests.append(_test_all_with_loads)

def _test_deps_targets(env):
want = """\
load("@package_metadata//rules:package_metadata.bzl", "package_metadata")
load("@rules_python//python/private/pypi:whl_library_deps_targets.bzl", "whl_library_deps_targets")

package(default_visibility = ["//visibility:public"])
Expand Down
5 changes: 5 additions & 0 deletions tests/pypi/whl_package_metadata/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
load(":whl_package_metadata_tests.bzl", "whl_package_metadata_test_suite")

whl_package_metadata_test_suite(
name = "whl_package_metadata_tests",
)
Loading