[python] Fix paging return type annotation using built-in list when operation is named list - #10525
Merged
Merged
Conversation
…ion when operation is named `list` Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/4cebf863-2c8f-48d2-89f0-ff2253256997 Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
microsoft-github-policy-service
Bot
added
the
emitter:client:python
Copilot
AI
changed the title
[WIP] Fix wrong typing in generated Python SDK
[python] Fix paging return type annotation using built-in Apr 28, 2026
list when operation is named list
Yuchao Yan (msyyc)
marked this pull request as ready for review
May 11, 2026 08:35
commit: |
Contributor
|
All changed packages have been documented.
Show changes
|
Collaborator
|
You can try these changes here
|
Yuchao Yan (msyyc)
marked this pull request as draft
May 11, 2026 09:30
…onse Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/1ccb87cf-7ba3-467c-b22d-40aa4dd56b48 Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
…ested model element types Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/0765c171-f668-4f09-8a6e-84b04cc0ca76 Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>
Yuchao Yan (msyyc)
marked this pull request as ready for review
May 12, 2026 06:48
Yuchao Yan (msyyc)
enabled auto-merge
May 12, 2026 06:49
Chenjie Shi (tadelesh)
approved these changes
May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To fix #10524
When a paging operation is named
listand its page item is itself a collection, the generated Python code renders the return type with the built-inlist, which is shadowed by theList = listalias the emitter inserts at the top of the operation file. This produces inconsistent typing such asAsyncItemPaged[list[str]]alongsidecls: ClsType[List[List[str]]]in the same method.Root cause
Response.type_annotationsetskwargs["is_operation_file"] = Truebefore delegating to the inner type so thatListType.type_annotationemits theListalias.PagingResponse.type_annotationoverrode this method but forwarded kwargs toself.item_type.type_annotation(**kwargs)without setting that flag, so the page item's list type fell back to the built-inlist. Theclsannotation went through the parent path and rendered correctly, hence the mismatch.