Implement py_proto_library#832

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

Merged
rickeylev merged 4 commits into from
Jan 18, 2023
Merged

Implement py_proto_library #832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7126c7
Add py_proto_library
comius Dec 5, 2022
4ab5a5d
Bump versions of rules_proto and protobuf
comius Dec 30, 2022
7d812e0
Update documentation
comius Dec 30, 2022
f0acb6f
Bump rules_pkg version
comius Dec 30, 2022
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
4 changes: 4 additions & 0 deletions MODULE.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down
27 changes: 24 additions & 3 deletions internal_deps.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
http_archive,
name = "rules_pkg",
urls = [
"https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
"https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
"https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
"https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
],
sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
)

maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
)

maybe(
http_archive,
name = "rules_proto",
sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
strip_prefix = "rules_proto-5.3.0-21.7",
urls = [
"https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
],
)

maybe(
http_archive,
name = "com_google_protobuf",
sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
strip_prefix = "protobuf-21.7",
urls = [
"https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
"https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
],
)
7 changes: 7 additions & 0 deletions internal_setup.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
go_register_toolchains(version = "1.19.2")

gazelle_dependencies()

rules_proto_dependencies()
rules_proto_toolchains()

protobuf_deps()
2 changes: 1 addition & 1 deletion python/private/BUILD.bazel
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
name = "distribution",
srcs = glob(["**"]),
srcs = glob(["**"]) + ["//python/private/proto:distribution"],
visibility = ["//python:__pkg__"],
)

Expand Down
32 changes: 32 additions & 0 deletions python/private/proto/BUILD
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
name = "distribution",
srcs = glob(["**"]),
visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
name = "python_toolchain",
command_line = "--python_out=%s",
progress_message = "Generating Python proto_library %{label}",
runtime = "@com_google_protobuf//:protobuf_python",
)
191 changes: 191 additions & 0 deletions python/private/proto/py_proto_library.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
doc = "Encapsulates information needed by the Python proto rules.",
fields = {
"runfiles_from_proto_deps": """
(depset[File]) Files from the transitive closure implicit proto
dependencies""",
"transitive_sources": """(depset[File]) The Python sources.""",
},
)

def _filter_provider(provider, *attrs):
return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
"""Generates and compiles Python code for a proto_library.

The function runs protobuf compiler on the `proto_library` target generating
a .py file for each .proto file.

Args:
target: (Target) A target providing `ProtoInfo`. Usually this means a
`proto_library` target, but not always; you must expect to visit
non-`proto_library` targets, too.
ctx: (RuleContext) The rule context.

Returns:
([_PyProtoInfo]) Providers collecting transitive information about
generated files.
"""

_proto_library = ctx.rule.attr

# Check Proto file names
for proto in target[ProtoInfo].direct_sources:
if proto.is_source and "-" in proto.dirname:
fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
proto.path,
))

proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
api_deps = [proto_lang_toolchain_info.runtime]

generated_sources = []
proto_info = target[ProtoInfo]
if proto_info.direct_sources:
# Generate py files
generated_sources = proto_common.declare_generated_files(
actions = ctx.actions,
proto_info = proto_info,
extension = "_pb2.py",
name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
)

proto_common.compile(
actions = ctx.actions,
proto_info = proto_info,
proto_lang_toolchain_info = proto_lang_toolchain_info,
generated_files = generated_sources,
plugin_output = ctx.bin_dir.path,
)

# Generated sources == Python sources
python_sources = generated_sources

deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
runfiles_from_proto_deps = depset(
transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
[dep.runfiles_from_proto_deps for dep in deps],
)
transitive_sources = depset(
direct = python_sources,
transitive = [dep.transitive_sources for dep in deps],
)

return [
_PyProtoInfo(
runfiles_from_proto_deps = runfiles_from_proto_deps,
transitive_sources = transitive_sources,
),
]

_py_proto_aspect = aspect(
implementation = _py_proto_aspect_impl,
attrs = {
"_aspect_proto_toolchain": attr.label(
default = ":python_toolchain",
),
},
attr_aspects = ["deps"],
required_providers = [ProtoInfo],
provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
"""Merges results of `py_proto_aspect` in `deps`.

Args:
ctx: (RuleContext) The rule context.
Returns:
([PyInfo, DefaultInfo, OutputGroupInfo])
"""
if not ctx.attr.deps:
fail("'deps' attribute mustn't be empty.")

pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
default_outputs = depset(
transitive = [info.transitive_sources for info in pyproto_infos],
)

return [
DefaultInfo(
files = default_outputs,
default_runfiles = ctx.runfiles(transitive_files = depset(
transitive =
[default_outputs] +
[info.runfiles_from_proto_deps for info in pyproto_infos],
)),
),
OutputGroupInfo(
default = depset(),
),
PyInfo(
transitive_sources = default_outputs,
# Proto always produces 2- and 3- compatible source files
has_py2_only_sources = False,
has_py3_only_sources = False,
),
]

py_proto_library = rule(
implementation = _py_proto_library_rule,
doc = """
Use `py_proto_library` to generate Python libraries from `.proto` files.

The convention is to name the `py_proto_library` rule `foo_py_pb2`,
when it is wrapping `proto_library` rule `foo_proto`.

`deps` must point to a `proto_library` rule.

Example:

```starlark
py_library(
name = "lib",
deps = [":foo_py_pb2"],
)

py_proto_library(
name = "foo_py_pb2",
deps = [":foo_proto"],
)

proto_library(
name = "foo_proto",
srcs = ["foo.proto"],
)
```""",
attrs = {
"deps": attr.label_list(
doc = """
The list of `proto_library` rules to generate Python libraries for.

Usually this is just the one target: the proto library of interest.
It can be any target providing `ProtoInfo`.""",
providers = [ProtoInfo],
aspects = [_py_proto_aspect],
),
},
provides = [PyInfo],
)
21 changes: 21 additions & 0 deletions python/proto.bzl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Implement py_proto_library#832

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

 Merged

rickeylev
merged 4 commits into

from

Jan 18, 2023
 Merged


Implement py_proto_library
#832
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
c7126c7

Add py_proto_library


comius Dec 5, 2022
4ab5a5d

Bump versions of rules_proto and protobuf


comius Dec 30, 2022
7d812e0

Update documentation


comius Dec 30, 2022
f0acb6f

Bump rules_pkg version


comius Dec 30, 2022

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


4 changes: 4 additions & 0 deletions
MODULE.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,10 @@ module(

bazel_dep(name = "platforms", version = "0.0.4")

# Those are loaded only when using py_proto_library
bazel_dep(name = "rules_proto", version = "5.3.0-21.7")
bazel_dep(name = "protobuf", repo_name = "com_google_protobuf", version = "21.7")

internal_deps = use_extension("@rules_python//python:extensions.bzl", "internal_deps")

internal_deps.install()
Expand Down

2 changes: 1 addition & 1 deletion
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@
## Overview

This repository is the home of the core Python rules -- `py_library`,
`py_binary`, `py_test`, and related symbols that provide the basis for Python
`py_binary`, `py_test`, `py_proto_library`, and related symbols that provide the basis for Python
support in Bazel. It also contains package installation rules for integrating with PyPI and other package indices. Documentation lives in the
[`docs/`](https://github.com/bazelbuild/rules_python/tree/main/docs)
directory and in the
Expand Down

27 changes: 24 additions & 3 deletions
internal_deps.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,10 +20,10 @@ def rules_python_internal_deps():
 http_archive,
 name = "rules_pkg",
 urls = [
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.2.4/rules_pkg-0.2.4.tar.gz",
 "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 "https://github.com/bazelbuild/rules_pkg/releases/download/0.7.0/rules_pkg-0.7.0.tar.gz",
 ],
 sha256 = "4ba8f4ab0ff85f2484287ab06c0d871dcb31cc54d439457d28fd4ae14b18450a",
 sha256 = "8a298e832762eda1830597d64fe7db58178aa84cd5926d76d5b744d6558941c2",
 )

 maybe(
Expand DownExpand Up@@ -124,3 +124,24 @@ def rules_python_internal_deps():
 strip_prefix = "bazel-integration-testing-165440b2dbda885f8d1ccb8d0f417e6cf8c54f17",
 sha256 = "2401b1369ef44cc42f91dc94443ef491208dbd06da1e1e10b702d8c189f098e3",
 )

 maybe(
 http_archive,
 name = "rules_proto",
 sha256 = "dc3fb206a2cb3441b485eb1e423165b231235a1ea9b031b4433cf7bc1fa460dd",
 strip_prefix = "rules_proto-5.3.0-21.7",
 urls = [
 "https://github.com/bazelbuild/rules_proto/archive/refs/tags/5.3.0-21.7.tar.gz",
 ],
 )

 maybe(
 http_archive,
 name = "com_google_protobuf",
 sha256 = "75be42bd736f4df6d702a0e4e4d30de9ee40eac024c4b845d17ae4cc831fe4ae",
 strip_prefix = "protobuf-21.7",
 urls = [
 "https://mirror.bazel.build/github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 "https://github.com/protocolbuffers/protobuf/archive/v21.7.tar.gz",
 ],
 )

7 changes: 7 additions & 0 deletions
internal_setup.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,9 @@
load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
load("@build_bazel_integration_testing//tools:repositories.bzl", "bazel_binaries")
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
load("@rules_proto//proto:repositories.bzl", "rules_proto_dependencies", "rules_proto_toolchains")
load("//:version.bzl", "SUPPORTED_BAZEL_VERSIONS")
load("//gazelle:deps.bzl", _go_repositories = "gazelle_deps")
load("//python/pip_install:repositories.bzl", "pip_install_dependencies")
Expand DownExpand Up@@ -48,3 +50,8 @@ def rules_python_internal_setup():
 go_register_toolchains(version = "1.19.2")

 gazelle_dependencies()

 rules_proto_dependencies()
 rules_proto_toolchains()

 protobuf_deps()

2 changes: 1 addition & 1 deletion
python/private/BUILD.bazel

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,7 +19,7 @@ licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 srcs = glob(["**"]) + ["//python/private/proto:distribution"],
 visibility = ["//python:__pkg__"],
)

Expand Down

32 changes: 32 additions & 0 deletions
python/private/proto/BUILD

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
# Copyright 2022 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.

load("@rules_proto//proto:defs.bzl", "proto_lang_toolchain")

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

licenses(["notice"]) # Apache 2.0

filegroup(
 name = "distribution",
 srcs = glob(["**"]),
 visibility = ["//python/private:__pkg__"],
)

proto_lang_toolchain(
 name = "python_toolchain",
 command_line = "--python_out=%s",
 progress_message = "Generating Python proto_library %{label}",
 runtime = "@com_google_protobuf//:protobuf_python",
)

191 changes: 191 additions & 0 deletions
python/private/proto/py_proto_library.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
# Copyright 2022 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.

"""The implementation of the `py_proto_library` rule and its aspect."""

load("@rules_proto//proto:defs.bzl", "ProtoInfo", "proto_common")
load("//python:defs.bzl", "PyInfo")

ProtoLangToolchainInfo = proto_common.ProtoLangToolchainInfo

_PyProtoInfo = provider(
 doc = "Encapsulates information needed by the Python proto rules.",
 fields = {
 "runfiles_from_proto_deps": """
 (depset[File]) Files from the transitive closure implicit proto
 dependencies""",
 "transitive_sources": """(depset[File]) The Python sources.""",
 },
)

def _filter_provider(provider, *attrs):
 return [dep[provider] for attr in attrs for dep in attr if provider in dep]

def _py_proto_aspect_impl(target, ctx):
 """Generates and compiles Python code for a proto_library.

 The function runs protobuf compiler on the `proto_library` target generating
 a .py file for each .proto file.

 Args:
 target: (Target) A target providing `ProtoInfo`. Usually this means a
 `proto_library` target, but not always; you must expect to visit
 non-`proto_library` targets, too.
 ctx: (RuleContext) The rule context.

 Returns:
 ([_PyProtoInfo]) Providers collecting transitive information about
 generated files.
 """

 _proto_library = ctx.rule.attr

 # Check Proto file names
 for proto in target[ProtoInfo].direct_sources:
 if proto.is_source and "-" in proto.dirname:
 fail("Cannot generate Python code for a .proto whose path contains '-' ({}).".format(
 proto.path,
 ))

 proto_lang_toolchain_info = ctx.attr._aspect_proto_toolchain[ProtoLangToolchainInfo]
 api_deps = [proto_lang_toolchain_info.runtime]

 generated_sources = []
 proto_info = target[ProtoInfo]
 if proto_info.direct_sources:
 # Generate py files
 generated_sources = proto_common.declare_generated_files(
 actions = ctx.actions,
 proto_info = proto_info,
 extension = "_pb2.py",
 name_mapper = lambda name: name.replace("-", "_").replace(".", "/"),
 )

 proto_common.compile(
 actions = ctx.actions,
 proto_info = proto_info,
 proto_lang_toolchain_info = proto_lang_toolchain_info,
 generated_files = generated_sources,
 plugin_output = ctx.bin_dir.path,
 )

 # Generated sources == Python sources
 python_sources = generated_sources

 deps = _filter_provider(_PyProtoInfo, getattr(_proto_library, "deps", []))
 runfiles_from_proto_deps = depset(
 transitive = [dep[DefaultInfo].default_runfiles.files for dep in api_deps] +
 [dep.runfiles_from_proto_deps for dep in deps],
 )
 transitive_sources = depset(
 direct = python_sources,
 transitive = [dep.transitive_sources for dep in deps],
 )

 return [
 _PyProtoInfo(
 runfiles_from_proto_deps = runfiles_from_proto_deps,
 transitive_sources = transitive_sources,
 ),
 ]

_py_proto_aspect = aspect(
 implementation = _py_proto_aspect_impl,
 attrs = {
 "_aspect_proto_toolchain": attr.label(
 default = ":python_toolchain",
 ),
 },
 attr_aspects = ["deps"],
 required_providers = [ProtoInfo],
 provides = [_PyProtoInfo],
)

def _py_proto_library_rule(ctx):
 """Merges results of `py_proto_aspect` in `deps`.

 Args:
 ctx: (RuleContext) The rule context.
 Returns:
 ([PyInfo, DefaultInfo, OutputGroupInfo])
 """
 if not ctx.attr.deps:
 fail("'deps' attribute mustn't be empty.")

 pyproto_infos = _filter_provider(_PyProtoInfo, ctx.attr.deps)
 default_outputs = depset(
 transitive = [info.transitive_sources for info in pyproto_infos],
 )

 return [
 DefaultInfo(
 files = default_outputs,
 default_runfiles = ctx.runfiles(transitive_files = depset(
 transitive =
 [default_outputs] +
 [info.runfiles_from_proto_deps for info in pyproto_infos],
 )),
 ),
 OutputGroupInfo(
 default = depset(),
 ),
 PyInfo(
 transitive_sources = default_outputs,
 # Proto always produces 2- and 3- compatible source files
 has_py2_only_sources = False,
 has_py3_only_sources = False,
 ),
 ]

py_proto_library = rule(
 implementation = _py_proto_library_rule,
 doc = """
 Use `py_proto_library` to generate Python libraries from `.proto` files.

 The convention is to name the `py_proto_library` rule `foo_py_pb2`,
 when it is wrapping `proto_library` rule `foo_proto`.

 `deps` must point to a `proto_library` rule.

 Example:

```starlark
py_library(
 name = "lib",
 deps = [":foo_py_pb2"],
)

py_proto_library(
 name = "foo_py_pb2",
 deps = [":foo_proto"],
)

proto_library(
 name = "foo_proto",
 srcs = ["foo.proto"],
)
```""",
 attrs = {
 "deps": attr.label_list(
 doc = """
 The list of `proto_library` rules to generate Python libraries for.

 Usually this is just the one target: the proto library of interest.
 It can be any target providing `ProtoInfo`.""",
 providers = [ProtoInfo],
 aspects = [_py_proto_aspect],
 ),
 },
 provides = [PyInfo],
)

21 changes: 21 additions & 0 deletions
python/proto.bzl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
# Copyright 2022 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.

"""
Python proto library.
"""

load("//python/private/proto:py_proto_library.bzl", _py_proto_library = "py_proto_library")

py_proto_library = _py_proto_library