A programming framework for agentic AI
Rename codec to serializer (#462)
Jack Gerrits05ff2d33e08f
diff --git a/python/packages/autogen-core/samples/worker/run_worker_pub_sub.py b/python/packages/autogen-core/samples/worker/run_worker_pub_sub.pyindex 5119c49ec..cdcdb5e5d 100644--- a/python/packages/autogen-core/samples/worker/run_worker_pub_sub.py+++ b/python/packages/autogen-core/samples/worker/run_worker_pub_sub.py@@ -4,7 +4,7 @@ from dataclasses import dataclassfrom typing import Any, NoReturnfrom autogen_core.application import WorkerAgentRuntime-from autogen_core.base import MESSAGE_TYPE_REGISTRY, MessageContext, try_get_known_codecs_for_type+from autogen_core.base import MESSAGE_TYPE_REGISTRY, MessageContext, try_get_known_serializers_for_typefrom autogen_core.components import DefaultSubscription, DefaultTopicId, RoutedAgent, message_handler@@ -67,11 +67,11 @@ class GreeterAgent(RoutedAgent):async def main() -> None:runtime = WorkerAgentRuntime()- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(Greeting))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(AskToGreet))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(Feedback))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(ReturnedGreeting))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(ReturnedFeedback))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(Greeting))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(AskToGreet))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(Feedback))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(ReturnedGreeting))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(ReturnedFeedback))await runtime.start(host_connection_string="localhost:50051")await runtime.register("receiver", ReceiveAgent, lambda: [DefaultSubscription()])diff --git a/python/packages/autogen-core/samples/worker/run_worker_rpc.py b/python/packages/autogen-core/samples/worker/run_worker_rpc.pyindex bbc917f01..c8f60a336 100644--- a/python/packages/autogen-core/samples/worker/run_worker_rpc.py+++ b/python/packages/autogen-core/samples/worker/run_worker_rpc.py@@ -9,7 +9,7 @@ from autogen_core.base import (AgentId,AgentInstantiationContext,MessageContext,- try_get_known_codecs_for_type,+ try_get_known_serializers_for_type,)from autogen_core.components import DefaultSubscription, DefaultTopicId, RoutedAgent, message_handler@@ -61,9 +61,9 @@ class GreeterAgent(RoutedAgent):async def main() -> None:runtime = WorkerAgentRuntime()- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(Greeting))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(AskToGreet))- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(Feedback))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(Greeting))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(AskToGreet))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(Feedback))await runtime.start(host_connection_string="localhost:50051")await runtime.register("receiver", lambda: ReceiveAgent(), lambda: [DefaultSubscription()])diff --git a/python/packages/autogen-core/src/autogen_core/base/__init__.py b/python/packages/autogen-core/src/autogen_core/base/__init__.pyindex 1b2047401..f84f3f7cf 100644--- a/python/packages/autogen-core/src/autogen_core/base/__init__.py+++ b/python/packages/autogen-core/src/autogen_core/base/__init__.py@@ -17,10 +17,10 @@ from ._message_handler_context import MessageHandlerContextfrom ._serialization import (JSON_DATA_CONTENT_TYPE,MESSAGE_TYPE_REGISTRY,- MessageCodec,+ MessageSerializer,Serialization,UnknownPayload,- try_get_known_codecs_for_type,+ try_get_known_serializers_for_type,)from ._subscription import Subscriptionfrom ._subscription_context import SubscriptionInstantiationContext@@ -45,7 +45,7 @@ __all__ = ["SubscriptionInstantiationContext","MessageHandlerContext","JSON_DATA_CONTENT_TYPE",- "MessageCodec",- "try_get_known_codecs_for_type",+ "MessageSerializer",+ "try_get_known_serializers_for_type","UnknownPayload",]diff --git a/python/packages/autogen-core/src/autogen_core/base/_serialization.py b/python/packages/autogen-core/src/autogen_core/base/_serialization.pyindex cde31ccb0..44392d61e 100644--- a/python/packages/autogen-core/src/autogen_core/base/_serialization.py+++ b/python/packages/autogen-core/src/autogen_core/base/_serialization.py@@ -7,7 +7,7 @@ from pydantic import BaseModelT = TypeVar("T")-class MessageCodec(Protocol[T]):+class MessageSerializer(Protocol[T]):@propertydef data_content_type(self) -> str: ...@@ -45,7 +45,7 @@ DataclassT = TypeVar("DataclassT", bound=IsDataclass)JSON_DATA_CONTENT_TYPE = "application/json"-class DataclassJsonMessageCodec(MessageCodec[IsDataclass]):+class DataclassJsonMessageSerializer(MessageSerializer[IsDataclass]):def __init__(self, cls: type[IsDataclass]) -> None:self.cls = cls@@ -71,7 +71,7 @@ class DataclassJsonMessageCodec(MessageCodec[IsDataclass]):PydanticT = TypeVar("PydanticT", bound=BaseModel)-class PydanticJsonMessageCodec(MessageCodec[PydanticT]):+class PydanticJsonMessageSerializer(MessageSerializer[PydanticT]):def __init__(self, cls: type[PydanticT]) -> None:self.cls = cls@@ -108,46 +108,46 @@ def _type_name(cls: type[Any] | Any) -> str:V = TypeVar("V")-def try_get_known_codecs_for_type(cls: type[Any]) -> list[MessageCodec[Any]]:+def try_get_known_serializers_for_type(cls: type[Any]) -> list[MessageSerializer[Any]]:# TODO: Support protobuf types- codecs: List[MessageCodec[Any]] = []+ serializers: List[MessageSerializer[Any]] = []if issubclass(cls, BaseModel):- codecs.append(PydanticJsonMessageCodec(cls))+ serializers.append(PydanticJsonMessageSerializer(cls))elif isinstance(cls, IsDataclass):- codecs.append(DataclassJsonMessageCodec(cls))+ serializers.append(DataclassJsonMessageSerializer(cls))- return codecs+ return serializersclass Serialization:def __init__(self) -> None:- # type_name, data_content_type -> codec- self._codecs: dict[tuple[str, str], MessageCodec[Any]] = {}+ # type_name, data_content_type -> serializer+ self._serializers: dict[tuple[str, str], MessageSerializer[Any]] = {}- def add_codec(self, codec: MessageCodec[Any] | List[MessageCodec[Any]]) -> None:- if isinstance(codec, list):- for c in codec:- self.add_codec(c)+ def add_serializer(self, serializer: MessageSerializer[Any] | List[MessageSerializer[Any]]) -> None:+ if isinstance(serializer, list):+ for c in serializer:+ self.add_serializer(c)return- self._codecs[(codec.type_name, codec.data_content_type)] = codec+ self._serializers[(serializer.type_name, serializer.data_content_type)] = serializerdef deserialize(self, payload: bytes, *, type_name: str, data_content_type: str) -> Any:- codec = self._codecs.get((type_name, data_content_type))- if codec is None:+ serializer = self._serializers.get((type_name, data_content_type))+ if serializer is None:return UnknownPayload(type_name, data_content_type, payload)- return codec.deserialize(payload)+ return serializer.deserialize(payload)def serialize(self, message: Any, *, type_name: str, data_content_type: str) -> bytes:- codec = self._codecs.get((type_name, data_content_type))- if codec is None:+ serializer = self._serializers.get((type_name, data_content_type))+ if serializer is None:raise ValueError(f"Unknown type {type_name} with content type {data_content_type}")- return codec.serialize(message)+ return serializer.serialize(message)def is_registered(self, type_name: str, data_content_type: str) -> bool:- return (type_name, data_content_type) in self._codecs+ return (type_name, data_content_type) in self._serializersdef type_name(self, message: Any) -> str:return _type_name(message)diff --git a/python/packages/autogen-core/src/autogen_core/components/_closure_agent.py b/python/packages/autogen-core/src/autogen_core/components/_closure_agent.pyindex 401c00176..68f14632c 100644--- a/python/packages/autogen-core/src/autogen_core/components/_closure_agent.py+++ b/python/packages/autogen-core/src/autogen_core/components/_closure_agent.py@@ -8,7 +8,7 @@ from ..base._agent_id import AgentIdfrom ..base._agent_instantiation import AgentInstantiationContextfrom ..base._agent_metadata import AgentMetadatafrom ..base._agent_runtime import AgentRuntime-from ..base._serialization import JSON_DATA_CONTENT_TYPE, MESSAGE_TYPE_REGISTRY, try_get_known_codecs_for_type+from ..base._serialization import JSON_DATA_CONTENT_TYPE, MESSAGE_TYPE_REGISTRY, try_get_known_serializers_for_typefrom ..base.exceptions import CantHandleExceptionfrom ._type_helpers import get_types@@ -61,7 +61,7 @@ class ClosureAgent(Agent):subscription_types = get_subscriptions_from_closure(closure)# TODO fold this into runtimefor message_type in subscription_types:- MESSAGE_TYPE_REGISTRY.add_codec(try_get_known_codecs_for_type(message_type))+ MESSAGE_TYPE_REGISTRY.add_serializer(try_get_known_serializers_for_type(message_type))self._subscriptions = [MESSAGE_TYPE_REGISTRY.type_name(message_type) for message_type in subscription_types]self._closure = closurediff --git a/python/packages/autogen-core/src/autogen_core/components/_routed_agent.py b/python/packages/autogen-core/src/autogen_core/components/_routed_agent.pyindex ceb058fe6..c7b57adcd 100644--- a/python/packages/autogen-core/src/autogen_core/components/_routed_agent.py+++ b/python/packages/autogen-core/src/autogen_core/components/_routed_agent.py@@ -17,7 +17,7 @@ from typing import (runtime_checkable,)-from autogen_core.base import try_get_known_codecs_for_type+from autogen_core.base import try_get_known_serializers_for_typefrom ..base import MESSAGE_TYPE_REGISTRY, BaseAgent, MessageContextfrom ..base.exceptions import CantHandleException@@ -146,8 +146,8 @@ class RoutedAgent(BaseAgent):self._handlers[target_type] = message_handlerfor message_type in self._handlers.keys():- for codec in try_get_known_codecs_for_type(message_type):- MESSAGE_TYPE_REGISTRY.add_codec(codec)+ for serializer in try_get_known_serializers_for_type(message_type):+ MESSAGE_TYPE_REGISTRY.add_serializer(serializer)super().__init__(description)diff --git a/python/packages/autogen-core/tests/test_serialization.py b/python/packages/autogen-core/tests/test_serialization.pyindex bcfca802c..28cce82a3 100644--- a/python/packages/autogen-core/tests/test_serialization.py+++ b/python/packages/autogen-core/tests/test_serialization.py@@ -4,7 +4,7 @@ from dataclasses import dataclassimport pytestfrom autogen_core.base import Serialization-from autogen_core.base import JSON_DATA_CONTENT_TYPE, MessageCodec, try_get_known_codecs_for_type+from autogen_core.base import JSON_DATA_CONTENT_TYPE, MessageSerializer, try_get_known_serializers_for_typeclass PydanticMessage(BaseModel):message: str@@ -29,7 +29,7 @@ class NestingPydanticDataclassMessage:def test_pydantic() -> None:serde = Serialization()- serde.add_codec(try_get_known_codecs_for_type(PydanticMessage))+ serde.add_serializer(try_get_known_serializers_for_type(PydanticMessage))message = PydanticMessage(message="hello")name = serde.type_name(message)@@ -41,7 +41,7 @@ def test_pydantic() -> None:def test_nested_pydantic() -> None:serde = Serialization()- serde.add_codec(try_get_known_codecs_for_type(NestingPydanticMessage))+ serde.add_serializer(try_get_known_serializers_for_type(NestingPydanticMessage))message = NestingPydanticMessage(message="hello", nested=PydanticMessage(message="world"))name = serde.type_name(message)@@ -52,7 +52,7 @@ def test_nested_pydantic() -> None:def test_dataclass() -> None:serde = Serialization()- serde.add_codec(try_get_known_codecs_for_type(DataclassMessage))+ serde.add_serializer(try_get_known_serializers_for_type(DataclassMessage))message = DataclassMessage(message="hello")name = serde.type_name(message)@@ -63,7 +63,7 @@ def test_dataclass() -> None:def test_nesting_dataclass_dataclass() -> None:serde = Serialization()- serde.add_codec(try_get_known_codecs_for_type(NestingDataclassMessage))+ serde.add_serializer(try_get_known_serializers_for_type(NestingDataclassMessage))message = NestingDataclassMessage(message="hello", nested=DataclassMessage(message="world"))name = serde.type_name(message)@@ -72,7 +72,7 @@ def test_nesting_dataclass_dataclass() -> None:def test_nesting_dataclass_pydantic() -> None:serde = Serialization()- serde.add_codec(try_get_known_codecs_for_type(NestingPydanticDataclassMessage))+ serde.add_serializer(try_get_known_serializers_for_type(NestingPydanticDataclassMessage))message = NestingPydanticDataclassMessage(message="hello", nested=PydanticMessage(message="world"))name = serde.type_name(message)@@ -82,14 +82,14 @@ def test_nesting_dataclass_pydantic() -> None:def test_invalid_type() -> None:serde = Serialization()try:- serde.add_codec(try_get_known_codecs_for_type(str))+ serde.add_serializer(try_get_known_serializers_for_type(str))except ValueError as e:assert str(e) == "Unsupported type <class 'str'>"def test_custom_type() -> None:serde = Serialization()- class CustomStringTypeCodec(MessageCodec[str]):+ class CustomStringTypeSerializer(MessageSerializer[str]):@propertydef data_content_type(self) -> str:return "str"@@ -106,7 +106,7 @@ def test_custom_type() -> None:return f'"{message}"'.encode("utf-8")- serde.add_codec(CustomStringTypeCodec())+ serde.add_serializer(CustomStringTypeSerializer())message = "hello"json = serde.serialize(message, type_name="custom_str", data_content_type="str")assert json == b'"hello"'