Skip to content

Commit 325f6f9

Browse files
committed
fix docstring examples
1 parent 79d347d commit 325f6f9

File tree

3 files changed

+42
-6
lines changed

3 files changed

+42
-6
lines changed

pydantic_ai_slim/pydantic_ai/agent/abstract.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -610,13 +610,25 @@ def run_stream_events(
610610
611611
Example:
612612
```python
613-
from pydantic_ai import Agent
613+
from pydantic_ai import Agent, AgentRunResultEvent, AgentStreamEvent
614614
615615
agent = Agent('openai:gpt-4o')
616616
617617
async def main():
618+
events: list[AgentStreamEvent | AgentRunResultEvent] = []
618619
async for event in agent.run_stream_events('What is the capital of France?'):
619-
print(event)
620+
events.append(event)
621+
print(events)
622+
'''
623+
[
624+
PartStartEvent(index=0, part=TextPart(content='The capital of ')),
625+
FinalResultEvent(tool_name=None, tool_call_id=None),
626+
PartDeltaEvent(index=0, delta=TextPartDelta(content_delta='France is Paris. ')),
627+
AgentRunResultEvent(
628+
result=AgentRunResult(output='The capital of France is Paris. ')
629+
),
630+
]
631+
'''
620632
```
621633
622634
Arguments are the same as for [`self.run`][pydantic_ai.agent.AbstractAgent.run],

pydantic_ai_slim/pydantic_ai/durable_exec/dbos/_agent.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -603,13 +603,25 @@ def run_stream_events(
603603
604604
Example:
605605
```python
606-
from pydantic_ai import Agent
606+
from pydantic_ai import Agent, AgentRunResultEvent, AgentStreamEvent
607607
608608
agent = Agent('openai:gpt-4o')
609609
610610
async def main():
611+
events: list[AgentStreamEvent | AgentRunResultEvent] = []
611612
async for event in agent.run_stream_events('What is the capital of France?'):
612-
print(event)
613+
events.append(event)
614+
print(events)
615+
'''
616+
[
617+
PartStartEvent(index=0, part=TextPart(content='The capital of ')),
618+
FinalResultEvent(tool_name=None, tool_call_id=None),
619+
PartDeltaEvent(index=0, delta=TextPartDelta(content_delta='France is Paris. ')),
620+
AgentRunResultEvent(
621+
result=AgentRunResult(output='The capital of France is Paris. ')
622+
),
623+
]
624+
'''
613625
```
614626
615627
Arguments are the same as for [`self.run`][pydantic_ai.agent.AbstractAgent.run],

pydantic_ai_slim/pydantic_ai/durable_exec/temporal/_agent.py

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -636,13 +636,25 @@ def run_stream_events(
636636
637637
Example:
638638
```python
639-
from pydantic_ai import Agent
639+
from pydantic_ai import Agent, AgentRunResultEvent, AgentStreamEvent
640640
641641
agent = Agent('openai:gpt-4o')
642642
643643
async def main():
644+
events: list[AgentStreamEvent | AgentRunResultEvent] = []
644645
async for event in agent.run_stream_events('What is the capital of France?'):
645-
print(event)
646+
events.append(event)
647+
print(events)
648+
'''
649+
[
650+
PartStartEvent(index=0, part=TextPart(content='The capital of ')),
651+
FinalResultEvent(tool_name=None, tool_call_id=None),
652+
PartDeltaEvent(index=0, delta=TextPartDelta(content_delta='France is Paris. ')),
653+
AgentRunResultEvent(
654+
result=AgentRunResult(output='The capital of France is Paris. ')
655+
),
656+
]
657+
'''
646658
```
647659
648660
Arguments are the same as for [`self.run`][pydantic_ai.agent.AbstractAgent.run],

0 commit comments

Comments
 (0)