docs(python): add SessionEvent type hints to README examples #170
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Python SDK README examples to annotate on_event callbacks with the SessionEvent type for better IDE/type-checker support.
Changes:
- Import
SessionEventalongsideCopilotClientin README examples. - Add
SessionEventtype annotations toon_eventcallback parameters.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| session = await client.create_session({"model": "gpt-5"}) | ||
|
|
||
| def on_event(event): | ||
| def on_event(event: SessionEvent): |
There was a problem hiding this comment.
This README code block now annotates event as SessionEvent, but the snippet doesn't import SessionEvent (or qualify it), so copy/pasting just this block will raise NameError. Consider adding from copilot import SessionEvent within the same code block (or dropping the annotation in this snippet if you want it import-free).
|
|
||
| def on_event(event): | ||
| def on_event(event: SessionEvent): | ||
| print(f"Event: {event['type']}") |
There was a problem hiding this comment.
With event: SessionEvent, event['type'] is incorrect because SessionEvent is a dataclass and isn't subscriptable. This example should use event.type (or event.type.value) to print the event type.
| print(f"Event: {event['type']}") | |
| print(f"Event: {event.type.value}") |
1 participant
Add
SessionEventtype hints toon_eventcallback functions in the Python SDK README examples for better IDE support and documentation clarity.This PR was filed by Copilot CLI.