Skip to content

fix: allowing to import code generated from proto with strip_import_prefix #1406

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
aignas merged 10 commits into from
Oct 12, 2023
Merged

fix: allowing to import code generated from proto with strip_import_prefix #1406

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f868464
allowing to import code generated from proto
linzhp Sep 8, 2023
a6bbc28
buildifier
linzhp Sep 8, 2023
1499704
reuse examples
linzhp Sep 15, 2023
a573d8a
exclude examples from tests, buildifier
linzhp Sep 15, 2023
fbd9ba9
comments
linzhp Sep 24, 2023
6a3714c
adding test_output back
linzhp Sep 24, 2023
e5c34c6
run: 'pre-commit run update-deleted-packages -a'
aignas Sep 25, 2023
b2bfab2
Merge pull request #1 from aignas/proto-comments
linzhp Oct 11, 2023
baead2e
Merge branch 'main' into proto
linzhp Oct 11, 2023
6f08c9e
changelog
linzhp Oct 11, 2023
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: 2 additions & 2 deletions .bazelrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# This lets us glob() up all the files inside the examples to make them inputs to tests
# (Note, we cannot use `common --deleted_packages` because the bazel version command doesn't support it)
# To update these lines, run tools/bazel_integration_test/update_deleted_packages.sh
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_repository_entry_points
build --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/proto,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_repository_entry_points
query --deleted_packages=examples/build_file_generation,examples/build_file_generation/random_number_generator,examples/bzlmod,examples/bzlmod_build_file_generation,examples/bzlmod_build_file_generation/other_module/other_module/pkg,examples/bzlmod_build_file_generation/runfiles,examples/bzlmod/entry_points,examples/bzlmod/entry_points/tests,examples/bzlmod/libs/my_lib,examples/bzlmod/other_module,examples/bzlmod/other_module/other_module/pkg,examples/bzlmod/runfiles,examples/bzlmod/tests,examples/bzlmod/tests/other_module,examples/bzlmod/whl_mods,examples/multi_python_versions/libs/my_lib,examples/multi_python_versions/requirements,examples/multi_python_versions/tests,examples/pip_install,examples/pip_parse,examples/pip_parse_vendored,examples/pip_repository_annotations,examples/py_proto_library,examples/py_proto_library/example.com/proto,tests/compile_pip_requirements,tests/compile_pip_requirements_test_from_external_workspace,tests/ignore_root_user_error,tests/pip_repository_entry_points

test --test_output=errors

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ A brief description of the categories of changes:
* Skip aliases for unloaded toolchains. Some Python versions that don't have full
platform support, and referencing their undefined repositories can break operations
like `bazel query rdeps(...)`.
* Python code generated from `proto_library` with `strip_import_prefix` can be imported now.

## [0.26.0] - 2023-10-06

Expand Down
14 changes: 1 addition & 13 deletions examples/py_proto_library/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
load("@rules_proto//proto:defs.bzl", "proto_library")
load("@rules_python//python:defs.bzl", "py_test")
load("@rules_python//python:proto.bzl", "py_proto_library")

py_proto_library(
name = "pricetag_proto_py_pb2",
deps = [":pricetag_proto"],
)

proto_library(
name = "pricetag_proto",
srcs = ["pricetag.proto"],
)

py_test(
name = "pricetag_test",
srcs = ["test.py"],
main = "test.py",
deps = [
":pricetag_proto_py_pb2",
"//example.com/proto:pricetag_proto_py_pb2",
],
)
15 changes: 15 additions & 0 deletions examples/py_proto_library/example.com/proto/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
load("@rules_proto//proto:defs.bzl", "proto_library")
load("@rules_python//python:proto.bzl", "py_proto_library")

py_proto_library(
name = "pricetag_proto_py_pb2",
visibility = ["//visibility:public"],
deps = [":pricetag_proto"],
)

proto_library(
name = "pricetag_proto",
srcs = ["pricetag.proto"],
# https://bazel.build/reference/be/protocol-buffer#proto_library.strip_import_prefix
strip_import_prefix = "/example.com",
)
0 examples/py_proto_library/pricetag.proto → ..._library/example.com/proto/pricetag.proto
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/py_proto_library/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import sys
import unittest

import pricetag_pb2
from proto import pricetag_pb2


class TestCase(unittest.TestCase):
Expand Down
14 changes: 8 additions & 6 deletions python/private/proto/py_proto_library.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ def _py_proto_aspect_impl(target, ctx):

generated_sources = []
proto_info = target[ProtoInfo]
proto_root = proto_info.proto_source_root
if proto_info.direct_sources:
# Generate py files
generated_sources = proto_common.declare_generated_files(
Expand All @@ -76,14 +77,11 @@ def _py_proto_aspect_impl(target, ctx):
)

# Handles multiple repository and virtual import cases
proto_root = proto_info.proto_source_root
if proto_root.startswith(ctx.bin_dir.path):
plugin_output = proto_root
else:
plugin_output = ctx.bin_dir.path + "/" + proto_root
proto_root = proto_root[len(ctx.bin_dir.path) + 1:]

if plugin_output == ".":
plugin_output = ctx.bin_dir.path
plugin_output = ctx.bin_dir.path + "/" + proto_root
proto_root = ctx.workspace_name + "/" + proto_root

proto_common.compile(
actions = ctx.actions,
Expand All @@ -109,6 +107,10 @@ def _py_proto_aspect_impl(target, ctx):
return [
_PyProtoInfo(
imports = depset(
# Adding to PYTHONPATH so the generated modules can be imported.
# This is necessary when there is strip_import_prefix, the Python
# modules are generated under _virtual_imports.
[proto_root],
transitive = [dep[PyInfo].imports for dep in api_deps],
),
runfiles_from_proto_deps = runfiles_from_proto_deps,
Expand Down