BREAKING CHANGE: Make many more dataclasses kw-only (#2738)

Author: dmontagu

pydantic_ai_slim/pydantic_ai/_agent_graph.py

@@ -78,7 +78,7 @@
 """
 
 
-@dataclasses.dataclass
+@dataclasses.dataclass(kw_only=True)
 class GraphAgentState:
     """State kept across the execution of the agent graph."""
 
@@ -99,7 +99,7 @@ def increment_retries(self, max_result_retries: int, error: BaseException | None
                 raise exceptions.UnexpectedModelBehavior(message)
 
 
-@dataclasses.dataclass
+@dataclasses.dataclass(kw_only=True)
 class GraphAgentDeps(Generic[DepsT, OutputDataT]):
     """Dependencies/config passed to the agent graph."""
 
@@ -157,6 +157,8 @@ class UserPromptNode(AgentNode[DepsT, NodeRunEndT]):
 
     user_prompt: str | Sequence[_messages.UserContent] | None
 
+    _: dataclasses.KW_ONLY
+
     instructions: str | None
     instructions_functions: list[_system_prompt.SystemPromptRunner[DepsT]]
 
@@ -359,8 +361,8 @@ class ModelRequestNode(AgentNode[DepsT, NodeRunEndT]):
 
     request: _messages.ModelRequest
 
-    _result: CallToolsNode[DepsT, NodeRunEndT] | None = field(default=None, repr=False)
-    _did_stream: bool = field(default=False, repr=False)
+    _result: CallToolsNode[DepsT, NodeRunEndT] | None = field(repr=False, init=False, default=None)
+    _did_stream: bool = field(repr=False, init=False, default=False)
 
     async def run(
         self, ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, NodeRunEndT]]
@@ -389,13 +391,13 @@ async def stream(
             self._did_stream = True
             ctx.state.usage.requests += 1
             agent_stream = result.AgentStream[DepsT, T](
-                streamed_response,
-                ctx.deps.output_schema,
-                model_request_parameters,
-                ctx.deps.output_validators,
-                build_run_context(ctx),
-                ctx.deps.usage_limits,
-                ctx.deps.tool_manager,
+                _raw_stream_response=streamed_response,
+                _output_schema=ctx.deps.output_schema,
+                _model_request_parameters=model_request_parameters,
+                _output_validators=ctx.deps.output_validators,
+                _run_ctx=build_run_context(ctx),
+                _usage_limits=ctx.deps.usage_limits,
+                _tool_manager=ctx.deps.tool_manager,
             )
             yield agent_stream
             # In case the user didn't manually consume the full stream, ensure it is fully consumed here,
@@ -475,9 +477,9 @@ class CallToolsNode(AgentNode[DepsT, NodeRunEndT]):
 
     model_response: _messages.ModelResponse
 
-    _events_iterator: AsyncIterator[_messages.HandleResponseEvent] | None = field(default=None, repr=False)
+    _events_iterator: AsyncIterator[_messages.HandleResponseEvent] | None = field(default=None, init=False, repr=False)
     _next_node: ModelRequestNode[DepsT, NodeRunEndT] | End[result.FinalResult[NodeRunEndT]] | None = field(
-        default=None, repr=False
+        default=None, init=False, repr=False
     )
 
     async def run(
@@ -629,7 +631,7 @@ async def _handle_text_response(
             ctx.state.increment_retries(ctx.deps.max_result_retries, e)
             return ModelRequestNode[DepsT, NodeRunEndT](_messages.ModelRequest(parts=[e.tool_retry]))
         else:
-            return self._handle_final_result(ctx, result.FinalResult(result_data, None, None), [])
+            return self._handle_final_result(ctx, result.FinalResult(result_data), [])
 
 
 def build_run_context(ctx: GraphRunContext[GraphAgentState, GraphAgentDeps[DepsT, Any]]) -> RunContext[DepsT]:

pydantic_ai_slim/pydantic_ai/_function_schema.py

@@ -30,7 +30,7 @@
 __all__ = ('function_schema',)
 
 
-@dataclass
+@dataclass(kw_only=True)
 class FunctionSchema:
     """Internal information about a function schema."""
 

pydantic_ai_slim/pydantic_ai/_run_context.py

@@ -18,7 +18,7 @@
 """Type variable for agent dependencies."""
 
 
-@dataclasses.dataclass(repr=False)
+@dataclasses.dataclass(repr=False, kw_only=True)
 class RunContext(Generic[AgentDepsT]):
     """Information about the current call."""
 

pydantic_ai_slim/pydantic_ai/agent/__init__.py

@@ -1428,13 +1428,13 @@ class _AgentFunctionToolset(FunctionToolset[AgentDepsT]):
     def __init__(
         self,
         tools: Sequence[Tool[AgentDepsT] | ToolFuncEither[AgentDepsT, ...]] = [],
-        max_retries: int = 1,
         *,
+        max_retries: int = 1,
         id: str | None = None,
         output_schema: _output.BaseOutputSchema[Any],
     ):
         self.output_schema = output_schema
-        super().__init__(tools, max_retries, id=id)
+        super().__init__(tools, max_retries=max_retries, id=id)
 
     @property
     def id(self) -> str:

pydantic_ai_slim/pydantic_ai/builtin_tools.py

@@ -9,7 +9,7 @@
 __all__ = ('AbstractBuiltinTool', 'WebSearchTool', 'WebSearchUserLocation', 'CodeExecutionTool', 'UrlContextTool')
 
 
-@dataclass
+@dataclass(kw_only=True)
 class AbstractBuiltinTool(ABC):
     """A builtin tool that can be used by an agent.
 
@@ -19,7 +19,7 @@ class AbstractBuiltinTool(ABC):
     """
 
 
-@dataclass
+@dataclass(kw_only=True)
 class WebSearchTool(AbstractBuiltinTool):
     """A builtin tool that allows your agent to search the web for information.
 

pydantic_ai_slim/pydantic_ai/common_tools/duckduckgo.py

@@ -1,5 +1,5 @@
 import functools
-from dataclasses import dataclass
+from dataclasses import KW_ONLY, dataclass
 
 import anyio
 import anyio.to_thread
@@ -43,7 +43,9 @@ class DuckDuckGoSearchTool:
     client: DDGS
     """The DuckDuckGo search client."""
 
-    max_results: int | None = None
+    _: KW_ONLY
+
+    max_results: int | None
     """The maximum number of results. If None, returns results only from the first response."""
 
     async def __call__(self, query: str) -> list[DuckDuckGoResult]: