Python: Add samples syntax checking with pyright by eavanvalkenburg · Pull Request #3710 · microsoft/agent-framework

eavanvalkenburg · 2026-02-05T20:43:45Z

Motivation and Context

Add pyrightconfig.samples.json with relaxed type checking but import validation
Add samples-syntax poe task to check samples for syntax and import errors
Add samples-syntax to check and pre-commit-check tasks
Fix 78 sample errors:
- Update workflow builder imports to use agent_framework_orchestrations
- Change content type isinstance checks to content.type comparisons
- Use Content factory methods instead of removed content type classes
- Fix TypedDict access patterns for Annotation
- Fix various API mismatches (normalize_messages, ChatMessage.text, role)

Description

Contribution Checklist

The code builds clean without any errors or warnings
The PR follows the Contribution Guidelines
All unit tests pass, and I have added new tests where possible
Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

- Add pyrightconfig.samples.json with relaxed type checking but import validation - Add samples-syntax poe task to check samples for syntax and import errors - Add samples-syntax to check and pre-commit-check tasks - Fix 78 sample errors: - Update workflow builder imports to use agent_framework_orchestrations - Change content type isinstance checks to content.type comparisons - Use Content factory methods instead of removed content type classes - Fix TypedDict access patterns for Annotation - Fix various API mismatches (normalize_messages, ChatMessage.text, role)

Copilot

Pull request overview

This PR adds syntax checking for Python samples using pyright with a relaxed configuration that validates imports and attribute access without strict type checking. The PR includes the pyright configuration, build task integration, and fixes to 78 sample errors related to import reorganization and API changes.

Changes:

Added pyrightconfig.samples.json with relaxed type checking configuration
Added samples-syntax poe task and integrated it into check and pre-commit-check workflows
Updated samples to import workflow builders from agent_framework_orchestrations package
Changed content type checking from isinstance() to .type property comparisons
Updated API usage for normalize_messages, ChatMessage.text, Role, Annotation access patterns, and Content factory methods

Reviewed changes

Copilot reviewed 45 out of 45 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
python/pyrightconfig.samples.json	New pyright configuration for sample validation with import/attribute checking
python/pyproject.toml	Added samples-syntax task and integrated into check/pre-commit workflows
python/AGENTS.md	Documentation for samples syntax checking process and exclusions
python/samples/getting_started/workflows//.py	Updated imports from agent_framework to agent_framework_orchestrations for builders
python/samples/getting_started/tools/*.py	Changed isinstance checks to content.type comparisons
python/samples/getting_started/orchestrations/*.py	Updated imports and role access patterns
python/samples/getting_started/agents//.py	Updated Content factory method usage and annotation access patterns
python/samples/getting_started/context_providers/*.py	Changed msg.content to msg.text
python/samples/demos//.py	Updated to use ExecutorEvent instead of AgentRunUpdateEvent
python/samples/autogen-migration//.py	Updated imports and content type checking patterns

Copilot · 2026-02-05T20:50:45Z

python/pyrightconfig.samples.json

+{
+    "include": ["samples"],
+    "exclude": [
+        "**/autogen/**",
+        "**/autogen-migration/**",
+        "**/semantic-kernel-migration/**",
+        "**/demos/**",
+        "**/agent_with_foundry_tracing.py"
+    ],
+    "typeCheckingMode": "off",
+    "reportMissingImports": "error",
+    "reportAttributeAccessIssue": "error"
+}


Two sample files that are not excluded by this configuration still reference the nonexistent AgentRunUpdateEvent class and should have been updated to use ExecutorEvent instead:

python/samples/getting_started/workflows/agents/azure_chat_agents_tool_calls_with_feedback.py (lines 12, 197, 294)

python/samples/getting_started/workflows/orchestration/magentic_human_plan_review.py (lines 8, 94)

These files import AgentRunUpdateEvent from agent_framework, but this class no longer exists - it should be ExecutorEvent based on the changes made in python/samples/demos/workflow_evaluation/create_workflow.py.

Copilot · 2026-02-05T20:50:46Z

python/pyrightconfig.samples.json

+{
+    "include": ["samples"],
+    "exclude": [
+        "**/autogen/**",
+        "**/autogen-migration/**",
+        "**/semantic-kernel-migration/**",
+        "**/demos/**",
+        "**/agent_with_foundry_tracing.py"
+    ],
+    "typeCheckingMode": "off",
+    "reportMissingImports": "error",
+    "reportAttributeAccessIssue": "error"
+}


This sample file imports several classes that have been moved to the agent_framework_orchestrations package but the imports have not been updated:

MagenticBuilder - should be imported from agent_framework_orchestrations

MagenticPlanReviewRequest - should be imported from agent_framework_orchestrations

AgentRunUpdateEvent - no longer exists, should be changed to ExecutorEvent

The imports should be split into two statements similar to the pattern used in other updated samples.

Copilot · 2026-02-05T20:50:46Z

python/pyrightconfig.samples.json

+{
+    "include": ["samples"],
+    "exclude": [
+        "**/autogen/**",
+        "**/autogen-migration/**",
+        "**/semantic-kernel-migration/**",
+        "**/demos/**",
+        "**/agent_with_foundry_tracing.py"
+    ],
+    "typeCheckingMode": "off",
+    "reportMissingImports": "error",
+    "reportAttributeAccessIssue": "error"
+}


This sample file has multiple issues that need to be fixed to align with the API changes:

AgentRunUpdateEvent (line 12) - no longer exists, should be changed to ExecutorEvent

FunctionCallContent and FunctionResultContent (lines 16-17) - these classes are no longer exported. The code should be updated to use content.type == "function_call" and content.type == "function_result" instead of isinstance() checks (lines 204-205)

The display_agent_run_update function signature and isinstance checks need to be updated to use ExecutorEvent instead of AgentRunUpdateEvent

Copilot · 2026-02-05T20:50:46Z

python/samples/getting_started/agents/anthropic/anthropic_advanced.py

 import asyncio

-from agent_framework import HostedMCPTool, HostedWebSearchTool, TextReasoningContent, UsageContent
+from agent_framework import Content, HostedMCPTool, HostedWebSearchTool


Import of 'Content' is not used.

Suggested change

from agent_framework import Content, HostedMCPTool, HostedWebSearchTool

from agent_framework import HostedMCPTool, HostedWebSearchTool

Copilot · 2026-02-05T20:50:46Z

python/samples/getting_started/agents/anthropic/anthropic_foundry.py

 import asyncio

-from agent_framework import HostedMCPTool, HostedWebSearchTool, TextReasoningContent, UsageContent
+from agent_framework import Content, HostedMCPTool, HostedWebSearchTool


Import of 'Content' is not used.

Suggested change

from agent_framework import Content, HostedMCPTool, HostedWebSearchTool

from agent_framework import HostedMCPTool, HostedWebSearchTool

Copilot · 2026-02-05T20:50:47Z

python/samples/getting_started/tools/function_tool_recover_from_failures.py

 from typing import Annotated

-from agent_framework import FunctionCallContent, FunctionResultContent, tool
+from agent_framework import Content, tool


Import of 'Content' is not used.

Suggested change

from agent_framework import Content, tool

from agent_framework import tool

Copilot · 2026-02-05T20:50:47Z

python/samples/getting_started/tools/function_tool_with_max_exceptions.py

 from typing import Annotated

-from agent_framework import FunctionCallContent, FunctionResultContent, tool
+from agent_framework import Content, tool


Import of 'Content' is not used.

Suggested change

from agent_framework import Content, tool

from agent_framework import tool

Copilot · 2026-02-05T20:50:47Z

python/samples/getting_started/tools/function_tool_with_max_invocations.py

 from typing import Annotated

-from agent_framework import FunctionCallContent, FunctionResultContent, tool
+from agent_framework import Content, tool


Import of 'Content' is not used.

Suggested change

from agent_framework import Content, tool

from agent_framework import tool

moonbox3 · 2026-02-06T02:34:37Z

python/samples/getting_started/workflows/agents/concurrent_workflow_as_agent.py

Please back out any workflow/orchestration samples. I am fixing them in #3690. I do not want to deal with any more merge conflicts.

Copilot AI review requested due to automatic review settings February 5, 2026 20:43

markwallace-microsoft added documentation Improvements or additions to documentation python labels Feb 5, 2026

Copilot started reviewing on behalf of eavanvalkenburg February 5, 2026 20:44 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

moonbox3 requested changes Feb 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Python: Add samples syntax checking with pyright#3710

Python: Add samples syntax checking with pyright#3710
eavanvalkenburg wants to merge 1 commit intomicrosoft:mainfrom
eavanvalkenburg:check_samples

eavanvalkenburg commented Feb 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

Copilot AI Feb 5, 2026

Uh oh!

moonbox3 Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	from agent_framework import Content, HostedMCPTool, HostedWebSearchTool
	from agent_framework import HostedMCPTool, HostedWebSearchTool

	from agent_framework import Content, tool
	from agent_framework import tool

Conversation

eavanvalkenburg commented Feb 5, 2026

Motivation and Context

Description

Contribution Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

moonbox3 Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants