Generate .pyi files in py_proto_library (#10366) #21567
Conversation
We here adjust py_proto_library to produce `.pyi` files along with the `.py` files it already generates. This achieves the same effect as the gRPC py_proto_library. Closes protocolbuffers#10366.
|
+1; with |
anandolee
added
the
🅰️ safe for tests
github-actions
bot
removed
the
🅰️ safe for tests
|
@anandolee Thanks for adding the tag! It looks like my PR passes CI, so I look forward to your review. |
mkruskal-google
added
python
bazel
🅰️ safe for tests
github-actions
bot
removed
the
🅰️ safe for tests
| ) | ||
|
|
||
| # Generated sources == Python sources | ||
| python_sources = generated_sources | ||
| python_sources = generated_sources + generated_stubs |
There was a problem hiding this comment.
We discussed this with some python folks, and while we agree this PR looks like a good approach, it needs a few tweaks. Specifically, the pyi files should end up in the new direct_pyi_files/transitive_pyi_files fields of PyInfo added in rules_python 1.1, instead of getting globbed together into transitive_sources with the py files like is currently happening
I think this is just a matter of piping the information through _PyProtoInfo, and should be a relatively minor tweak to your PR though
There was a problem hiding this comment.
@mkruskal-google Thank you for your feedback. At present, it looks like protobuf requires rules_python 1.0.0 in MODULE.bazel and protobuf_deps.bzl Are you asking for me to bump that to rules_python 1.1.0 as part of this PR or possibly a separate PR? Or should I attempt to be compatible with rules_python 1.0.0 but take advantage of the new PyInfo fields if they are available?
There was a problem hiding this comment.
Those are the two options :). I think bumping to 1.1 should be fine as it's a minor version release, and it would be a lot easier. We could go the extra mile to support 1.0.0 by checking for the presence of the new fields, but I don't think it's necessary here
We here adjust py_proto_library to produce
.pyifiles along with the.pyfiles it already generates. This achieves the same effect as the gRPC py_proto_library.Closes #10366.