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>
This commit is contained in:
Eduard van Valkenburg
2026-02-10 23:04:32 +00:00
committed by GitHub
co-authored by Evan Mattson
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!")],
)