Python: [BREAKING] Simplify API: ChatAgent -> Agent, ChatMessage -> Message (#3747)

* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse Simplify the public API by removing redundant 'Chat' prefix from core types: - ChatAgent -> Agent - RawChatAgent -> RawAgent - ChatMessage -> Message - ChatClientProtocol -> SupportsChatGetResponse Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision. No backward compatibility aliases - this is a clean breaking change. * [BREAKING] Rename Agent chat_client parameter to client * Fix rebase issues: WorkflowMessage references and broken markdown links * Fix formatting and lint issues from code quality checks * Fix import ordering in workflow sample files * fixed rebase * Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename - Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests - Fix isinstance check in A2A agent to use A2AMessage instead of Message - Fix import in test_workflow_observability.py (Message→WorkflowMessage) * Fix lint, fmt, and sample errors after ChatMessage→Message rename - Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs) - Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample - Fix _normalize_messages→normalize_messages in custom agent sample - Fix context.terminate→raise MiddlewareTermination in middleware samples - Fix with_update_hook→with_transform_hook in override middleware sample - Add TOptions_co import back to custom_chat_client sample - Add noqa for FastAPI File() default in chatkit sample - Fix B023 loop variable capture in weather agent sample * fix: update Agent constructor calls from chat_client to client in declaration-only tool tests * fix: add register_cleanup to devui lazy-loading proxy and type stub * fixed tests and updated new pieces * fix agui typevar * fix merge errors * fix merge conflicts * fiux merge * Remove unused links --------- Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
2026-06-16 21:04:09 +08:00 · 2026-02-10 23:04:32 +00:00
parent a4c9e43afb
commit 0521f5bed8
418 changed files with 5385 additions and 5389 deletions
@@ -2,14 +2,14 @@

 from unittest.mock import patch

-from agent_framework._types import ChatMessage, Content
+from agent_framework._types import Content, Message
 from agent_framework_lab_tau2._message_utils import flip_messages, log_messages


 def test_flip_messages_user_to_assistant():
    """Test flipping user message to assistant."""
    messages = [
-        ChatMessage(
+        Message(
            role="user",
            contents=[Content.from_text(text="Hello assistant")],
            author_name="User1",
@@ -29,7 +29,7 @@ def test_flip_messages_user_to_assistant():
 def test_flip_messages_assistant_to_user():
    """Test flipping assistant message to user."""
    messages = [
-        ChatMessage(
+        Message(
            role="assistant",
            contents=[Content.from_text(text="Hello user")],
            author_name="Assistant1",
@@ -51,7 +51,7 @@ def test_flip_messages_assistant_with_function_calls_filtered():
    function_call = Content.from_function_call(call_id="call_123", name="test_function", arguments={"param": "value"})

    messages = [
-        ChatMessage(
+        Message(
            role="assistant",
            contents=[
                Content.from_text(text="I'll call a function"),
@@ -78,7 +78,7 @@ def test_flip_messages_assistant_with_only_function_calls_skipped():
    function_call = Content.from_function_call(call_id="call_456", name="another_function", arguments={"key": "value"})

    messages = [
-        ChatMessage(role="assistant", contents=[function_call], message_id="msg_004")  # Only function call, no text
+        Message(role="assistant", contents=[function_call], message_id="msg_004")  # Only function call, no text
    ]

    flipped = flip_messages(messages)
@@ -91,7 +91,7 @@ def test_flip_messages_tool_messages_skipped():
    """Test that tool messages are skipped."""
    function_result = Content.from_function_result(call_id="call_789", result={"success": True})

-    messages = [ChatMessage(role="tool", contents=[function_result])]
+    messages = [Message(role="tool", contents=[function_result])]

    flipped = flip_messages(messages)

@@ -101,9 +101,7 @@ def test_flip_messages_tool_messages_skipped():

 def test_flip_messages_system_messages_preserved():
    """Test that system messages are preserved as-is."""
-    messages = [
-        ChatMessage(role="system", contents=[Content.from_text(text="System instruction")], message_id="sys_001")
-    ]
+    messages = [Message(role="system", contents=[Content.from_text(text="System instruction")], message_id="sys_001")]

    flipped = flip_messages(messages)

@@ -120,11 +118,11 @@ def test_flip_messages_mixed_conversation():
    function_result = Content.from_function_result(call_id="call_mixed", result="function result")

    messages = [
-        ChatMessage(role="system", contents=[Content.from_text(text="System prompt")]),
-        ChatMessage(role="user", contents=[Content.from_text(text="User question")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Assistant response"), function_call]),
-        ChatMessage(role="tool", contents=[function_result]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Final response")]),
+        Message(role="system", contents=[Content.from_text(text="System prompt")]),
+        Message(role="user", contents=[Content.from_text(text="User question")]),
+        Message(role="assistant", contents=[Content.from_text(text="Assistant response"), function_call]),
+        Message(role="tool", contents=[function_result]),
+        Message(role="assistant", contents=[Content.from_text(text="Final response")]),
    ]

    flipped = flip_messages(messages)
@@ -159,7 +157,7 @@ def test_flip_messages_empty_list():
 def test_flip_messages_preserves_metadata():
    """Test that message metadata is preserved during flipping."""
    messages = [
-        ChatMessage(
+        Message(
            role="user",
            contents=[Content.from_text(text="Test message")],
            author_name="TestUser",
@@ -178,8 +176,8 @@ def test_flip_messages_preserves_metadata():
 def test_log_messages_text_content(mock_logger):
    """Test logging messages with text content."""
    messages = [
-        ChatMessage(role="user", contents=[Content.from_text(text="Hello")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Hi there!")]),
+        Message(role="user", contents=[Content.from_text(text="Hello")]),
+        Message(role="assistant", contents=[Content.from_text(text="Hi there!")]),
    ]

    log_messages(messages)
@@ -193,7 +191,7 @@ def test_log_messages_function_call(mock_logger):
    """Test logging messages with function calls."""
    function_call = Content.from_function_call(call_id="call_log", name="log_function", arguments={"param": "value"})

-    messages = [ChatMessage(role="assistant", contents=[function_call])]
+    messages = [Message(role="assistant", contents=[function_call])]

    log_messages(messages)

@@ -209,7 +207,7 @@ def test_log_messages_function_result(mock_logger):
    """Test logging messages with function results."""
    function_result = Content.from_function_result(call_id="call_result", result="success")

-    messages = [ChatMessage(role="tool", contents=[function_result])]
+    messages = [Message(role="tool", contents=[function_result])]

    log_messages(messages)

@@ -223,10 +221,10 @@ def test_log_messages_function_result(mock_logger):
 def test_log_messages_different_roles(mock_logger):
    """Test logging messages with different roles get different colors."""
    messages = [
-        ChatMessage(role="system", contents=[Content.from_text(text="System")]),
-        ChatMessage(role="user", contents=[Content.from_text(text="User")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Assistant")]),
-        ChatMessage(role="tool", contents=[Content.from_text(text="Tool")]),
+        Message(role="system", contents=[Content.from_text(text="System")]),
+        Message(role="user", contents=[Content.from_text(text="User")]),
+        Message(role="assistant", contents=[Content.from_text(text="Assistant")]),
+        Message(role="tool", contents=[Content.from_text(text="Tool")]),
    ]

    log_messages(messages)
@@ -250,7 +248,7 @@ def test_log_messages_different_roles(mock_logger):
@patch("agent_framework_lab_tau2._message_utils.logger")
 def test_log_messages_escapes_html(mock_logger):
    """Test that HTML-like characters are properly escaped in log output."""
-    messages = [ChatMessage(role="user", contents=[Content.from_text(text="Message with <tag> content")])]
+    messages = [Message(role="user", contents=[Content.from_text(text="Message with <tag> content")])]

    log_messages(messages)

@@ -266,7 +264,7 @@ def test_log_messages_mixed_content_types(mock_logger):
    function_call = Content.from_function_call(call_id="mixed_call", name="mixed_function", arguments={"key": "value"})

    messages = [
-        ChatMessage(
+        Message(
            role="assistant",
            contents=[Content.from_text(text="I'll call a function"), function_call, Content.from_text(text="Done!")],
        )
@@ -4,7 +4,7 @@

 from unittest.mock import patch

-from agent_framework._types import ChatMessage, Content
+from agent_framework._types import Content, Message
 from agent_framework_lab_tau2._sliding_window import SlidingWindowChatMessageStore


@@ -36,8 +36,8 @@ def test_initialization_with_parameters():
 def test_initialization_with_messages():
    """Test initializing with existing messages."""
    messages = [
-        ChatMessage(role="user", contents=[Content.from_text(text="Hello")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Hi there!")]),
+        Message(role="user", contents=[Content.from_text(text="Hello")]),
+        Message(role="assistant", contents=[Content.from_text(text="Hi there!")]),
    ]

    sliding_window = SlidingWindowChatMessageStore(messages=messages, max_tokens=1000)
@@ -51,8 +51,8 @@ async def test_add_messages_simple():
    sliding_window = SlidingWindowChatMessageStore(max_tokens=10000)  # Large limit

    new_messages = [
-        ChatMessage(role="user", contents=[Content.from_text(text="What's the weather?")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="I can help with that.")]),
+        Message(role="user", contents=[Content.from_text(text="What's the weather?")]),
+        Message(role="assistant", contents=[Content.from_text(text="I can help with that.")]),
    ]

    await sliding_window.add_messages(new_messages)
@@ -69,7 +69,7 @@ async def test_list_all_messages_vs_list_messages():

    # Add many messages to trigger truncation
    messages = [
-        ChatMessage(role="user", contents=[Content.from_text(text=f"Message {i} with some content")]) for i in range(10)
+        Message(role="user", contents=[Content.from_text(text=f"Message {i} with some content")]) for i in range(10)
    ]

    await sliding_window.add_messages(messages)
@@ -87,7 +87,7 @@ async def test_list_all_messages_vs_list_messages():
 def test_get_token_count_basic():
    """Test basic token counting."""
    sliding_window = SlidingWindowChatMessageStore(max_tokens=1000)
-    sliding_window.truncated_messages = [ChatMessage(role="user", contents=[Content.from_text(text="Hello")])]
+    sliding_window.truncated_messages = [Message(role="user", contents=[Content.from_text(text="Hello")])]

    token_count = sliding_window.get_token_count()

@@ -104,7 +104,7 @@ def test_get_token_count_with_system_message():
    token_count_empty = sliding_window.get_token_count()

    # Add a message
-    sliding_window.truncated_messages = [ChatMessage(role="user", contents=[Content.from_text(text="Hello")])]
+    sliding_window.truncated_messages = [Message(role="user", contents=[Content.from_text(text="Hello")])]
    token_count_with_message = sliding_window.get_token_count()

    # With message should be more tokens
@@ -117,7 +117,7 @@ def test_get_token_count_function_call():
    function_call = Content.from_function_call(call_id="call_123", name="test_function", arguments={"param": "value"})

    sliding_window = SlidingWindowChatMessageStore(max_tokens=1000)
-    sliding_window.truncated_messages = [ChatMessage(role="assistant", contents=[function_call])]
+    sliding_window.truncated_messages = [Message(role="assistant", contents=[function_call])]

    token_count = sliding_window.get_token_count()
    assert token_count > 0
@@ -128,7 +128,7 @@ def test_get_token_count_function_result():
    function_result = Content.from_function_result(call_id="call_123", result={"success": True, "data": "result"})

    sliding_window = SlidingWindowChatMessageStore(max_tokens=1000)
-    sliding_window.truncated_messages = [ChatMessage(role="tool", contents=[function_result])]
+    sliding_window.truncated_messages = [Message(role="tool", contents=[function_result])]

    token_count = sliding_window.get_token_count()
    assert token_count > 0
@@ -141,17 +141,17 @@ def test_truncate_messages_removes_old_messages(mock_logger):

    # Create messages that will exceed the limit
    messages = [
-        ChatMessage(
+        Message(
            role="user",
            contents=[Content.from_text(text="This is a very long message that should exceed the token limit")],
        ),
-        ChatMessage(
+        Message(
            role="assistant",
            contents=[
                Content.from_text(text="This is another very long message that should also exceed the token limit")
            ],
        ),
-        ChatMessage(role="user", contents=[Content.from_text(text="Short msg")]),
+        Message(role="user", contents=[Content.from_text(text="Short msg")]),
    ]

    sliding_window.truncated_messages = messages.copy()
@@ -170,10 +170,8 @@ def test_truncate_messages_removes_leading_tool_messages(mock_logger):
    sliding_window = SlidingWindowChatMessageStore(max_tokens=10000)  # Large limit

    # Create messages starting with tool message
-    tool_message = ChatMessage(
-        role="tool", contents=[Content.from_function_result(call_id="call_123", result="result")]
-    )
-    user_message = ChatMessage(role="user", contents=[Content.from_text(text="Hello")])
+    tool_message = Message(role="tool", contents=[Content.from_function_result(call_id="call_123", result="result")])
+    user_message = Message(role="user", contents=[Content.from_text(text="Hello")])

    sliding_window.truncated_messages = [tool_message, user_message]
    sliding_window.truncate_messages()
@@ -231,13 +229,13 @@ async def test_real_world_scenario():

    # Simulate a conversation
    conversation = [
-        ChatMessage(role="user", contents=[Content.from_text(text="Hello, how are you?")]),
-        ChatMessage(
+        Message(role="user", contents=[Content.from_text(text="Hello, how are you?")]),
+        Message(
            role="assistant",
            contents=[Content.from_text(text="I'm doing well, thank you! How can I help you today?")],
        ),
-        ChatMessage(role="user", contents=[Content.from_text(text="Can you tell me about the weather?")]),
-        ChatMessage(
+        Message(role="user", contents=[Content.from_text(text="Can you tell me about the weather?")]),
+        Message(
            role="assistant",
            contents=[
                Content.from_text(
@@ -246,8 +244,8 @@ async def test_real_world_scenario():
                )
            ],
        ),
-        ChatMessage(role="user", contents=[Content.from_text(text="What about telling me a joke instead?")]),
-        ChatMessage(
+        Message(role="user", contents=[Content.from_text(text="What about telling me a joke instead?")]),
+        Message(
            role="assistant",
            contents=[
                Content.from_text(text="Sure! Why don't scientists trust atoms? Because they make up everything!")
@@ -6,7 +6,7 @@ import urllib.request
 from pathlib import Path

 import pytest
-from agent_framework import ChatMessage, Content, FunctionTool
+from agent_framework import Content, FunctionTool, Message
 from agent_framework_lab_tau2._tau2_utils import (
    convert_agent_framework_messages_to_tau2_messages,
    convert_tau2_tool_to_function_tool,
@@ -91,7 +91,7 @@ def test_convert_tau2_tool_to_function_tool_multiple_tools(tau2_airline_environm

 def test_convert_agent_framework_messages_to_tau2_messages_system():
    """Test converting system message."""
-    messages = [ChatMessage(role="system", contents=[Content.from_text(text="System instruction")])]
+    messages = [Message(role="system", contents=[Content.from_text(text="System instruction")])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -103,7 +103,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_system():

 def test_convert_agent_framework_messages_to_tau2_messages_user():
    """Test converting user message."""
-    messages = [ChatMessage(role="user", contents=[Content.from_text(text="Hello assistant")])]
+    messages = [Message(role="user", contents=[Content.from_text(text="Hello assistant")])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -116,7 +116,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_user():

 def test_convert_agent_framework_messages_to_tau2_messages_assistant():
    """Test converting assistant message."""
-    messages = [ChatMessage(role="assistant", contents=[Content.from_text(text="Hello user")])]
+    messages = [Message(role="assistant", contents=[Content.from_text(text="Hello user")])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -131,7 +131,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_with_function_call():
    """Test converting message with function call."""
    function_call = Content.from_function_call(call_id="call_123", name="test_function", arguments={"param": "value"})

-    messages = [ChatMessage(role="assistant", contents=[Content.from_text(text="I'll call a function"), function_call])]
+    messages = [Message(role="assistant", contents=[Content.from_text(text="I'll call a function"), function_call])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -153,7 +153,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_with_function_result(
    """Test converting message with function result."""
    function_result = Content.from_function_result(call_id="call_123", result={"success": True, "data": "result data"})

-    messages = [ChatMessage(role="tool", contents=[function_result])]
+    messages = [Message(role="tool", contents=[function_result])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -173,7 +173,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_with_error():
        call_id="call_456", result="Error occurred", exception=Exception("Test error")
    )

-    messages = [ChatMessage(role="tool", contents=[function_result])]
+    messages = [Message(role="tool", contents=[function_result])]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)

@@ -185,7 +185,7 @@ def test_convert_agent_framework_messages_to_tau2_messages_with_error():
 def test_convert_agent_framework_messages_to_tau2_messages_multiple_text_contents():
    """Test converting message with multiple text contents."""
    messages = [
-        ChatMessage(role="user", contents=[Content.from_text(text="First part"), Content.from_text(text="Second part")])
+        Message(role="user", contents=[Content.from_text(text="First part"), Content.from_text(text="Second part")])
    ]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)
@@ -202,11 +202,11 @@ def test_convert_agent_framework_messages_to_tau2_messages_complex_scenario():
    function_result = Content.from_function_result(call_id="call_789", result={"output": "tool result"})

    messages = [
-        ChatMessage(role="system", contents=[Content.from_text(text="System prompt")]),
-        ChatMessage(role="user", contents=[Content.from_text(text="User request")]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="I'll help you"), function_call]),
-        ChatMessage(role="tool", contents=[function_result]),
-        ChatMessage(role="assistant", contents=[Content.from_text(text="Based on the result...")]),
+        Message(role="system", contents=[Content.from_text(text="System prompt")]),
+        Message(role="user", contents=[Content.from_text(text="User request")]),
+        Message(role="assistant", contents=[Content.from_text(text="I'll help you"), function_call]),
+        Message(role="tool", contents=[function_result]),
+        Message(role="assistant", contents=[Content.from_text(text="Based on the result...")]),
    ]

    tau2_messages = convert_agent_framework_messages_to_tau2_messages(messages)