gh-137899: Enhance shelve serializer validation with descriptive error messages #138768
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
furkanonder
added
type-feature
picnixz
reviewed
Sep 10, 2025
| self.deserializer = deserializer | ||
|
|
||
| @staticmethod | ||
| def _validate_serialized_value(serialized_value, original_value): |
There was a problem hiding this comment.
Validation is also at the level of the C extension (in dbmmodule.c) so you should also change the message out there.
aisk
reviewed
Sep 11, 2025
| else: | ||
| invalid_type = type(serialized_value).__name__ | ||
| msg = (f"Serializer returned {invalid_type} for value " | ||
| f"{original_value!r} But database values must be " |
There was a problem hiding this comment.
Nitpick, 'But' should be lowercase unless it follows a period:
Suggested change
| f"{original_value!r} But database values must be " | |
| f"{original_value!r}, but database values must be " |
Adding a period before it is another option.
furkanonder
requested review from
corona10,
erlend-aasland and
serhiy-storchaka
as code owners
|
I've sent some suggestions as a PR to your branch: furkanonder#3 |
Comment on lines
+117
to
+119
| msg = (f"Serializer returned {invalid_type} for value " | ||
| f"{original_value!r} But database values must be " | ||
| f"bytes or str, not {invalid_type}") |
There was a problem hiding this comment.
invalid_type is repeated twice. This is unnecessary.
The repr of original_value can be very large, it should not be included in the error message. Error most likely does not depend on the original value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
shelvedatum #137899