agent/agent-framework
2
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Python: [BREAKING] Types API Review improvements (#3647)

Browse Source 
* Replace Role and FinishReason classes with NewType + Literal

- Remove EnumLike metaclass from _types.py
- Replace Role class with NewType('Role', str) + RoleLiteral
- Replace FinishReason class with NewType('FinishReason', str) + FinishReasonLiteral
- Update all usages across codebase to use string literals
- Remove .value access patterns (direct string comparison now works)
- Add backward compatibility for legacy dict serialization format
- Update tests to reflect new string-based types

Addresses #3591, #3615

* Simplify ChatResponse and AgentResponse type hints (#3592)

- Remove overloads from ChatResponse.__init__
- Remove text parameter from ChatResponse.__init__
- Remove | dict[str, Any] from finish_reason and usage_details params
- Remove **kwargs from AgentResponse.__init__
- Both now accept ChatMessage | Sequence[ChatMessage] | None for messages
- Update docstrings and examples to reflect changes
- Fix tests that were using removed kwargs
- Fix Role type hint usage in ag-ui utils

* Remove text parameter from ChatResponseUpdate and AgentResponseUpdate (#3597)

- Remove text parameter from ChatResponseUpdate.__init__
- Remove text parameter from AgentResponseUpdate.__init__
- Remove **kwargs from both update classes
- Simplify contents parameter type to Sequence[Content] | None
- Update all usages to use contents=[Content.from_text(...)] pattern
- Fix imports in test files
- Update docstrings and examples

* Rename from_chat_response_updates to from_updates (#3593)

- ChatResponse.from_chat_response_updates → ChatResponse.from_updates
- ChatResponse.from_chat_response_generator → ChatResponse.from_update_generator
- AgentResponse.from_agent_run_response_updates → AgentResponse.from_updates

* Remove try_parse_value method from ChatResponse and AgentResponse (#3595)

- Remove try_parse_value method from ChatResponse
- Remove try_parse_value method from AgentResponse
- Remove try_parse_value calls from from_updates and from_update_generator methods
- Update samples to use try/except with response.value instead
- Update tests to use response.value pattern
- Users should now use response.value with try/except for safe parsing

* Add agent_id to AgentResponse and clarify author_name documentation (#3596)

- Add agent_id parameter to AgentResponse class
- Document that author_name is on ChatMessage objects, not responses
- Update ChatResponse docstring with author_name note
- Update AgentResponse docstring with author_name note

* Simplify ChatMessage.__init__ signature (#3618)

- Make contents a positional argument accepting Sequence[Content | str]
- Auto-convert strings in contents to TextContent
- Remove overloads, keep text kwarg for backward compatibility with serialization
- Update _parse_content_list to handle string items
- Update all usages across codebase to use new format: ChatMessage("role", ["text"])

* Allow Content as input on run and get_response

- Update prepare_messages and normalize_messages to accept Content
- Update type signatures in _agents.py and _clients.py
- Add tests for Content input handling

* Fix ChatMessage usage across packages and samples

Update all remaining ChatMessage(role=..., text=...) to use new
ChatMessage('role', ['text']) signature.

* Fix Role string usage and response format parsing

- Fix redis provider: remove .value access on string literals
- Fix durabletask ensure_response_format: set _response_format before accessing .value

* Fix ollama .value and ai_model_id issues, handle None in content list

- Fix ollama _chat_client: remove .value on string literals
- Fix ollama _chat_client: rename ai_model_id to model_id
- Fix _parse_content_list: skip None values gracefully

* Fix A2AAgent type signature to include Content

* Fix Role/FinishReason NewType dict annotations and improve test coverage to 95%

* Fix mypy errors for Role/FinishReason NewType usage

* Fix Role.TOOL and Role.ASSISTANT usage in _orchestrator_helpers.py

* Fix Role NewType usage in durabletask _models.py
This commit is contained in:
Eduard van Valkenburg
2026-02-04 10:13:23 +00:00
committed by GitHub
parent ef798629e5
commit 838a7fd61d
341 changed files with 3766 additions and 3228 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/packages/devui/tests/test_helpers.py
+22 -25
View File
@@ -29,7 +29,6 @@ from agent_framework import (
ChatResponseUpdate,
ConcurrentBuilder,
Content,
Role,
SequentialBuilder,
use_chat_middleware,
)
@@ -79,7 +78,7 @@ class MockChatClient:
self.call_count += 1
if self.responses:
return self.responses.pop(0)
return ChatResponse(messages=ChatMessage(role="assistant", text="test response"))
return ChatResponse(messages=ChatMessage("assistant", ["test response"]))
async def get_streaming_response(
self,
@@ -91,7 +90,7 @@ class MockChatClient:
for update in self.streaming_responses.pop(0):
yield update
else:
yield ChatResponseUpdate(text=Content.from_text(text="test streaming response"), role="assistant")
yield ChatResponseUpdate(contents=[Content.from_text(text="test streaming response")], role="assistant")
@use_chat_middleware
@@ -122,7 +121,7 @@ class MockBaseChatClient(BaseChatClient[TOptions_co], Generic[TOptions_co]):
self.received_messages.append(list(messages))
if self.run_responses:
return self.run_responses.pop(0)
return ChatResponse(messages=ChatMessage(role="assistant", text="Mock response from ChatAgent"))
return ChatResponse(messages=ChatMessage("assistant", ["Mock response from ChatAgent"]))
@override
async def _inner_get_streaming_response(
@@ -139,10 +138,10 @@ class MockBaseChatClient(BaseChatClient[TOptions_co], Generic[TOptions_co]):
yield update
else:
# Simulate realistic streaming chunks
yield ChatResponseUpdate(text=Content.from_text(text="Mock "), role="assistant")
yield ChatResponseUpdate(text=Content.from_text(text="streaming "), role="assistant")
yield ChatResponseUpdate(text=Content.from_text(text="response "), role="assistant")
yield ChatResponseUpdate(text=Content.from_text(text="from ChatAgent"), role="assistant")
yield ChatResponseUpdate(contents=[Content.from_text(text="Mock ")], role="assistant")
yield ChatResponseUpdate(contents=[Content.from_text(text="streaming ")], role="assistant")
yield ChatResponseUpdate(contents=[Content.from_text(text="response ")], role="assistant")
yield ChatResponseUpdate(contents=[Content.from_text(text="from ChatAgent")], role="assistant")
# =============================================================================
@@ -172,9 +171,7 @@ class MockAgent(BaseAgent):
**kwargs: Any,
) -> AgentResponse:
self.call_count += 1
return AgentResponse(
messages=[ChatMessage(role=Role.ASSISTANT, contents=[Content.from_text(text=self.response_text)])]
)
return AgentResponse(messages=[ChatMessage("assistant", [Content.from_text(text=self.response_text)])])
async def run_stream(
self,
@@ -185,7 +182,7 @@ class MockAgent(BaseAgent):
) -> AsyncIterable[AgentResponseUpdate]:
self.call_count += 1
for chunk in self.streaming_chunks:
yield AgentResponseUpdate(contents=[Content.from_text(text=chunk)], role=Role.ASSISTANT)
yield AgentResponseUpdate(contents=[Content.from_text(text=chunk)], role="assistant")
class MockToolCallingAgent(BaseAgent):
@@ -203,7 +200,7 @@ class MockToolCallingAgent(BaseAgent):
**kwargs: Any,
) -> AgentResponse:
self.call_count += 1
return AgentResponse(messages=[ChatMessage(role=Role.ASSISTANT, text="done")])
return AgentResponse(messages=[ChatMessage("assistant", ["done"])])
async def run_stream(
self,
@@ -216,7 +213,7 @@ class MockToolCallingAgent(BaseAgent):
# First: text
yield AgentResponseUpdate(
contents=[Content.from_text(text="Let me search for that...")],
role=Role.ASSISTANT,
role="assistant",
)
# Second: tool call
yield AgentResponseUpdate(
@@ -227,7 +224,7 @@ class MockToolCallingAgent(BaseAgent):
arguments={"query": "weather"},
)
],
role=Role.ASSISTANT,
role="assistant",
)
# Third: tool result
yield AgentResponseUpdate(
@@ -237,12 +234,12 @@ class MockToolCallingAgent(BaseAgent):
result={"temperature": 72, "condition": "sunny"},
)
],
role=Role.TOOL,
role="tool",
)
# Fourth: final text
yield AgentResponseUpdate(
contents=[Content.from_text(text="The weather is sunny, 72°F.")],
role=Role.ASSISTANT,
role="assistant",
)
@@ -295,7 +292,7 @@ def create_mock_tool_agent(id: str = "tool_agent", name: str = "ToolAgent") -> M
def create_agent_run_response(text: str = "Test response") -> AgentResponse:
"""Create an AgentResponse with the given text."""
return AgentResponse(messages=[ChatMessage(role=Role.ASSISTANT, contents=[Content.from_text(text=text)])])
return AgentResponse(messages=[ChatMessage("assistant", [Content.from_text(text=text)])])
def create_agent_executor_response(
@@ -308,8 +305,8 @@ def create_agent_executor_response(
executor_id=executor_id,
agent_response=agent_response,
full_conversation=[
ChatMessage(role=Role.USER, contents=[Content.from_text(text="User input")]),
ChatMessage(role=Role.ASSISTANT, contents=[Content.from_text(text=response_text)]),
ChatMessage("user", [Content.from_text(text="User input")]),
ChatMessage("assistant", [Content.from_text(text=response_text)]),
],
)
@@ -391,8 +388,8 @@ async def create_sequential_workflow() -> tuple[AgentFrameworkExecutor, str, Moc
"""
mock_client = MockBaseChatClient()
mock_client.run_responses = [
ChatResponse(messages=ChatMessage(role=Role.ASSISTANT, text="Here's the draft content about the topic.")),
ChatResponse(messages=ChatMessage(role=Role.ASSISTANT, text="Review: Content is clear and well-structured.")),
ChatResponse(messages=ChatMessage("assistant", ["Here's the draft content about the topic."])),
ChatResponse(messages=ChatMessage("assistant", ["Review: Content is clear and well-structured."])),
]
writer = ChatAgent(
@@ -434,9 +431,9 @@ async def create_concurrent_workflow() -> tuple[AgentFrameworkExecutor, str, Moc
"""
mock_client = MockBaseChatClient()
mock_client.run_responses = [
ChatResponse(messages=ChatMessage(role=Role.ASSISTANT, text="Research findings: Key data points identified.")),
ChatResponse(messages=ChatMessage(role=Role.ASSISTANT, text="Analysis: Trends indicate positive growth.")),
ChatResponse(messages=ChatMessage(role=Role.ASSISTANT, text="Summary: Overall outlook is favorable.")),
ChatResponse(messages=ChatMessage("assistant", ["Research findings: Key data points identified."])),
ChatResponse(messages=ChatMessage("assistant", ["Analysis: Trends indicate positive growth."])),
ChatResponse(messages=ChatMessage("assistant", ["Summary: Overall outlook is favorable."])),
]
researcher = ChatAgent(