chore: pin grpcio-tools to backwards-compatible version, bump min version of grpcio to 1.65.0 #272
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
!3.13 is not future proof
There was a problem hiding this comment.
Pull Request Overview
This PR resolves critical compatibility issues between grpcio and grpcio-tools by pinning grpcio-tools to version 1.65.x and bumping the minimum grpcio version to 1.65.0. This ensures backward compatibility while avoiding runtime errors from version mismatches, particularly for users with older grpcio installations.
- Updated minimum grpcio version from 1.56.0 to 1.65.0 to avoid compilation issues on modern systems
- Pinned grpcio-tools to 1.65.x (with conditional 1.66.2+ for Python 3.13+) to prevent compatibility conflicts
- Added Python version checks to prevent generating incompatible protobufs with newer grpcio-tools versions
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updated grpcio minimum version and added conditional grpcio-tools pinning based on Python version |
| scripts/protogen.py | Added Python 3.13+ compatibility check to prevent incompatible protobuf generation |
| pydgraph/proto/api_pb2_grpc.py | Updated generated code to use warnings instead of errors for version mismatches |
| pydgraph/proto/api_pb2.py | Regenerated protobuf code with older grpcio-tools version for compatibility |
| pydgraph/meta.py | Bumped version to 24.3.0 |
| README.md | Added comprehensive documentation about grpcio version requirements and protobuf regeneration |
| CHANGELOG.md | Added changelog entry for version 24.3.0 |
| .github/workflows/ci-pydgraph-tests.yml | Moved dgraph setup after protobuf verification and added Python version conditions |
Co-authored-by: Copilot <[email protected]>
Closed
4 tasks
|
@mattjohnsonpint Can you please have a look? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR resolves critical compatibility issues with grpcio-tools that were causing runtime errors for users with older grpcio versions. The changes ensure backward compatibility while providing a modern development experience.
The minimum version of grpcio is updated to 1.65.0 which is the last version that did not force runtime errors when detected grpcio versions were mismatched. grpcio versions older than ~1.60.0 fail to compile from source on modern systems (macOS with recent Xcode, newer Linux distributions) due to C++ compiler compatibility issues and outdated build configurations. This PR has generating grpc code targeting 1.65.5, which includes two security patches relevant to the 1.6x.x APIs:
This PR extends the flexibility that was added in #222 and #233.
The python script that generates protos (scripts/protogen.py) will fail if python 3.13 or higher is used (python 3.13 requires a later, incompatible grpcio)
Checklist
CHANGELOG.mdfile describing and linking tothis PR