gh-122311: Improve and unify pickle errors #122771
Merged
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
* Raise PicklingError instead of UnicodeEncodeError, ValueError and AttributeError in both implementations. * Chain the original exception to the pickle-specific one as __context__. * Include the error message of ImportError and some AttributeError in the PicklingError error message. * Unify error messages between Python and C implementations. * Refer to documented __reduce__ and __newobj__ callables instead of internal methods (e.g. save_reduce()) or pickle opcodes (e.g. NEWOBJ). * Include more details in error messages (what expected, what got). * Avoid including a potentially long repr of an arbitrary object in error messages.
554abbc to
43d94f2
Compare
AA-Turner
reviewed
Aug 7, 2024
|
|
||
| try: | ||
| __import__(module_name, level=0) | ||
| module = sys.modules[module_name] | ||
| except (ImportError, ValueError, KeyError) as exc: | ||
| raise PicklingError(f"Can't pickle {obj!r}: {exc!s}") |
There was a problem hiding this comment.
Should we do from None or from exc here (and in the other cases below?)
There was a problem hiding this comment.
No, removing from None was intentional. Error here is not normal. The original exception and its traceback can add additional context.
We use from None if the details of the original exception are not important. For example when it is a result of using EAFP instead of LBYL. But in this case we expect that the object can be found by name, and if this fails, we want to know gore details.
|
If there are no objections, I am planning to marge this PR in few days. |
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.
__context__.__reduce__and__newobj__callables instead of internal methods (e.g. save_reduce()) or pickle opcodes (e.g. NEWOBJ).