Skip to content

The agent engineering platform.

chore(langchain): fix types in `test_overrides` (#34635)

Christophe Bornet5e9765d8116f
diff --git a/libs/langchain_v1/tests/unit_tests/agents/middleware/core/test_overrides.py b/libs/langchain_v1/tests/unit_tests/agents/middleware/core/test_overrides.py
index dcbbff39e6..0051538064 100644
--- a/libs/langchain_v1/tests/unit_tests/agents/middleware/core/test_overrides.py
+++ b/libs/langchain_v1/tests/unit_tests/agents/middleware/core/test_overrides.py
@@ -1,9 +1,20 @@
"""Unit tests for override() methods on ModelRequest and ToolCallRequest."""
+from typing import Any
+from unittest.mock import Mock
+
+import pytest
from langchain_core.language_models.fake_chat_models import GenericFakeChatModel
-from langchain_core.messages import AIMessage, HumanMessage
+from langchain_core.messages import (
+ AIMessage,
+ AnyMessage,
+ HumanMessage,
+ SystemMessage,
+ ToolCall,
+)
from langchain_core.tools import tool
+from langchain.agents import AgentState
from langchain.agents.middleware.types import ModelRequest, ToolCallRequest
@@ -15,16 +26,16 @@ class TestModelRequestOverride:
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
original_request = ModelRequest(
model=model,
- system_prompt="Original prompt",
+ system_message=SystemMessage("Original prompt"),
messages=[HumanMessage("Hi")],
tool_choice=None,
tools=[],
response_format=None,
- state={},
+ state=AgentState(messages=[]),
runtime=None,
)
- new_request = original_request.override(system_prompt="New prompt")
+ new_request = original_request.override(system_message=SystemMessage("New prompt"))
# New request should have the overridden value
assert new_request.system_prompt == "New prompt"
@@ -36,47 +47,51 @@ class TestModelRequestOverride:
def test_override_multiple_attributes(self) -> None:
"""Test overriding multiple attributes at once."""
+
+ class CustomState(AgentState[Any]):
+ count: int
+
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
original_request = ModelRequest(
model=model,
- system_prompt="Original prompt",
+ system_message=SystemMessage("Original prompt"),
messages=[HumanMessage("Hi")],
tool_choice=None,
tools=[],
response_format=None,
- state={"count": 1},
+ state=CustomState(messages=[], count=1),
runtime=None,
)
new_request = original_request.override(
- system_prompt="New prompt",
+ system_message=SystemMessage("New prompt"),
tool_choice="auto",
- state={"count": 2},
+ state=CustomState(messages=[], count=2),
)
# Overridden values should be changed
assert new_request.system_prompt == "New prompt"
assert new_request.tool_choice == "auto"
- assert new_request.state == {"count": 2}
+ assert new_request.state == CustomState(messages=[], count=2)
# Original should be unchanged
assert original_request.system_prompt == "Original prompt"
assert original_request.tool_choice is None
- assert original_request.state == {"count": 1}
+ assert original_request.state == CustomState(messages=[], count=1)
def test_override_messages(self) -> None:
"""Test overriding messages list."""
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
- original_messages = [HumanMessage("Hi")]
- new_messages = [HumanMessage("Hello"), AIMessage("Hi there")]
+ original_messages: list[AnyMessage] = [HumanMessage("Hi")]
+ new_messages: list[AnyMessage] = [HumanMessage("Hello"), AIMessage("Hi there")]
original_request = ModelRequest(
model=model,
- system_prompt=None,
+ system_message=None,
messages=original_messages,
tool_choice=None,
tools=[],
response_format=None,
- state={},
+ state=AgentState(messages=[]),
runtime=None,
)
@@ -92,12 +107,12 @@ class TestModelRequestOverride:
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
original_request = ModelRequest(
model=model,
- system_prompt=None,
+ system_message=None,
messages=[HumanMessage("Hi")],
tool_choice=None,
tools=[],
response_format=None,
- state={},
+ state=AgentState(messages=[]),
runtime=None,
model_settings={"temperature": 0.5},
)
@@ -114,34 +129,35 @@ class TestModelRequestOverride:
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
original_request = ModelRequest(
model=model,
- system_prompt="Original prompt",
+ system_message=SystemMessage("Original prompt"),
messages=[HumanMessage("Hi")],
tool_choice="auto",
tools=[],
response_format=None,
- state={},
+ state=AgentState(messages=[]),
runtime=None,
)
new_request = original_request.override(
- system_prompt=None,
+ system_message=None,
tool_choice=None,
)
- assert new_request.system_prompt is None
+ assert new_request.system_message is None
assert new_request.tool_choice is None
- assert original_request.system_prompt == "Original prompt"
+ assert original_request.system_message == SystemMessage("Original prompt")
assert original_request.tool_choice == "auto"
def test_override_preserves_identity_of_unchanged_objects(self) -> None:
"""Test that unchanged attributes maintain object identity."""
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
- messages = [HumanMessage("Hi")]
- state = {"key": "value"}
+ messages: list[AnyMessage] = [HumanMessage("Hi")]
+
+ state = AgentState[Any](messages=[])
original_request = ModelRequest(
model=model,
- system_prompt="Original prompt",
+ system_message=SystemMessage("Original prompt"),
messages=messages,
tool_choice=None,
tools=[],
@@ -150,7 +166,7 @@ class TestModelRequestOverride:
runtime=None,
)
- new_request = original_request.override(system_prompt="New prompt")
+ new_request = original_request.override(system_message=SystemMessage("New prompt"))
# Unchanged objects should be the same instance
assert new_request.messages is messages
@@ -159,32 +175,83 @@ class TestModelRequestOverride:
def test_override_chaining(self) -> None:
"""Test chaining multiple override calls."""
+
+ class CustomState(AgentState[Any]):
+ count: int
+
model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
original_request = ModelRequest(
model=model,
- system_prompt="Prompt 1",
+ system_message=SystemMessage("Prompt 1"),
messages=[HumanMessage("Hi")],
tool_choice=None,
tools=[],
response_format=None,
- state={"count": 1},
+ state=CustomState(messages=[], count=1),
runtime=None,
)
final_request = (
- original_request.override(system_prompt="Prompt 2")
- .override(state={"count": 2})
+ original_request.override(system_message=SystemMessage("Prompt 2"))
+ .override(state=CustomState(messages=[], count=2))
.override(tool_choice="auto")
)
assert final_request.system_prompt == "Prompt 2"
- assert final_request.state == {"count": 2}
+ assert final_request.state == CustomState(messages=[], count=2)
assert final_request.tool_choice == "auto"
# Original should be unchanged
assert original_request.system_prompt == "Prompt 1"
- assert original_request.state == {"count": 1}
+ assert original_request.state == CustomState(messages=[], count=1)
assert original_request.tool_choice is None
+ def test_override_raises_on_both_system_prompt_and_system_message(self) -> None:
+ """Test that `ValueError` is raised when both prompt params are provided."""
+ model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
+ request = ModelRequest(
+ model=model,
+ system_message=None,
+ messages=[HumanMessage("Hi")],
+ tool_choice=None,
+ tools=[],
+ response_format=None,
+ state=AgentState(messages=[]),
+ runtime=None,
+ )
+
+ with pytest.raises(
+ ValueError, match="Cannot specify both system_prompt and system_message"
+ ):
+ request.override(
+ system_prompt="prompt", # type: ignore[call-arg]
+ system_message=SystemMessage("message"),
+ )
+
+ def test_override_system_prompt_backward_compatibility(self) -> None:
+ """Test that `system_prompt` kwarg in `override()` converts to `SystemMessage`."""
+ model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))
+ original_request = ModelRequest(
+ model=model,
+ system_message=None,
+ messages=[HumanMessage("Hi")],
+ tool_choice=None,
+ tools=[],
+ response_format=None,
+ state=AgentState(messages=[]),
+ runtime=None,
+ )
+
+ # Use deprecated system_prompt parameter
+ new_request = original_request.override(
+ system_prompt="New prompt via deprecated param" # type: ignore[call-arg]
+ )
+
+ assert new_request.system_prompt == "New prompt via deprecated param"
+ assert isinstance(new_request.system_message, SystemMessage)
+ assert new_request.system_message.content == "New prompt via deprecated param"
+ # Original unchanged
+ assert original_request.system_message is None
+
class TestToolCallRequestOverride:
"""Test the ToolCallRequest.override() method."""
@@ -197,14 +264,14 @@ class TestToolCallRequestOverride:
"""A test tool."""
return f"Result: {x}"
- original_call = {"name": "test_tool", "args": {"x": 5}, "id": "1", "type": "tool_call"}
- modified_call = {"name": "test_tool", "args": {"x": 10}, "id": "1", "type": "tool_call"}
+ original_call = ToolCall(name="test_tool", args={"x": 5}, id="1", type="tool_call")
+ modified_call = ToolCall(name="test_tool", args={"x": 10}, id="1", type="tool_call")
original_request = ToolCallRequest(
tool_call=original_call,
tool=test_tool,
state={"messages": []},
- runtime=None,
+ runtime=Mock(),
)
new_request = original_request.override(tool_call=modified_call)
@@ -225,7 +292,7 @@ class TestToolCallRequestOverride:
"""A test tool."""
return f"Result: {x}"
- tool_call = {"name": "test_tool", "args": {"x": 5}, "id": "1", "type": "tool_call"}
+ tool_call = ToolCall(name="test_tool", args={"x": 5}, id="1", type="tool_call")
original_state = {"messages": [HumanMessage("Hi")]}
new_state = {"messages": [HumanMessage("Hi"), AIMessage("Hello")]}
@@ -233,7 +300,7 @@ class TestToolCallRequestOverride:
tool_call=tool_call,
tool=test_tool,
state=original_state,
- runtime=None,
+ runtime=Mock(),
)
new_request = original_request.override(state=new_state)
@@ -254,19 +321,19 @@ class TestToolCallRequestOverride:
"""Another test tool."""
return f"Output: {y}"
- original_call = {"name": "test_tool", "args": {"x": 5}, "id": "1", "type": "tool_call"}
- modified_call = {
- "name": "another_tool",
- "args": {"y": "hello"},
- "id": "2",
- "type": "tool_call",
- }
+ original_call = ToolCall(name="test_tool", args={"x": 5}, id="1", type="tool_call")
+ modified_call = ToolCall(
+ name="another_tool",
+ args={"y": "hello"},
+ id="2",
+ type="tool_call",
+ )
original_request = ToolCallRequest(
tool_call=original_call,
tool=test_tool,
state={"count": 1},
- runtime=None,
+ runtime=Mock(),
)
new_request = original_request.override(
@@ -276,10 +343,12 @@ class TestToolCallRequestOverride:
)
assert new_request.tool_call["name"] == "another_tool"
+ assert new_request.tool is not None
assert new_request.tool.name == "another_tool"
assert new_request.state == {"count": 2}
# Original unchanged
assert original_request.tool_call["name"] == "test_tool"
+ assert original_request.tool is not None
assert original_request.tool.name == "test_tool"
assert original_request.state == {"count": 1}
@@ -291,22 +360,22 @@ class TestToolCallRequestOverride:
"""A test tool."""
return f"Result: {value}"
- original_call = {
- "name": "test_tool",
- "args": {"value": 5},
- "id": "call_123",
- "type": "tool_call",
- }
+ original_call = ToolCall(
+ name="test_tool",
+ args={"value": 5},
+ id="call_123",
+ type="tool_call",
+ )
original_request = ToolCallRequest(
tool_call=original_call,
tool=test_tool,
- state={},
- runtime=None,
+ state=AgentState(messages=[]),
+ runtime=Mock(),
)
# Common pattern: copy tool_call and modify args
- modified_call = {**original_request.tool_call, "args": {"value": 10}}
+ modified_call = ToolCall({**original_request.tool_call, "args": {"value": 10}})
new_request = original_request.override(tool_call=modified_call)
assert new_request.tool_call["args"]["value"] == 10
@@ -323,17 +392,17 @@ class TestToolCallRequestOverride:
"""A test tool."""
return f"Result: {x}"
- tool_call = {"name": "test_tool", "args": {"x": 5}, "id": "1", "type": "tool_call"}
- state = {"messages": []}
+ tool_call = ToolCall(name="test_tool", args={"x": 5}, id="1", type="tool_call")
+ state = AgentState[Any](messages=[])
original_request = ToolCallRequest(
tool_call=tool_call,
tool=test_tool,
state=state,
- runtime=None,
+ runtime=Mock(),
)
- new_call = {"name": "test_tool", "args": {"x": 10}, "id": "1", "type": "tool_call"}
+ new_call = ToolCall(name="test_tool", args={"x": 10}, id="1", type="tool_call")
new_request = original_request.override(tool_call=new_call)
# Unchanged objects should be the same instance
@@ -348,17 +417,17 @@ class TestToolCallRequestOverride:
"""A test tool."""
return f"Result: {x}"
- tool_call = {"name": "test_tool", "args": {"x": 5}, "id": "1", "type": "tool_call"}
+ tool_call = ToolCall(name="test_tool", args={"x": 5}, id="1", type="tool_call")
original_request = ToolCallRequest(
tool_call=tool_call,
tool=test_tool,
state={"count": 1},
- runtime=None,
+ runtime=Mock(),
)
- call_2 = {"name": "test_tool", "args": {"x": 10}, "id": "1", "type": "tool_call"}
- call_3 = {"name": "test_tool", "args": {"x": 15}, "id": "1", "type": "tool_call"}
+ call_2 = ToolCall(name="test_tool", args={"x": 10}, id="1", type="tool_call")
+ call_3 = ToolCall(name="test_tool", args={"x": 15}, id="1", type="tool_call")
final_request = (
original_request.override(tool_call=call_2)