Skip to content

Python: Make response overview examples runnable - #9617

Closed
BlueRaddish wants to merge 1 commit into
microsoft:mainfrom
BlueRaddish:fix/oct22-mm-response-docs
Closed

BlueRaddish wants to merge 1 commit into
microsoft:mainfrom
BlueRaddish:fix/oct22-mm-response-docs

Conversation

@BlueRaddish

Copy link
Copy Markdown
Contributor

Motivation & Context

The ChatResponse and AgentResponse overview code blocks use an illustrative updates = [...] placeholder. Copying either complete block stops at from_updates before its serialization examples because Ellipsis is not a response update. Concrete updates let readers run each overview as written.

Description & Review Guide

  • What are the major changes? Import the corresponding update class and Content, then construct a single assistant text update in each overview.
  • What is the impact of these changes? Both complete examples run through streaming aggregation and dictionary/JSON round trips. Their documented text, model, finish reason and response ID are preserved. Only two class docstrings change; the runtime AST and public API are identical.
  • What do you want reviewers to focus on? The complete examples remain self-contained, and the concrete stream produces the same values used by the later serialization demonstrations.

Actual verification catches two AttributeError interruptions when copying the original complete blocks, with three passing public API controls. Both final blocks execute through real public imports, including their printed values and both serialization round trips. The actual code blocks compile under Python 3.10 and 3.11. All 482 owning test_types.py unit tests pass with zero skips. Normal scoped hooks and the native source commit's normal pre-commit hook pass. Exact source verification. Runtime execution used Ubuntu/CPython 3.13; the full workspace suite, build, typing and live service calls were not run.

Related Issue

N/A - trivial change. This replaces illustrative placeholders with minimal concrete inputs in existing overview examples; runtime behavior is unchanged. The separate #9437 edits the to_updates method examples, not these class overviews. Fresh targeted issue/PR searches found no competing overview repair.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: OpenAI Codex assisted with the example inputs, documentation patch, verification and this description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Oct 23, 2026
@eavanvalkenburg

Copy link
Copy Markdown
Member

/review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MAF Automated Review — Iteration 1

Result: No findings
Scope: full PR (1 commit(s)): d6cfbe00c854
Model: gpt-5.6-sol

Overview

This PR replaces non-runnable Ellipsis placeholders in two class docstrings with concrete response updates that exercise aggregation and serialization. The imported symbols are valid public exports, the examples match the aggregation contracts, and existing tests cover the relevant text, metadata, and round-trip behavior; no publishable defect was established.

Reviewed the supplied pull-request change set across correctness, security/reliability, architecture, and failure behavior.
No publishable findings remained after source verification for this scope.

@agent-framework-automation

Copy link
Copy Markdown

BlueRaddish, this pull request is waiting on your response. If there is no further activity within 4 days, it will be closed automatically. (This is an automated message.)

@agent-framework-automation agent-framework-automation Bot added the requested-info Information or updates are needed from the author; inactive PRs may be closed automatically. label Nov 4, 2026
Mehedi Hasan (Mahdi-Hasan) pushed a commit to Mahdi-Hasan/agent-framework that referenced this pull request Nov 4, 2026
Eduard van Valkenburg (eavanvalkenburg) added a commit to eavanvalkenburg/agent-framework that referenced this pull request Nov 6, 2026
… notes

Accept legacy positive cache_max_size values with a deprecation warning, without restoring initialized-session caching. Keep per-invocation security isolation and the approved 1.5.0 version, document the compatibility behavior and remaining lifecycle migration, and extend real-protocol isolation tests for explicit legacy values. Remove the changelog claim and reference for still-open PR microsoft#9617.
Isham Mohamed (IshamMohamed) pushed a commit to IshamMohamed/agent-framework that referenced this pull request Nov 6, 2026
* Bump Python package versions for 1.25.0 release

Release all 44 publishing workspace distributions with shipping changes since python-1.24.0, including the Python 3.10 removal. Use the approved minor bumps for Core/root, AG-UI, and Declarative, patch bumps for other changed stable integrations, and 261106 stamps for changed alpha/beta packages; no optional cohort-only bump. Update the Core standard-install cohort, apply strict API-based Core floors, and align exact hosting pins. Include the four Python Dependabot updates and the reviewed release batch manifest. Changelog includes the anticipated microsoft#10147 fix; the draft must wait for that PR to merge and be incorporated before release. Lab remains excluded from publication, with only its dependency lock updated.

* Fix SQL Server cancellation test exception-info narrowing

* Retain deprecated declarative MCP cache parameter and correct release notes

Accept legacy positive cache_max_size values with a deprecation warning, without restoring initialized-session caching. Keep per-invocation security isolation and the approved 1.5.0 version, document the compatibility behavior and remaining lifecycle migration, and extend real-protocol isolation tests for explicit legacy values. Remove the changelog claim and reference for still-open PR microsoft#9617.

* Simplify deprecated MCP cache parameter handling and undo skill edits
@agent-framework-automation

Copy link
Copy Markdown

Closing this pull request because there was no further activity after the automated warning. (This is an automated message.)

This branch was previously deployed

1 inactive deployment
github-app-auth — d6cfbe00 Deployed Oct 23, 2026 by BlueRaddish via team_check #7300
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python requested-info Information or updates are needed from the author; inactive PRs may be closed automatically.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants