add support for module import prefix on Python compiler

[chrisirhc]

Problem

When generating code in monorepos, some generated code is used with a prefix path, see https://rules-proto-grpc.com/en/latest/lang/python.html .
However, when a prefix_path is used, the generated proto import paths are no longer valid unless the module imports are also prefixed similarly.
This adds an option to support adding an import prefix to the printed imports.

Approach

This follows a similar approach already in use in the objectivec compiler.

How did I validate the approach?

I ran some basic manual tests like the following and validated that the module prefix was added to imports:

bazel run //src/google/protobuf/compiler:protoc -- --python_out=module_
import_prefix=test.prefix,pyi_out:$(PWD) <path to local repo clone>/csharp/compatibility_tests/v3.0.0/protos/src/google/protobuf/unittest_import_p
roto3.proto --proto_path=<path to local repo clone>/csharp/compatibility_tests/v3.0.0/protos/src

The diff when comparing with and without the module_import_prefix=test.prefix parameter:

diff --color=auto -r a/google/protobuf/unittest_import_proto3_pb2.py b/google/protobuf/unittest_import_proto3_pb2.py
25c25
< from google.protobuf import unittest_import_public_proto3_pb2 as google_dot_protobuf_dot_unittest__import__public__proto3__pb2
---
> from test.prefix.google.protobuf import unittest_import_public_proto3_pb2 as google_dot_protobuf_dot_unittest__import__public__proto3__pb2
27c27
< from google.protobuf.unittest_import_public_proto3_pb2 import *
---
> from test.prefix.google.protobuf.unittest_import_public_proto3_pb2 import *
Only in b/google/protobuf: unittest_import_proto3_pb2.pyi

Remaining TODOs

• Add a test for this feature
• Make sure this feature works with pyi generation

I couldn't find tests for parameter behavior. plugin_unittest, https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/compiler/python/plugin_unittest.cc doesn't test much of the plugin logic.
I would appreciate some guidance in how to add a test for this feature (or if a test is needed).

Related Issues

• Python: support for optional python_package (or similar) to make import explicit #7061

[github-actions]

We triage inactive PRs and issues in order to make it easier to find active work. If this PR should remain active, please add a comment.

This PR is labeled inactive because the last activity was over 90 days ago. This PR will be closed and archived after 14 additional days without activity.

[github-actions]

We triage inactive PRs and issues in order to make it easier to find active work. If this PR should remain active, please add a comment.

This PR is labeled inactive because the last activity was over 90 days ago. This PR will be closed and archived after 14 additional days without activity.

[github-actions]

We triage inactive PRs and issues in order to make it easier to find active work. If this PR should remain active or becomes active again, please reopen it.

This PR was closed and archived because there has been no new activity in the 14 days since the inactive label was added.