Skip to content

Commit ebb4ee8

Browse files
authored
docs: Add docstrings for EndStrategy, capture_run_messages, HandleResponseEvent to API docs (#2688)
1 parent e7d513b commit ebb4ee8

File tree

3 files changed

+9
-15
lines changed

3 files changed

+9
-15
lines changed

pydantic_ai_slim/pydantic_ai/agent/__init__.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,14 @@
2626
models,
2727
usage as _usage,
2828
)
29-
from .._agent_graph import HistoryProcessor
29+
from .._agent_graph import (
30+
CallToolsNode,
31+
EndStrategy,
32+
HistoryProcessor,
33+
ModelRequestNode,
34+
UserPromptNode,
35+
capture_run_messages,
36+
)
3037
from .._output import OutputToolset
3138
from .._tool_manager import ToolManager
3239
from ..builtin_tools import AbstractBuiltinTool
@@ -60,13 +67,6 @@
6067
from .abstract import AbstractAgent, EventStreamHandler, RunOutputDataT
6168
from .wrapper import WrapperAgent
6269

63-
# Re-exporting like this improves auto-import behavior in PyCharm
64-
capture_run_messages = _agent_graph.capture_run_messages
65-
EndStrategy = _agent_graph.EndStrategy
66-
CallToolsNode = _agent_graph.CallToolsNode
67-
ModelRequestNode = _agent_graph.ModelRequestNode
68-
UserPromptNode = _agent_graph.UserPromptNode
69-
7070
if TYPE_CHECKING:
7171
from ..mcp import MCPServer
7272

pydantic_ai_slim/pydantic_ai/agent/abstract.py

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,6 @@
3434
from ..toolsets import AbstractToolset
3535
from ..usage import RunUsage, UsageLimits
3636

37-
# Re-exporting like this improves auto-import behavior in PyCharm
38-
capture_run_messages = _agent_graph.capture_run_messages
39-
EndStrategy = _agent_graph.EndStrategy
40-
CallToolsNode = _agent_graph.CallToolsNode
41-
ModelRequestNode = _agent_graph.ModelRequestNode
42-
UserPromptNode = _agent_graph.UserPromptNode
43-
4437
if TYPE_CHECKING:
4538
from fasta2a.applications import FastA2A
4639
from fasta2a.broker import Broker

pydantic_ai_slim/pydantic_ai/messages.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1341,3 +1341,4 @@ class BuiltinToolResultEvent:
13411341
Union[FunctionToolCallEvent, FunctionToolResultEvent, BuiltinToolCallEvent, BuiltinToolResultEvent],
13421342
pydantic.Discriminator('event_kind'),
13431343
]
1344+
"""An event yielded when handling a model response, indicating tool calls and results."""

0 commit comments

Comments
 (0)