Skip to content

Update serde.rst #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update serde.rst #555

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc2cbde
Update serde.rst
Mr-Ruben Jun 20, 2025
6c17519
Update serde.rst
skrawcz Jun 23, 2025
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
9 changes: 9 additions & 0 deletions docs/concepts/serde.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. _serde:


================================
Serialization / Deserialization
================================
Expand Down Expand Up @@ -111,3 +112,11 @@ Requirements for the serializer/deserializer functions:

1. The serializer function needs to return a dictionary.
2. Both function signatures needs to have a ``**kwargs`` parameter to allow for custom arguments to be passed in. We advise namespacing the kwargs provided to avoid conflicts with other serializers/deserializers.


Limitations of State Serialization
----------------------------------

Currently, it is only possible to override the serialization and deserialization behavior of individual fields within a state.
Overriding the serialization of the entire state object as a whole is not supported at this time.
If you need custom handling, you must apply it at the field level.
Loading