The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
chore(langchain): fix types in `test_system_message` (#34634)
Christophe Bornetd1404e63bbbf
diff --git a/libs/langchain_v1/tests/unit_tests/agents/test_system_message.py b/libs/langchain_v1/tests/unit_tests/agents/test_system_message.pyindex f12027935c..a1ac2b5757 100644--- a/libs/langchain_v1/tests/unit_tests/agents/test_system_message.py+++ b/libs/langchain_v1/tests/unit_tests/agents/test_system_message.py@@ -13,29 +13,19 @@ This module consolidates all system message and dynamic prompt tests:These tests replicate functionality from langchainjs PR #9459."""-from typing import cast+from collections.abc import Callable+from dataclasses import dataclass+from typing import Anyimport pytestfrom langchain_core.language_models.fake_chat_models import GenericFakeChatModel-from langchain_core.messages import AIMessage, HumanMessage, SystemMessage+from langchain_core.messages import AIMessage, HumanMessage, SystemMessage, TextContentBlockfrom langgraph.runtime import Runtimefrom langchain.agents.factory import create_agentfrom langchain.agents.middleware.types import AgentState, ModelRequest, ModelResponse-def _fake_runtime(context: dict | None = None) -> Runtime:- """Create a fake runtime with optional context."""- if context:- # Create a simple object with context- class FakeRuntime:- def __init__(self):- self.context = type("Context", (), context)()-- return cast("Runtime", FakeRuntime())- return cast("Runtime", object())--def _make_request(system_message: SystemMessage | None = None,system_prompt: str | None = None,@@ -50,8 +40,8 @@ def _make_request(tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),model_settings={},)@@ -81,7 +71,11 @@ class TestModelRequestSystemMessage:],)def test_create_with_various_system_inputs(- self, system_message, system_prompt, expected_msg, expected_prompt+ self,+ system_message: SystemMessage | None,+ system_prompt: str | None,+ expected_msg: SystemMessage | None,+ expected_prompt: str | None,) -> None:"""Test creating ModelRequest with various system message inputs."""model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))@@ -94,13 +88,14 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)if expected_msg is None:assert request.system_message is Noneelse:+ assert request.system_message is not Noneassert request.system_message.content == expected_msg.contentassert request.system_prompt == expected_prompt@@ -116,7 +111,7 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)@@ -130,7 +125,7 @@ class TestModelRequestSystemMessage:("system_prompt", "New prompt"),],)- def test_override_methods(self, override_with, expected_text) -> None:+ def test_override_methods(self, override_with: str, expected_text: str) -> None:"""Test override() with system_message and system_prompt parameters."""model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))original_msg = SystemMessage(content="Original")@@ -142,14 +137,15 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)if override_with == "system_message":new_request = original_request.override(system_message=SystemMessage(content="New"))else: # system_prompt- new_request = original_request.override(system_prompt="New prompt")+ # system_prompt is deprecated but supported at runtime for backward compatibility+ new_request = original_request.override(system_prompt="New prompt") # type: ignore[call-arg]assert isinstance(new_request.system_message, SystemMessage)assert new_request.system_prompt == expected_text@@ -166,11 +162,12 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)- new_request = original_request.override(system_prompt=None)+ # system_prompt is deprecated but supported at runtime for backward compatibility+ new_request = original_request.override(system_prompt=None) # type: ignore[call-arg]assert new_request.system_message is Noneassert new_request.system_prompt is None@@ -180,7 +177,9 @@ class TestModelRequestSystemMessage:[True, False],ids=["constructor", "override"],)- def test_cannot_set_both_system_prompt_and_system_message(self, use_constructor) -> None:+ def test_cannot_set_both_system_prompt_and_system_message(+ self, *, use_constructor: bool+ ) -> None:"""Test that setting both system_prompt and system_message raises error."""model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))@@ -194,7 +193,7 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)else:@@ -205,11 +204,12 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)with pytest.raises(ValueError, match="Cannot specify both"):- request.override(+ # system_prompt is deprecated but supported at runtime for backward compatibility+ request.override( # type: ignore[call-arg]system_prompt="String prompt",system_message=SystemMessage(content="Message prompt"),)@@ -221,7 +221,9 @@ class TestModelRequestSystemMessage:(None, True),],)- def test_setattr_system_prompt_deprecated(self, new_value, should_be_none) -> None:+ def test_setattr_system_prompt_deprecated(+ self, new_value: str | None, *, should_be_none: bool+ ) -> None:"""Test that setting system_prompt via setattr raises deprecation warning."""model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))@@ -232,19 +234,19 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)with pytest.warns(DeprecationWarning, match="system_prompt is deprecated"):- request.system_prompt = new_value+ request.system_prompt = new_value # type: ignore[misc]if should_be_none:assert request.system_message is Noneassert request.system_prompt is Noneelse:assert isinstance(request.system_message, SystemMessage)- assert request.system_message.content_blocks[0]["text"] == new_value+ assert request.system_message.content_blocks[0].get("text") == new_valuedef test_system_message_with_complex_content(self) -> None:"""Test SystemMessage with complex content (list of dicts)."""@@ -263,10 +265,11 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)+ assert request.system_message is not Noneassert isinstance(request.system_message.content_blocks, list)assert len(request.system_message.content_blocks) == 2assert request.system_message.content_blocks[1].get("cache_control") == {@@ -284,7 +287,7 @@ class TestModelRequestSystemMessage:tool_choice=None,tools=[],response_format=None,- state={},+ state=AgentState(messages=[]),runtime=None,)@@ -337,7 +340,9 @@ class TestCreateAgentSystemMessage:"system_message_with_complex_content",],)- def test_create_agent_with_various_system_prompts(self, system_prompt) -> None:+ def test_create_agent_with_various_system_prompts(+ self, system_prompt: SystemMessage | str | None+ ) -> None:"""Test create_agent accepts various system_prompt formats."""model = GenericFakeChatModel(messages=iter([AIMessage(content="Hello")]))@@ -362,7 +367,7 @@ class TestSystemMessageUpdateViaMiddleware:def set_system_message_middleware(request: ModelRequest,- handler,+ handler: Callable[[ModelRequest], ModelResponse],) -> ModelResponse:"""Middleware that sets initial system message."""new_request = request.override(@@ -378,8 +383,8 @@ class TestSystemMessageUpdateViaMiddleware:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)captured_request = None@@ -394,14 +399,14 @@ class TestSystemMessageUpdateViaMiddleware:assert captured_request is not Noneassert captured_request.system_message is not Noneassert len(captured_request.system_message.content_blocks) == 1- assert captured_request.system_message.content_blocks[0]["text"] == "Set by middleware"+ assert captured_request.system_message.content_blocks[0].get("text") == "Set by middleware"def test_middleware_can_update_via_system_message_object(self) -> None:"""Test middleware updating system message using SystemMessage objects."""def append_with_metadata_middleware(request: ModelRequest,- handler,+ handler: Callable[[ModelRequest], ModelResponse],) -> ModelResponse:"""Append using SystemMessage to preserve metadata."""base_content = request.system_message.text if request.system_message else ""@@ -424,8 +429,8 @@ class TestSystemMessageUpdateViaMiddleware:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)captured_request = None@@ -438,6 +443,7 @@ class TestSystemMessageUpdateViaMiddleware:append_with_metadata_middleware(request, mock_handler)assert captured_request is not None+ assert captured_request.system_message is not Noneassert captured_request.system_message.text == "Base prompt Additional instructions."assert captured_request.system_message.additional_kwargs["base"] == "value"assert captured_request.system_message.additional_kwargs["middleware"] == "applied"@@ -449,7 +455,9 @@ class TestMultipleMiddlewareChaining:def test_multiple_middleware_can_chain_modifications(self) -> None:"""Test that multiple middleware can modify system message sequentially."""- def first_middleware(request: ModelRequest, handler) -> ModelResponse:+ def first_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""First middleware sets base system message."""new_request = request.override(system_message=SystemMessage(@@ -459,8 +467,11 @@ class TestMultipleMiddlewareChaining:)return handler(new_request)- def second_middleware(request: ModelRequest, handler) -> ModelResponse:+ def second_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Second middleware appends to system message."""+ assert request.system_message is not Nonecurrent_content = request.system_message.textcurrent_kwargs = request.system_message.additional_kwargs@@ -472,8 +483,11 @@ class TestMultipleMiddlewareChaining:)return handler(new_request)- def third_middleware(request: ModelRequest, handler) -> ModelResponse:+ def third_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Third middleware appends to system message."""+ assert request.system_message is not Nonecurrent_content = request.system_message.textcurrent_kwargs = request.system_message.additional_kwargs@@ -493,12 +507,13 @@ class TestMultipleMiddlewareChaining:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)def final_handler(req: ModelRequest) -> ModelResponse:# Verify all middleware applied+ assert req.system_message is not Noneassert req.system_message.text == "Base prompt + middleware 2 + middleware 3"assert req.system_message.additional_kwargs["middleware_1"] == "applied"assert req.system_message.additional_kwargs["middleware_2"] == "applied"@@ -514,12 +529,16 @@ class TestMultipleMiddlewareChaining:def test_middleware_can_mix_string_and_system_message_updates(self) -> None:"""Test mixing string and SystemMessage updates across middleware."""- def string_middleware(request: ModelRequest, handler) -> ModelResponse:+ def string_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Use string-based update."""- new_request = request.override(system_prompt="String prompt")+ new_request = request.override(system_message=SystemMessage(content="String prompt"))return handler(new_request)- def system_message_middleware(request: ModelRequest, handler) -> ModelResponse:+ def system_message_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Use SystemMessage-based update."""current_content = request.system_message.text if request.system_message else ""new_request = request.override(@@ -538,13 +557,14 @@ class TestMultipleMiddlewareChaining:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)def final_handler(req: ModelRequest) -> ModelResponse:+ assert req.system_message is not Noneassert req.system_message.text == "String prompt + SystemMessage"- assert req.system_message.additional_kwargs["metadata"] == "added"+ assert req.system_message.additional_kwargs.get("metadata") == "added"return ModelResponse(result=[AIMessage(content="response")])string_middleware(request, lambda req: system_message_middleware(req, final_handler))@@ -556,7 +576,9 @@ class TestCacheControlPreservation:def test_middleware_can_add_cache_control(self) -> None:"""Test middleware adding cache control to system message."""- def cache_control_middleware(request: ModelRequest, handler) -> ModelResponse:+ def cache_control_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Add cache control to system message."""new_message = SystemMessage(content=[@@ -579,8 +601,8 @@ class TestCacheControlPreservation:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)captured_request = None@@ -593,15 +615,18 @@ class TestCacheControlPreservation:cache_control_middleware(request, mock_handler)assert captured_request is not None+ assert captured_request.system_message is not Noneassert isinstance(captured_request.system_message.content_blocks, list)- assert captured_request.system_message.content_blocks[1]["cache_control"] == {+ assert captured_request.system_message.content_blocks[1].get("cache_control") == {"type": "ephemeral"}def test_cache_control_preserved_across_middleware(self) -> None:"""Test that cache control is preserved when middleware modifies message."""- def first_middleware_with_cache(request: ModelRequest, handler) -> ModelResponse:+ def first_middleware_with_cache(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Set system message with cache control."""new_message = SystemMessage(content=[@@ -615,12 +640,15 @@ class TestCacheControlPreservation:new_request = request.override(system_message=new_message)return handler(new_request)- def second_middleware_appends(request: ModelRequest, handler) -> ModelResponse:+ def second_middleware_appends(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Append to system message while preserving cache control."""+ assert request.system_message is not Noneexisting_content = request.system_message.content_blocks- new_content = [*existing_content, {"type": "text", "text": "Additional text"}]+ new_content = [*existing_content, TextContentBlock(type="text", text="Additional text")]- new_message = SystemMessage(content=new_content)+ new_message = SystemMessage(content_blocks=new_content)new_request = request.override(system_message=new_message)return handler(new_request)@@ -632,15 +660,18 @@ class TestCacheControlPreservation:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)def final_handler(req: ModelRequest) -> ModelResponse:# Verify cache control was preserved+ assert req.system_message is not Noneassert isinstance(req.system_message.content_blocks, list)assert len(req.system_message.content_blocks) == 2- assert req.system_message.content_blocks[0]["cache_control"] == {"type": "ephemeral"}+ assert req.system_message.content_blocks[0].get("cache_control") == {+ "type": "ephemeral"+ }return ModelResponse(result=[AIMessage(content="response")])first_middleware_with_cache(@@ -672,7 +703,11 @@ class TestMetadataMerging:ids=["additional_kwargs", "response_metadata"],)def test_metadata_merge_across_updates(- self, metadata_type, initial_metadata, update_metadata, expected_result+ self,+ metadata_type: str,+ initial_metadata: dict[str, Any],+ update_metadata: dict[str, Any],+ expected_result: dict[str, Any],) -> None:"""Test that metadata merges correctly when updating system message."""base_message = SystemMessage(@@ -680,7 +715,9 @@ class TestMetadataMerging:**{metadata_type: initial_metadata},)- def update_middleware(request: ModelRequest, handler) -> ModelResponse:+ def update_middleware(+ request: ModelRequest, handler: Callable[[ModelRequest], ModelResponse]+ ) -> ModelResponse:"""Update system message, merging metadata."""current_metadata = getattr(request.system_message, metadata_type)new_metadata = {**current_metadata, **update_metadata}@@ -698,8 +735,8 @@ class TestMetadataMerging:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)captured_request = None@@ -731,7 +768,11 @@ class TestDynamicSystemPromptMiddleware:region = getattr(request.runtime.context, "region", "n/a")return SystemMessage(content=f"You are a helpful assistant. Region: {region}")- runtime = _fake_runtime(context={"region": "EU"})+ @dataclass+ class RegionContext:+ region: str++ runtime = Runtime(context=RegionContext(region="EU"))request = ModelRequest(model=GenericFakeChatModel(messages=iter([AIMessage(content="response")])),system_message=None,@@ -739,7 +780,7 @@ class TestDynamicSystemPromptMiddleware:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]+ state=AgentState(messages=[]),runtime=runtime,model_settings={},)@@ -749,7 +790,7 @@ class TestDynamicSystemPromptMiddleware:assert isinstance(new_system_message, SystemMessage)assert len(new_system_message.content_blocks) == 1assert (- new_system_message.content_blocks[0]["text"]+ new_system_message.content_blocks[0].get("text")== "You are a helpful assistant. Region: EU")@@ -768,7 +809,7 @@ class TestDynamicSystemPromptMiddleware:new_system_message = metadata_middleware(request)assert len(new_system_message.content_blocks) == 1- assert new_system_message.content_blocks[0]["text"] == "You are a helpful assistant"+ assert new_system_message.content_blocks[0].get("text") == "You are a helpful assistant"assert new_system_message.additional_kwargs == {"temperature": 0.7,"model": "gpt-4",@@ -789,7 +830,7 @@ class TestDynamicSystemPromptMiddleware:assert isinstance(new_system_message, SystemMessage)assert len(new_system_message.content_blocks) == 1- assert new_system_message.content_blocks[0]["text"] == "Default system prompt"+ assert new_system_message.content_blocks[0].get("text") == "Default system prompt"def test_middleware_with_content_blocks(self) -> None:"""Test middleware creating SystemMessage with content blocks."""@@ -812,8 +853,8 @@ class TestDynamicSystemPromptMiddleware:assert isinstance(new_system_message.content_blocks, list)assert len(new_system_message.content_blocks) == 2- assert new_system_message.content_blocks[0]["text"] == "Base instructions"- assert new_system_message.content_blocks[1]["cache_control"] == {"type": "ephemeral"}+ assert new_system_message.content_blocks[0].get("text") == "Base instructions"+ assert new_system_message.content_blocks[1].get("cache_control") == {"type": "ephemeral"}class TestSystemMessageMiddlewareIntegration:@@ -832,6 +873,7 @@ class TestSystemMessageMiddlewareIntegration:def second_middleware(request: ModelRequest) -> ModelRequest:"""Second middleware appends to system message."""+ assert request.system_message is not Nonecurrent_content = request.system_message.textnew_content = current_content + " Be helpful."@@ -850,14 +892,17 @@ class TestSystemMessageMiddlewareIntegration:# Apply middleware in sequencerequest = first_middleware(request)+ assert request.system_message is not Noneassert len(request.system_message.content_blocks) == 1- assert request.system_message.content_blocks[0]["text"] == "You are an assistant."+ assert request.system_message.content_blocks[0].get("text") == "You are an assistant."assert request.system_message.additional_kwargs["middleware_1"] == "applied"request = second_middleware(request)+ assert request.system_message is not Noneassert len(request.system_message.content_blocks) == 1assert (- request.system_message.content_blocks[0]["text"] == "You are an assistant. Be helpful."+ request.system_message.content_blocks[0].get("text")+ == "You are an assistant. Be helpful.")assert request.system_message.additional_kwargs["middleware_1"] == "applied"assert request.system_message.additional_kwargs["middleware_2"] == "applied"@@ -872,6 +917,7 @@ class TestSystemMessageMiddlewareIntegration:def preserving_middleware(request: ModelRequest) -> ModelRequest:"""Middleware that preserves existing metadata."""+ assert request.system_message is not Nonenew_message = SystemMessage(content=request.system_message.text + " Extended.",additional_kwargs=request.system_message.additional_kwargs,@@ -882,8 +928,9 @@ class TestSystemMessageMiddlewareIntegration:request = _make_request(system_message=base_message)new_request = preserving_middleware(request)+ assert new_request.system_message is not Noneassert len(new_request.system_message.content_blocks) == 1- assert new_request.system_message.content_blocks[0]["text"] == "Base prompt Extended."+ assert new_request.system_message.content_blocks[0].get("text") == "Base prompt Extended."assert new_request.system_message.additional_kwargs == {"key1": "value1","key2": "value2",@@ -897,7 +944,8 @@ class TestSystemMessageMiddlewareIntegration:"""Middleware using string system prompt (backward compatible)."""current_prompt = request.system_prompt or ""new_prompt = current_prompt + " Additional instructions."- return request.override(system_prompt=new_prompt.strip())+ # system_prompt is deprecated but supported at runtime for backward compatibility+ return request.override(system_prompt=new_prompt.strip()) # type: ignore[call-arg]request = _make_request(system_prompt="Base prompt")new_request = string_middleware(request)@@ -914,7 +962,9 @@ class TestSystemMessageMiddlewareIntegration:],ids=["system_message", "string", "none"],)- def test_middleware_can_switch_between_formats(self, initial_value) -> None:+ def test_middleware_can_switch_between_formats(+ self, initial_value: SystemMessage | str | None+ ) -> None:"""Test middleware can work with SystemMessage, string, or None."""def flexible_middleware(request: ModelRequest) -> ModelRequest:@@ -936,8 +986,9 @@ class TestSystemMessageMiddlewareIntegration:expected_text = "[created]"result = flexible_middleware(request)+ assert result.system_message is not Noneassert len(result.system_message.content_blocks) == 1- assert result.system_message.content_blocks[0]["text"] == expected_text+ assert result.system_message.content_blocks[0].get("text") == expected_text# =============================================================================@@ -965,7 +1016,7 @@ class TestEdgeCasesAndErrorHandling:ids=["empty_content", "multiple_blocks"],)def test_system_message_content_variations(- self, content, expected_blocks, expected_prompt+ self, content: str | list[str | dict[str, Any]], expected_blocks: int, expected_prompt: str) -> None:"""Test SystemMessage with various content variations."""system_message = SystemMessage(content=content)@@ -978,9 +1029,10 @@ class TestEdgeCasesAndErrorHandling:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)+ assert request.system_message is not Noneif isinstance(content, list):assert isinstance(request.system_message.content_blocks, list)@@ -1001,8 +1053,8 @@ class TestEdgeCasesAndErrorHandling:tool_choice=None,tools=[],response_format=None,- state=cast("AgentState", {"messages": []}), # type: ignore[name-defined]- runtime=_fake_runtime(),+ state=AgentState(messages=[]),+ runtime=Runtime(),)new_request = request.override(system_message=None)