A programming framework for agentic AI
Make Memory and Team an ABC (#5149)
Victor Dibia5e9b24c3d914
diff --git a/python/packages/autogen-agentchat/src/autogen_agentchat/base/_team.py b/python/packages/autogen-agentchat/src/autogen_agentchat/base/_team.pyindex 10999b050..565ad225b 100644--- a/python/packages/autogen-agentchat/src/autogen_agentchat/base/_team.py+++ b/python/packages/autogen-agentchat/src/autogen_agentchat/base/_team.py@@ -1,17 +1,20 @@-from typing import Any, Mapping, Protocol-+from typing import Any, Mapping+from abc import ABC, abstractmethodfrom ._task import TaskRunner-class Team(TaskRunner, Protocol):+class Team(ABC, TaskRunner):+ @abstractmethodasync def reset(self) -> None:"""Reset the team and all its participants to its initial state."""...+ @abstractmethodasync def save_state(self) -> Mapping[str, Any]:"""Save the current state of the team."""...+ @abstractmethodasync def load_state(self, state: Mapping[str, Any]) -> None:"""Load the state of the team."""...diff --git a/python/packages/autogen-core/src/autogen_core/memory/_base_memory.py b/python/packages/autogen-core/src/autogen_core/memory/_base_memory.pyindex 7ce5904d7..bfccafdf0 100644--- a/python/packages/autogen-core/src/autogen_core/memory/_base_memory.py+++ b/python/packages/autogen-core/src/autogen_core/memory/_base_memory.py@@ -1,5 +1,6 @@from enum import Enum-from typing import Any, Dict, List, Protocol, Union, runtime_checkable+from typing import Any, Dict, List, Union+from abc import ABC, abstractmethodfrom pydantic import BaseModel, ConfigDict@@ -48,8 +49,7 @@ class UpdateContextResult(BaseModel):memories: MemoryQueryResult-@runtime_checkable-class Memory(Protocol):+class Memory(ABC):"""Protocol defining the interface for memory implementations.A memory is the storage for data that can be used to enrich or modify the model context.@@ -64,6 +64,7 @@ class Memory(Protocol):See :class:`~autogen_core.memory.ListMemory` for an example implementation."""+ @abstractmethodasync def update_context(self,model_context: ChatCompletionContext,@@ -79,6 +80,7 @@ class Memory(Protocol):"""...+ @abstractmethodasync def query(self,query: str | MemoryContent,@@ -98,6 +100,7 @@ class Memory(Protocol):"""...+ @abstractmethodasync def add(self, content: MemoryContent, cancellation_token: CancellationToken | None = None) -> None:"""Add a new content to memory.@@ -108,10 +111,12 @@ class Memory(Protocol):"""...+ @abstractmethodasync def clear(self) -> None:"""Clear all entries from memory."""...+ @abstractmethodasync def close(self) -> None:"""Clean up any resources used by the memory implementation."""...diff --git a/python/packages/autogen-core/tests/test_memory.py b/python/packages/autogen-core/tests/test_memory.pyindex ebe1866ed..7d0f6b6ea 100644--- a/python/packages/autogen-core/tests/test_memory.py+++ b/python/packages/autogen-core/tests/test_memory.py@@ -1,3 +1,4 @@+from typing import Anyimport pytestfrom autogen_core import CancellationTokenfrom autogen_core.memory import (@@ -21,19 +22,22 @@ def test_memory_protocol_attributes() -> None:assert hasattr(Memory, "close")-def test_memory_protocol_runtime_checkable() -> None:- """Test that Memory protocol is properly runtime-checkable."""+def test_memory_abc_implementation() -> None:+ """Test that Memory ABC is properly implemented."""- class ValidMemory:+ class ValidMemory(Memory):@propertydef name(self) -> str:return "test"- async def update_context(self, context: ChatCompletionContext) -> UpdateContextResult:+ async def update_context(self, model_context: ChatCompletionContext) -> UpdateContextResult:return UpdateContextResult(memories=MemoryQueryResult(results=[]))async def query(- self, query: MemoryContent, cancellation_token: CancellationToken | None = None+ self,+ query: str | MemoryContent,+ cancellation_token: CancellationToken | None = None,+ **kwargs: Any,) -> MemoryQueryResult:return MemoryQueryResult(results=[])