Fix URLSafeSerializer.dumps to always return str#412
Closed
daniel7an wants to merge 1 commit intopallets:mainfrom
Closed
Fix URLSafeSerializer.dumps to always return str#412daniel7an wants to merge 1 commit intopallets:mainfrom
daniel7an wants to merge 1 commit intopallets:mainfrom
Conversation
URLSafeSerializerMixin.dumps now always returns str regardless of the underlying serializer. Since the payload is base64-encoded, it is always valid UTF-8 and can safely be decoded to str. Previously, when using a non-text serializer (e.g. msgpack), dumps() would return bytes despite the type annotation declaring str as the return type. Fixes pallets#410
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
URLSafeSerializerMixin.dumpsnow always returnsstrregardless of the underlying serializer.Problem
When using a non-text serializer (e.g.
msgpack),URLSafeSerializer.dumps()returnsbytesdespite the type annotation declaringstras the return type (sinceURLSafeSerializerextendsSerializer[str]):Fix
Override
dumpsinURLSafeSerializerMixinto always decode the result tostr. Since the payload is base64-encoded, it is always valid UTF-8 and can safely be decoded regardless of the underlying serializer.This also applies to
URLSafeTimedSerializerthrough the mixin.Fixes #410