Skip to content

Commit 728abe4

Browse files
DeanChensjcopybara-github
authored andcommitted
feat(agents): Add warning for duplicate sub-agent names
Co-authored-by: Shangjie Chen <deanchen@google.com> PiperOrigin-RevId: 836409638
1 parent 4eb2a11 commit 728abe4

File tree

2 files changed

+149
-0
lines changed

2 files changed

+149
-0
lines changed

src/google/adk/agents/base_agent.py

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
from __future__ import annotations
1616

1717
import inspect
18+
import logging
1819
from typing import Any
1920
from typing import AsyncGenerator
2021
from typing import Awaitable
@@ -49,6 +50,8 @@
4950
if TYPE_CHECKING:
5051
from .invocation_context import InvocationContext
5152

53+
logger = logging.getLogger('google_adk.' + __name__)
54+
5255
_SingleAgentCallback: TypeAlias = Callable[
5356
[CallbackContext],
5457
Union[Awaitable[Optional[types.Content]], Optional[types.Content]],
@@ -563,6 +566,45 @@ def validate_name(cls, value: str):
563566
)
564567
return value
565568

569+
@field_validator('sub_agents', mode='after')
570+
@classmethod
571+
def validate_sub_agents_unique_names(
572+
cls, value: list[BaseAgent]
573+
) -> list[BaseAgent]:
574+
"""Validates that all sub-agents have unique names.
575+
576+
Args:
577+
value: The list of sub-agents to validate.
578+
579+
Returns:
580+
The validated list of sub-agents.
581+
582+
"""
583+
if not value:
584+
return value
585+
586+
seen_names: set[str] = set()
587+
duplicates: set[str] = set()
588+
589+
for sub_agent in value:
590+
name = sub_agent.name
591+
if name in seen_names:
592+
duplicates.add(name)
593+
else:
594+
seen_names.add(name)
595+
596+
if duplicates:
597+
duplicate_names_str = ', '.join(
598+
f'`{name}`' for name in sorted(duplicates)
599+
)
600+
logger.warning(
601+
'Found duplicate sub-agent names: %s. '
602+
'All sub-agents must have unique names.',
603+
duplicate_names_str,
604+
)
605+
606+
return value
607+
566608
def __set_parent_agent_for_sub_agents(self) -> BaseAgent:
567609
for sub_agent in self.sub_agents:
568610
if sub_agent.parent_agent is not None:

tests/unittests/agents/test_base_agent.py

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
from enum import Enum
1818
from functools import partial
19+
import logging
1920
from typing import AsyncGenerator
2021
from typing import List
2122
from typing import Optional
@@ -854,6 +855,112 @@ def test_set_parent_agent_for_sub_agent_twice(
854855
)
855856

856857

858+
def test_validate_sub_agents_unique_names_single_duplicate(
859+
request: pytest.FixtureRequest,
860+
caplog: pytest.LogCaptureFixture,
861+
):
862+
"""Test that duplicate sub-agent names logs a warning."""
863+
duplicate_name = f'{request.function.__name__}_duplicate_agent'
864+
sub_agent_1 = _TestingAgent(name=duplicate_name)
865+
sub_agent_2 = _TestingAgent(name=duplicate_name)
866+
867+
with caplog.at_level(logging.WARNING):
868+
_ = _TestingAgent(
869+
name=f'{request.function.__name__}_parent',
870+
sub_agents=[sub_agent_1, sub_agent_2],
871+
)
872+
assert f'Found duplicate sub-agent names: `{duplicate_name}`' in caplog.text
873+
874+
875+
def test_validate_sub_agents_unique_names_multiple_duplicates(
876+
request: pytest.FixtureRequest,
877+
caplog: pytest.LogCaptureFixture,
878+
):
879+
"""Test that multiple duplicate sub-agent names are all reported."""
880+
duplicate_name_1 = f'{request.function.__name__}_duplicate_1'
881+
duplicate_name_2 = f'{request.function.__name__}_duplicate_2'
882+
883+
sub_agents = [
884+
_TestingAgent(name=duplicate_name_1),
885+
_TestingAgent(name=f'{request.function.__name__}_unique'),
886+
_TestingAgent(name=duplicate_name_1), # First duplicate
887+
_TestingAgent(name=duplicate_name_2),
888+
_TestingAgent(name=duplicate_name_2), # Second duplicate
889+
]
890+
891+
with caplog.at_level(logging.WARNING):
892+
_ = _TestingAgent(
893+
name=f'{request.function.__name__}_parent',
894+
sub_agents=sub_agents,
895+
)
896+
897+
# Verify each duplicate name appears exactly once in the error message
898+
assert caplog.text.count(duplicate_name_1) == 1
899+
assert caplog.text.count(duplicate_name_2) == 1
900+
# Verify both duplicate names are present
901+
assert duplicate_name_1 in caplog.text
902+
assert duplicate_name_2 in caplog.text
903+
904+
905+
def test_validate_sub_agents_unique_names_triple_duplicate(
906+
request: pytest.FixtureRequest,
907+
caplog: pytest.LogCaptureFixture,
908+
):
909+
"""Test that a name appearing three times is reported only once."""
910+
duplicate_name = f'{request.function.__name__}_triple_duplicate'
911+
912+
sub_agents = [
913+
_TestingAgent(name=duplicate_name),
914+
_TestingAgent(name=f'{request.function.__name__}_unique'),
915+
_TestingAgent(name=duplicate_name), # Second occurrence
916+
_TestingAgent(name=duplicate_name), # Third occurrence
917+
]
918+
919+
with caplog.at_level(logging.WARNING):
920+
_ = _TestingAgent(
921+
name=f'{request.function.__name__}_parent',
922+
sub_agents=sub_agents,
923+
)
924+
925+
# Verify the duplicate name appears exactly once in the error message
926+
# (not three times even though it appears three times in the list)
927+
assert caplog.text.count(duplicate_name) == 1
928+
assert duplicate_name in caplog.text
929+
930+
931+
def test_validate_sub_agents_unique_names_no_duplicates(
932+
request: pytest.FixtureRequest,
933+
):
934+
"""Test that unique sub-agent names pass validation."""
935+
sub_agents = [
936+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_1'),
937+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_2'),
938+
_TestingAgent(name=f'{request.function.__name__}_sub_agent_3'),
939+
]
940+
941+
parent = _TestingAgent(
942+
name=f'{request.function.__name__}_parent',
943+
sub_agents=sub_agents,
944+
)
945+
946+
assert len(parent.sub_agents) == 3
947+
assert parent.sub_agents[0].name == f'{request.function.__name__}_sub_agent_1'
948+
assert parent.sub_agents[1].name == f'{request.function.__name__}_sub_agent_2'
949+
assert parent.sub_agents[2].name == f'{request.function.__name__}_sub_agent_3'
950+
951+
952+
def test_validate_sub_agents_unique_names_empty_list(
953+
request: pytest.FixtureRequest,
954+
):
955+
"""Test that empty sub-agents list passes validation."""
956+
parent = _TestingAgent(
957+
name=f'{request.function.__name__}_parent',
958+
sub_agents=[],
959+
)
960+
961+
assert len(parent.sub_agents) == 0
962+
963+
857964
if __name__ == '__main__':
858965
pytest.main([__file__])
859966

0 commit comments

Comments
 (0)