Skip to content

Docs: Improve example for custom Session class implementation. #1582

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
merged 2 commits into from
Aug 26, 2025
Merged

Docs: Improve example for custom Session class implementation. #1582

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e25a20
Improve example for custom Session class implementation.
luke-wriglesworth Aug 25, 2025
0449817
Make MyCustomSession inherit form SessionABC
luke-wriglesworth Aug 26, 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
8 changes: 4 additions & 4 deletions docs/sessions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ if __name__ == "__main__":
You can implement your own session memory by creating a class that follows the [`Session`][agents.memory.session.Session] protocol:

```python
from agents.memory import Session
from agents.items import TResponseInputItem
from typing import List

class MyCustomSession:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class should inherit SessionABC

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made the requested change but noticed that the SessionABC docstring says it should be inherited only for internal implementations. Should we also update this docstring?

openai-agents-python/src/agents/memory/session.py

Lines 58 to 66 in 86e26e9

class SessionABC(ABC):
"""Abstract base class for session implementations.
Session stores conversation history for a specific session, allowing
agents to maintain context without requiring explicit manual memory management.
This ABC is intended for internal use and as a base class for concrete implementations.
Third-party libraries should implement the Session protocol instead.
"""

Expand All @@ -237,17 +237,17 @@ class MyCustomSession:
self.session_id = session_id
# Your initialization here

async def get_items(self, limit: int | None = None) -> List[dict]:
async def get_items(self, limit: int | None = None) -> List[TResponseInputItem]:
"""Retrieve conversation history for this session."""
# Your implementation here
pass

async def add_items(self, items: List[dict]) -> None:
async def add_items(self, items: List[TResponseInputItem]) -> None:
"""Store new items for this session."""
# Your implementation here
pass

async def pop_item(self) -> dict | None:
async def pop_item(self) -> TResponseInputItem | None:
"""Remove and return the most recent item from this session."""
# Your implementation here
pass
Expand Down