Fix base64 encode/decode bug due to Pydantic issue #48
Conversation
This file contains 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
woodruffw
reviewed
Sep 19, 2024
Comment on lines
+37
to
+58
| class Base64EncoderSansNewline(Base64Encoder): | ||
| r"""A Base64Encoder that doesn't insert newlines when encoding. | ||
|
|
||
| Pydantic's Base64Bytes type inserts newlines b'\n' every 76 characters because they | ||
| use `base64.encodebytes()` instead of `base64.b64encode()`. Pydantic maintainers | ||
| have stated that they won't fix this, and that users should work around it by | ||
| defining their own Base64 type with a custom encoder. | ||
| See https://github.com/pydantic/pydantic/issues/9072 for more details. | ||
| """ | ||
|
|
||
| @classmethod | ||
| def encode(cls, value: bytes) -> bytes: | ||
| """Encode bytes to base64.""" | ||
| return base64.b64encode(value) | ||
|
|
||
| @classmethod | ||
| def decode(cls, value: bytes) -> bytes: | ||
| """Decode base64 bytes.""" | ||
| return base64.b64decode(value, validate=True) | ||
|
|
||
|
|
||
| Base64Bytes = Annotated[bytes, EncodedBytes(encoder=Base64EncoderSansNewline)] |
There was a problem hiding this comment.
Let's add a backstop test for this type as well, to assert that it absolutely never contains newlines in its encodings and fails when newlines are present while decoding.
woodruffw
approved these changes
Sep 19, 2024
There was a problem hiding this comment.
Thanks @facutuesca! One comment + let's add a bugfix changelog entry for this 🙂
facutuesca
force-pushed
the
fix-pydantic-bug
branch
from
c63e425 to
07cab6b
Compare
This was referenced Sep 19, 2024
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.
Pydantic's
Base64Bytesencodes bytes to base64 inserting newlines (b'\n') every 76 characters. This is not correct for our use case, so this PR switches to our ownBase64Byteswith a custom encoder.See pydantic/pydantic#9072 (comment) for more context.