docs: add upgrade note for broken google imports - #341
Open
ivanauth wants to merge 1 commit into
Open
Conversation
Wheels for v1.23.0 through v1.24.3 vendored modules under the google namespace at the same paths owned by googleapis-common-protos, so uninstalling those versions during an upgrade deletes files that googleapis-common-protos needs and imports like google.api.annotations_pb2 start failing. Document how to restore the missing files. Signed-off-by: ivanauth <ivan@authzed.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #329
Wheels v1.22.2rc1/rc2 and v1.23.0-v1.24.3 vendored
google.apifiles owned bygoogleapis-common-protos; upgrading past one of them makes pip delete those shared files on uninstall, breakingfrom google.api import annotations_pb2.The packaging bug was fixed in v1.24.4 (#327), but since pip deletes the files before any new code runs, no future release can repair an already-broken install - hence this README note with recovery commands.