Skip to content

feat: Add Pydantic model serialization support to messages #113

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

Merged
s-alexey merged 1 commit into from
Apr 1, 2026
Merged

feat: Add Pydantic model serialization support to messages #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/kaggle_benchmarks/messages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
import warnings
from typing import TYPE_CHECKING, Any, Generic, Iterable, TypeVar

import pydantic

from kaggle_benchmarks import events, utils

if TYPE_CHECKING:
Expand Down Expand Up @@ -75,6 +77,8 @@ def usage(self):
def payload(self) -> str | list[dict]:
if hasattr(self.content, "get_payload"):
return self.content.get_payload()
if isinstance(self.content, pydantic.BaseModel):
return self.content.model_dump_json()
if dataclasses.is_dataclass(self.content) and not isinstance(
self.content, type
):
Expand Down
10 changes: 10 additions & 0 deletions tests/test_messages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import json
from dataclasses import dataclass

import pydantic
import pytest

from kaggle_benchmarks import actors, chats, messages, user
Expand Down Expand Up @@ -54,6 +55,15 @@ class Point:
assert json.loads(msg.payload) == {"x": 1, "y": 2}


def test_pydantic_payload():
class Point(pydantic.BaseModel):
x: float
y: float

msg = messages.Message(Point(x=1.5, y=2.5), sender=user)
assert json.loads(msg.payload) == {"x": 1.5, "y": 2.5}


def test_class_payload():
class Point:
def __init__(self, x):
Expand Down