Skip to content

Python: Fix the serialization protocol round-trip example #9106

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
BlueRaddish wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Python: Fix the serialization protocol round-trip example #9106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4845950
docs: fix the serialization protocol round-trip example
BlueRaddish Oct 6, 2026
10b3dc8
Merge branch 'main' into docs/serialization-protocol-examples
eavanvalkenburg Oct 13, 2026
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
17 changes: 9 additions & 8 deletions python/packages/core/agent_framework/_serialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,22 +71,23 @@ class SerializationProtocol(Protocol):
assert isinstance(user_msg, SerializationProtocol)
assert isinstance(restored_msg, SerializationProtocol)

The protocol is also implemented by simpler classes like ``UsageDetails``:
The protocol is also implemented by simpler classes like ``Content``:

.. code-block:: python

from agent_framework import UsageDetails
from agent_framework import Content
from agent_framework._serialization import SerializationProtocol

# Create usage tracking instance
usage = UsageDetails(input_token_count=150, output_token_count=75, total_token_count=225)
# Create a text content instance
content = Content.from_text(text="Hello")

# Seamless serialization with type preservation
usage_dict = usage.to_dict()
restored_usage = UsageDetails.from_dict(usage_dict)
content_dict = content.to_dict()
restored_content = Content.from_dict(content_dict)

# Both satisfy the SerializationProtocol
assert isinstance(usage, SerializationProtocol)
assert restored_usage.total_token_count == 225
assert isinstance(content, SerializationProtocol)
assert restored_content.text == "Hello"

The protocol ensures consistent serialization behavior across all framework components,
enabling reliable data persistence, API communication, and object reconstruction
Expand Down
Loading