Skip to content

fix: return literal text for unresolved session state variables instead of KeyError #5711

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

Open
zhoufengen wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −8
Open

fix: return literal text for unresolved session state variables instead of KeyError #5711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion src/google/adk/utils/instructions_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,11 @@ async def _replace_match(match) -> str:
)
return ''
else:
raise KeyError(f'Context variable not found: `{var_name}`.')
logger.debug(
'Context variable %s not found in session state, returning as-is',
var_name,
)
return match.group()

return await _async_sub(r'{+[^{}]*}+', _replace_match, template)

Expand Down
26 changes: 19 additions & 7 deletions tests/unittests/utils/test_instructions_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,30 @@ async def test_inject_session_state_with_optional_state():


@pytest.mark.asyncio
async def test_inject_session_state_with_missing_state_raises_key_error():
async def test_inject_session_state_with_missing_state_returns_literal():
instruction_template = "Hello {missing_key}!"
invocation_context = await _create_test_readonly_context(
state={"user_name": "Foo"}
)

with pytest.raises(
KeyError, match="Context variable not found: `missing_key`."
):
await instructions_utils.inject_session_state(
instruction_template, invocation_context
)
populated_instruction = await instructions_utils.inject_session_state(
instruction_template, invocation_context
)
assert populated_instruction == "Hello {missing_key}!"


@pytest.mark.asyncio
async def test_inject_session_state_preserves_literal_identifier_patterns():
"""Literal {identifier} patterns in docs/tool descriptions should not crash."""
instruction_template = (
"The formatString supports interpolation via {expression} syntax."
)
invocation_context = await _create_test_readonly_context()

populated_instruction = await instructions_utils.inject_session_state(
instruction_template, invocation_context
)
assert populated_instruction == instruction_template


@pytest.mark.asyncio
Expand Down
Loading