[SPARK-40796][CONNECT][FOLLOW-UP] Improve README for proto generated files in Connect Python client #38335
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
python/pyspark/sql/connect/README.md
Outdated
| ``` | ||
|
|
||
| ## Generate proto generated files for the Python client | ||
| 1. Install `buf`: https://docs.buf.build/installation |
Contributor
There was a problem hiding this comment.
I think we also need to mention the related python packages:
grpcio==1.48.1
protobuf==4.21.6
mypy-protobuf==3.3.0
Contributor
There was a problem hiding this comment.
buf's version in CI is 1.8.0, the latest one is 1.9.0. I think we also need to mention the version
Contributor
Author
There was a problem hiding this comment.
makes sense. I updated this doc with versions.
Contributor
|
merged into master, thank you @amaliujia |
| ## Generate proto generated files for the Python client | ||
| 1. Install `buf`: https://docs.buf.build/installation | ||
| 2. Run `pip install grpcio==1.48.1 protobuf==4.21.6 mypy-protobuf==3.3.0` | ||
| 3. Run `./dev/generate_protos.sh` |
Contributor
There was a problem hiding this comment.
oops, should be ./connector/connect/dev/generate_protos.sh
Contributor
Author
There was a problem hiding this comment.
oops I copied this from my local command which is not under the spark repo root directory.
@zhengruifeng maybe you can BTW update it in the PR that you pin dependency versions?
SandishKumarHN
pushed a commit
to SandishKumarHN/spark
that referenced
this pull request
Dec 12, 2022
…files in Connect Python client ### What changes were proposed in this pull request? 1. Improve README for how to install `buf` dependency and then run the proto generated file script. 2. Improve the message for out-of-sync check script. ### Why are the changes needed? Improve developer experience either when touching Connect proto files or not touch those files but having master branch out of sync with local branch. ### Does this PR introduce _any_ user-facing change? No ### How was this patch tested? Existing checks. Closes apache#38335 from amaliujia/python_generate_buf_read_me. Authored-by: Rui Wang <[email protected]> Signed-off-by: Ruifeng Zheng <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
bufdependency and then run the proto generated file script.Why are the changes needed?
Improve developer experience either when touching Connect proto files or not touch those files but having master branch out of sync with local branch.
Does this PR introduce any user-facing change?
No
How was this patch tested?
Existing checks.