[python] Add mock API tests for XML scenarios from PR #10063 and fix XML serialization bugs by Copilot · Pull Request #10098 · microsoft/typespec

Copilot · 2026-03-19T22:35:09Z

Original prompt

This section details on the original issue you should resolve

<issue_title>[python] add test case for #10063
</issue_title>
<issue_description>follow skill https://github.com/microsoft/typespec/blob/main/.github/skills/python-sdk-spector-mock-api-tests/SKILL.md to write test case for #10063
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes [python] add test case for https://github.com/microsoft/typespec/pull/10063 #10097

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

pkg-pr-new · 2026-03-20T01:01:41Z

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/http-client-python@10098

commit: 4d6993f

github-actions · 2026-03-20T01:02:51Z

All changed packages have been documented.

✅ @typespec/http-client-python

Show changes

`@typespec/http-client-python` - internal ✏️

Add mock API test cases for XML scenarios introduced in #10063, covering: renamed property, nested model, renamed nested model, wrapped primitive with custom item names, model array variants (wrapped/unwrapped/renamed), renamed attribute, namespace, and namespace-on-properties. Fix XML serialization/deserialization bugs: unwrapped model array element naming, namespace key mismatch between DPG models and the runtime template, default-namespace propagation semantics, and handling of Python-reserved namespace prefixes.

azure-sdk · 2026-03-20T01:14:19Z

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension

packages/http-client-python/generator/test/generic_mock_api_tests/test_payload_xml.py

msyyc · 2026-03-23T06:35:32Z

@copilot analyze the review comment #10098 (review).

…cks, improve namespace_map comment, remove .venv_test from .gitignore Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/0b94f8d4-fb48-435f-a266-158971884321

Copilot · 2026-03-23T06:45:50Z

Code Review

Overall the tests are well-structured and consistent with existing patterns. The 4 bug fixes in model_base.py.jinja2 are well-reasoned. A few issues worth addressing:...

Addressed in e02d171:

itemNs → itemsNs (🔴): Fixed the key mismatch in the deserialization path. Also restructured the unwrapped-array block so when itemsNs is absent the existing property namespace still applies to the items name.
Empty-string namespace or chains (🟡): Replaced all prop_meta.get("ns") or prop_meta.get("namespace") patterns with is None checks (across all 8 affected sites in deserialization and serialization paths). Also extracted local variables to avoid double-lookups flagged in code review.
ET._namespace_map silent fallback (🟡): Added a comment noting that if _namespace_map is absent (e.g. alternative Python implementations) ET will silently auto-generate a prefix.
.venv_test in .gitignore: Removed — was a local development leftover.

@copilot analyze the review comment #10098 (review).

All four points from the review have been addressed in e02d171. See the reply on the review comment for details.

Copilot

Pull request overview

Copilot reviewed 5 out of 6 changed files in this pull request and generated no new comments.

Files not reviewed (1)

packages/http-client-python/package-lock.json: Language not supported

msyyc

Review: `model_base.py.jinja2` - duplicated namespace fallback logic

The bug fixes in this PR (namespace key compat, ET.register_namespace ValueError handling, items naming) are all correct. The main concern is structural cleanliness.

Core issue: 9x duplicated 'ns vs namespace' fallback pattern

The PR copy-pastes this 2-4 line block nine times across the file:

xml_ns = something.get('ns')
if xml_ns is None:
    xml_ns = something.get('namespace')

at lines 633-635, 639-641, 774-776, 778-780, 1278-1280, 1322-1323, 1346-1348, 1365-1369, and 1388-1391.

Suggestion: Extract a small helper to eliminate the repetition:

def _get_xml_ns(meta: dict) -> typing.Optional[str]:
    ns = meta.get('ns')
    if ns is None:
        ns = meta.get('namespace')
    return ns

This collapses all 9 sites into one-liners, and the two identical prop-to-model namespace resolution blocks (deserialization at lines 633-641 and discriminator at lines 774-780) into:

xml_ns = _get_xml_ns(prop_meta)
if xml_ns is None and not model_meta.get('prefix'):
    xml_ns = _get_xml_ns(model_meta)

Issue	Severity
9x duplicated ns/namespace fallback - extract helper	High (readability/maintainability)
Identical blocks at lines 633-641 and 774-780 - DRY violation	Medium
Future key rename requires 9 edits instead of 1	Medium (fragility)

msyyc · 2026-03-24T02:35:44Z

@copilot fix with review comment #10098 (review)

…mespace fallback pattern Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/c063fa73-5d6e-4cbd-ae5b-c5a2d188abba

Copilot · 2026-03-24T02:39:10Z

Review: model_base.py.jinja2 - duplicated namespace fallback logic

The bug fixes in this PR (namespace key compat, ET.register_namespace ValueError handling, items naming) are all correct. The...

Extracted _get_xml_ns(meta) helper in 460cfdb. All 9 duplicated blocks replaced with one-liner calls; net -12 lines. The identical deser/discriminator blocks at lines 633-641 and 774-780 now both read:

xml_ns = _get_xml_ns(prop_meta)
if xml_ns is None and not model_meta.get("prefix"):
    xml_ns = _get_xml_ns(model_meta)

The old-style "ns" propagation block at line 1310 intentionally remains a raw .get("ns") check since it explicitly skips DPG "namespace" models.

@copilot fix with review comment #10098 (review)

Done in 460cfdb — extracted _get_xml_ns helper, replacing all 9 duplicated ns/namespace fallback blocks.

packages/http-client-python/package.json

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

msyyc · 2026-03-31T05:06:50Z

@copilot fix the following CI error:

2026-03-31T03:17:56.4066343Z generated\encode-array\encode\array\_utils\model_base.py:634: error: Unsupported operand types for + ("str" and "None")  [operator]
2026-03-31T03:17:56.4114450Z generated\encode-array\encode\array\_utils\model_base.py:634: note: Right operand is of type "Optional[Any]"
2026-03-31T03:17:56.8111446Z Found 1 error in 1 file (checked 25 source files)
2026-03-31T03:17:56.8305397Z ERROR:root:encode exited with mypy error 1
2026-03-31T03:17:57.0659412Z Success: no issues found in 7 source files
2026-03-31T03:17:57.3856885Z Success: no issues found in 5 source files
2026-03-31T03:17:58.4850745Z ERROR:root:client exited with mypy error 1
2026-03-31T03:17:58.4851655Z generated\client-overload\client\overload\_utils\model_base.py:634: error: Unsupported operand types for + ("str" and "None")  [operator]
2026-03-31T03:17:59.3867577Z ERROR:root:encode exited with mypy error 1
2026-03-31T03:17:59.3868340Z generated\client-overload\client\overload\_utils\model_base.py:634: note: Right operand is of type "Optional[Any]"
2026-03-31T03:18:01.9578359Z ERROR:root:encode exited with mypy error 1
2026-03-31T03:18:01.9579337Z Found 1 error in 1 file (checked 23 source files)
2026-03-31T03:18:01.9579954Z Success: no issues found in 7 source files
2026-03-31T03:18:01.9580632Z generated\encode-bytes\encode\bytes\_utils\model_base.py:634: error: Unsupported operand types for + ("str" and "None")  [operator]
2026-03-31T03:18:01.9581417Z generated\encode-bytes\encode\bytes\_utils\model_base.py:634: note: Right operand is of type "Optional[Any]"
2026-03-31T03:18:01.9582099Z Success: no issues found in 7 source files
2026-03-31T03:18:01.9582661Z Found 1 error in 1 file (checked 56 source files)
2026-03-31T03:18:01.9583232Z Success: no issues found in 5 source files
2026-03-31T03:18:01.9583966Z Success: no issues found in 5 source files
2026-03-31T03:18:01.9584508Z Success: no issues found in 7 source files
2026-03-31T03:18:01.9585057Z Success: no issues found in 5 source files
2026-03-31T03:18:01.9585730Z generated\encode-datetime\encode\datetime\_utils\model_base.py:634: error: Unsupported operand types for + ("str" and "None")  [operator]
2026-03-31T03:18:01.9586535Z generated\encode-datetime\encode\datetime\_utils\model_base.py:634: note: Right operand is of type "Optional[Any]"
2026-03-31T03:18:01.9587211Z Success: no issues found in 5 source files
2026-03-31T03:18:01.9587733Z Found 1 error in 1 file (checked 48 source files)

…rialization Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/bacb0178-de28-436e-81a5-8ecd967cc74d Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot · 2026-03-31T05:14:19Z

@copilot fix the following CI error:

...

Fixed in ab1635e. The mypy error was caused by xml_name = prop_meta.get("itemsName") returning Optional[Any], then being used in string concatenation. The fix saves the .get() result to a local variable _items_name and assigns it to xml_name inside the truthy guard, allowing mypy to narrow the type correctly.

Initial plan

76f98bf

Copilot AI assigned Copilot and msyyc Mar 19, 2026

Copilot started work on behalf of msyyc March 19, 2026 22:35 View session

Copilot AI and others added 2 commits March 19, 2026 22:48

Add Python mock API tests for XML scenarios from PR #10063

92b4f27

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Remove accidentally committed .venv_test directory and add to .gitignore

03e4c73

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

microsoft-github-policy-service bot added the emitter:client:python Issue for the Python client emitter: @typespec/http-client-python label Mar 19, 2026

Copilot AI changed the title ~~[WIP] Add test case for typespec pull request 10063~~ [python] Add mock API tests for XML scenarios from PR #10063 Mar 19, 2026

Copilot AI requested a review from msyyc March 19, 2026 22:53

Copilot finished work on behalf of msyyc March 19, 2026 22:53

Merge branch 'main' into copilot/add-test-case-typespec-10063

9540ee7

msyyc marked this pull request as ready for review March 20, 2026 00:59

msyyc requested review from AlitzelMendez, ChenxiJiang333, bterlson, catalinaperalta, chrisradek, iscai-msft, lmazuel, markcowl, mccoyp, swathipil, tadelesh, timotheeguerin and witemple-msft as code owners March 20, 2026 00:59

msyyc mentioned this pull request Mar 20, 2026

[python] Add mock API tests for XML scenarios from PR #10063 Azure/autorest.python#3391

Open

msyyc reviewed Mar 20, 2026

View reviewed changes

packages/http-client-python/generator/test/generic_mock_api_tests/test_payload_xml.py Outdated Show resolved Hide resolved

Copilot AI requested a review from msyyc March 23, 2026 06:35

Copilot finished work on behalf of msyyc March 23, 2026 06:35

Copilot started work on behalf of msyyc March 23, 2026 06:35 View session

Copilot finished work on behalf of msyyc March 23, 2026 06:47

msyyc requested a review from Copilot March 23, 2026 07:24

Copilot started reviewing on behalf of msyyc March 23, 2026 07:25 View session

Copilot AI reviewed Mar 23, 2026

View reviewed changes

msyyc reviewed Mar 24, 2026

View reviewed changes

Merge branch 'main' into copilot/add-test-case-typespec-10063

4d6993f

Copilot started work on behalf of msyyc March 24, 2026 02:35 View session

refactor: extract _get_xml_ns helper to eliminate 9x duplicated ns/na…

460cfdb

…mespace fallback pattern Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/c063fa73-5d6e-4cbd-ae5b-c5a2d188abba

Copilot AI requested a review from msyyc March 24, 2026 02:40

Copilot finished work on behalf of msyyc March 24, 2026 02:40

iscai-msft approved these changes Mar 24, 2026

View reviewed changes

msyyc reviewed Mar 31, 2026

View reviewed changes

packages/http-client-python/package.json Outdated Show resolved Hide resolved

Copilot started work on behalf of msyyc March 31, 2026 02:41 View session

Merge branch 'main' into copilot/add-test-case-typespec-10063

24925b9

Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot AI changed the title ~~[python] Add mock API tests for XML scenarios from PR #10063 and fix XML serialization bugs (WIP)~~ [python] Add mock API tests for XML scenarios from PR #10063 and fix XML serialization bugs Mar 31, 2026

Copilot finished work on behalf of msyyc March 31, 2026 02:43

Copilot AI requested a review from msyyc March 31, 2026 02:43

Copilot started work on behalf of msyyc March 31, 2026 05:06 View session

fix: resolve mypy error for Optional[Any] in XML unwrapped array dese…

ab1635e

…rialization Agent-Logs-Url: https://github.com/microsoft/typespec/sessions/bacb0178-de28-436e-81a5-8ecd967cc74d Co-authored-by: msyyc <70930885+msyyc@users.noreply.github.com>

Copilot finished work on behalf of msyyc March 31, 2026 05:16

Conversation

Copilot AI commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

pkg-pr-new bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

@typespec/http-client-python - internal ✏️

Uh oh!

azure-sdk commented Mar 20, 2026

Uh oh!

Uh oh!

msyyc commented Mar 23, 2026

Uh oh!

Copilot AI commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Review

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

msyyc left a comment

Choose a reason for hiding this comment

Review: model_base.py.jinja2 - duplicated namespace fallback logic

Core issue: 9x duplicated 'ns vs namespace' fallback pattern

Uh oh!

msyyc commented Mar 24, 2026

Uh oh!

Copilot AI commented Mar 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review: model_base.py.jinja2 - duplicated namespace fallback logic

Uh oh!

Uh oh!

msyyc commented Mar 31, 2026

Uh oh!

Copilot AI commented Mar 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Copilot AI commented Mar 19, 2026 •

edited

Loading

pkg-pr-new bot commented Mar 20, 2026 •

edited

Loading

github-actions bot commented Mar 20, 2026 •

edited

Loading

`@typespec/http-client-python` - internal ✏️

Copilot AI commented Mar 23, 2026 •

edited

Loading

Review: `model_base.py.jinja2` - duplicated namespace fallback logic

Copilot AI commented Mar 24, 2026 •

edited

Loading

Review: `model_base.py.jinja2` - duplicated namespace fallback logic