Skip to content

Let agent name be overridden contextually #3094

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 5 commits into from
Oct 7, 2025
+36 −6
Merged

Let agent name be overridden contextually #3094

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4300b36
enabled overriding name in the main Agent
MinuraPunchihewa Oct 6, 2025
c92c59e
added name to the override() methods of base classes
MinuraPunchihewa Oct 6, 2025
752227e
added a test for name overrides
MinuraPunchihewa Oct 6, 2025
81d5921
updated name property to account for overrides
MinuraPunchihewa Oct 6, 2025
6ad9cf7
updated first sentence of docstrings to include name
MinuraPunchihewa Oct 7, 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
13 changes: 12 additions & 1 deletion pydantic_ai_slim/pydantic_ai/agent/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ def __init__(

self._event_stream_handler = event_stream_handler

self._override_name: ContextVar[_utils.Option[str]] = ContextVar('_override_name', default=None)
self._override_deps: ContextVar[_utils.Option[AgentDepsT]] = ContextVar('_override_deps', default=None)
self._override_model: ContextVar[_utils.Option[models.Model]] = ContextVar('_override_model', default=None)
self._override_toolsets: ContextVar[_utils.Option[Sequence[AbstractToolset[AgentDepsT]]]] = ContextVar(
Expand Down Expand Up @@ -384,7 +385,8 @@ def name(self) -> str | None:

If `None`, we try to infer the agent name from the call frame when the agent is first run.
"""
return self._name
name_ = self._override_name.get()
return name_.value if name_ else self._name

@name.setter
def name(self, value: str | None) -> None:
Expand Down Expand Up @@ -712,6 +714,7 @@ def _run_span_end_attributes(
def override(
self,
*,
name: str | _utils.Unset = _utils.UNSET,
deps: AgentDepsT | _utils.Unset = _utils.UNSET,
model: models.Model | models.KnownModelName | str | _utils.Unset = _utils.UNSET,
toolsets: Sequence[AbstractToolset[AgentDepsT]] | _utils.Unset = _utils.UNSET,
Expand All @@ -724,12 +727,18 @@ def override(
You can find an example of this [here](../testing.md#overriding-model-via-pytest-fixtures).

Args:
name: The name to use instead of the name passed to the agent constructor and agent run.
deps: The dependencies to use instead of the dependencies passed to the agent run.
model: The model to use instead of the model passed to the agent run.
toolsets: The toolsets to use instead of the toolsets passed to the agent constructor and agent run.
tools: The tools to use instead of the tools registered with the agent.
instructions: The instructions to use instead of the instructions registered with the agent.
"""
if _utils.is_set(name):
name_token = self._override_name.set(_utils.Some(name))
else:
name_token = None

if _utils.is_set(deps):
deps_token = self._override_deps.set(_utils.Some(deps))
else:
Expand Down Expand Up @@ -759,6 +768,8 @@ def override(
try:
yield
finally:
if name_token is not None:
self._override_name.reset(name_token)
if deps_token is not None:
self._override_deps.reset(deps_token)
if model_token is not None:
Expand Down
2 changes: 2 additions & 0 deletions pydantic_ai_slim/pydantic_ai/agent/abstract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -854,6 +854,7 @@ async def main():
def override(
self,
*,
name: str | _utils.Unset = _utils.UNSET,
deps: AgentDepsT | _utils.Unset = _utils.UNSET,
model: models.Model | models.KnownModelName | str | _utils.Unset = _utils.UNSET,
toolsets: Sequence[AbstractToolset[AgentDepsT]] | _utils.Unset = _utils.UNSET,
Expand All @@ -866,6 +867,7 @@ def override(
You can find an example of this [here](../testing.md#overriding-model-via-pytest-fixtures).

Args:
name: The name to use instead of the name passed to the agent constructor and agent run.
deps: The dependencies to use instead of the dependencies passed to the agent run.
model: The model to use instead of the model passed to the agent run.
toolsets: The toolsets to use instead of the toolsets passed to the agent constructor and agent run.
Expand Down
3 changes: 3 additions & 0 deletions pydantic_ai_slim/pydantic_ai/agent/wrapper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ async def main():
def override(
self,
*,
name: str | _utils.Unset = _utils.UNSET,
deps: AgentDepsT | _utils.Unset = _utils.UNSET,
model: models.Model | models.KnownModelName | str | _utils.Unset = _utils.UNSET,
toolsets: Sequence[AbstractToolset[AgentDepsT]] | _utils.Unset = _utils.UNSET,
Expand All @@ -222,13 +223,15 @@ def override(
You can find an example of this [here](../testing.md#overriding-model-via-pytest-fixtures).

Args:
name: The name to use instead of the name passed to the agent constructor and agent run.
deps: The dependencies to use instead of the dependencies passed to the agent run.
model: The model to use instead of the model passed to the agent run.
toolsets: The toolsets to use instead of the toolsets passed to the agent constructor and agent run.
tools: The tools to use instead of the tools registered with the agent.
instructions: The instructions to use instead of the instructions registered with the agent.
"""
with self.wrapped.override(
name=name,
deps=deps,
model=model,
toolsets=toolsets,
Expand Down
3 changes: 3 additions & 0 deletions pydantic_ai_slim/pydantic_ai/durable_exec/dbos/_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,6 +804,7 @@ async def main():
def override(
self,
*,
name: str | _utils.Unset = _utils.UNSET,
deps: AgentDepsT | _utils.Unset = _utils.UNSET,
model: models.Model | models.KnownModelName | str | _utils.Unset = _utils.UNSET,
toolsets: Sequence[AbstractToolset[AgentDepsT]] | _utils.Unset = _utils.UNSET,
Expand All @@ -816,6 +817,7 @@ def override(
You can find an example of this [here](../testing.md#overriding-model-via-pytest-fixtures).

Args:
name: The name to use instead of the name passed to the agent constructor and agent run.
deps: The dependencies to use instead of the dependencies passed to the agent run.
model: The model to use instead of the model passed to the agent run.
toolsets: The toolsets to use instead of the toolsets passed to the agent constructor and agent run.
Expand All @@ -828,6 +830,7 @@ def override(
)

with super().override(
name=name,
deps=deps,
model=model,
toolsets=toolsets,
Expand Down
3 changes: 3 additions & 0 deletions pydantic_ai_slim/pydantic_ai/durable_exec/temporal/_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,7 @@ async def main():
def override(
self,
*,
name: str | _utils.Unset = _utils.UNSET,
deps: AgentDepsT | _utils.Unset = _utils.UNSET,
model: models.Model | models.KnownModelName | str | _utils.Unset = _utils.UNSET,
toolsets: Sequence[AbstractToolset[AgentDepsT]] | _utils.Unset = _utils.UNSET,
Expand All @@ -874,6 +875,7 @@ def override(
You can find an example of this [here](../testing.md#overriding-model-via-pytest-fixtures).

Args:
name: The name to use instead of the name passed to the agent constructor and agent run.
deps: The dependencies to use instead of the dependencies passed to the agent run.
model: The model to use instead of the model passed to the agent run.
toolsets: The toolsets to use instead of the toolsets passed to the agent constructor and agent run.
Expand All @@ -895,6 +897,7 @@ def override(
)

with super().override(
name=name,
deps=deps,
model=model,
toolsets=toolsets,
Expand Down
8 changes: 8 additions & 0 deletions tests/test_agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2537,6 +2537,14 @@ async def test_agent_name_changes():
assert new_agent.name == 'my_agent'


def test_agent_name_override():
agent = Agent('test', name='custom_name')

with agent.override(name='overridden_name'):
agent.run_sync('Hello')
assert agent.name == 'overridden_name'


def test_name_from_global(create_module: Callable[[str], Any]):
module_code = """
from pydantic_ai import Agent
Expand Down