Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions src/itsdangerous/serializer.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ class Serializer(t.Generic[_TSerialized]):
:attr:`default_serializer`, which defaults to :mod:`json`.
:param serializer_kwargs: Keyword arguments to pass when calling
``serializer.dumps``.
:param deserializer_kwargs: Keyword arguments to pass when calling
``serializer.loads``.
:param signer: A ``Signer`` class to instantiate when signing data.
Defaults to :attr:`default_signer`, which defaults to
:class:`~itsdangerous.signer.Signer`.
Expand Down Expand Up @@ -111,6 +113,7 @@ def __init__(
salt: str | bytes | None = b"itsdangerous",
serializer: None | _PDataSerializer[str] = None,
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand All @@ -127,6 +130,7 @@ def __init__(
salt: str | bytes | None,
serializer: _PDataSerializer[bytes],
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand All @@ -144,6 +148,7 @@ def __init__(
*,
serializer: _PDataSerializer[bytes],
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand All @@ -162,6 +167,7 @@ def __init__(
salt: str | bytes | None,
serializer: t.Any,
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand All @@ -179,6 +185,7 @@ def __init__(
*,
serializer: t.Any,
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand All @@ -193,6 +200,7 @@ def __init__(
salt: str | bytes | None = b"itsdangerous",
serializer: t.Any | None = None,
serializer_kwargs: dict[str, t.Any] | None = None,
deserializer_kwargs: dict[str, t.Any] | None = None,
signer: type[Signer] | None = None,
signer_kwargs: dict[str, t.Any] | None = None,
fallback_signers: list[
Expand Down Expand Up @@ -232,6 +240,7 @@ def __init__(
dict[str, t.Any] | tuple[type[Signer], dict[str, t.Any]] | type[Signer]
] = fallback_signers
self.serializer_kwargs: dict[str, t.Any] = serializer_kwargs or {}
self.deserializer_kwargs: dict[str, t.Any] = deserializer_kwargs or {}

@property
def secret_key(self) -> bytes:
Expand All @@ -258,9 +267,11 @@ def load_payload(

try:
if is_text:
return use_serializer.loads(payload.decode("utf-8")) # type: ignore[arg-type]
return use_serializer.loads(
payload.decode("utf-8"), **self.deserializer_kwargs
) # type: ignore[arg-type]

return use_serializer.loads(payload) # type: ignore[arg-type]
return use_serializer.loads(payload, **self.deserializer_kwargs) # type: ignore[arg-type]
except Exception as e:
raise BadPayload(
"Could not load the payload because an exception"
Expand Down
18 changes: 18 additions & 0 deletions tests/test_itsdangerous/test_serializer.py
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,24 @@ def test_serializer_kwargs(self, serializer_factory):

assert serializer.loads(serializer.dumps({(): 1})) == {}

def test_deserializer_kwargs(self, serializer_factory):
class KwargsSerializer:
@staticmethod
def dumps(obj, *, dump_value=False):
return "dumped" if dump_value else "missing"

@staticmethod
def loads(payload, *, load_value=False):
return f"{payload}:{load_value}"

serializer = serializer_factory(
serializer=KwargsSerializer,
serializer_kwargs={"dump_value": True},
deserializer_kwargs={"load_value": True},
)

assert serializer.loads(serializer.dumps(None)) == "dumped:True"

def test_fallback_signers(self, serializer_factory, value: Any):
serializer = serializer_factory(signer_kwargs={"digest_method": hashlib.sha256})
signed = serializer.dumps(value)
Expand Down
Loading