[core] add tests and fix backcompat functions#44084
Merged
pvaneck merged 14 commits intoAzure:mainfrom Dec 8, 2025
Merged
Conversation
iscai-msft
requested review from
annatisch,
johanste,
kashifkhan,
lmazuel,
pvaneck and
xiangyan99
as code owners
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive test coverage and fixes the backward compatibility functions attribute_list and as_attribute_dict to handle properties that are padded in TypeSpec-generated code but were not padded in AutoRest-generated code. The fix introduces an original_tsp_name parameter to track the original property names before padding, ensuring backward compatibility with existing code.
Key Changes:
- Added
original_tsp_nameparameter to_RestFieldandrest_fieldto track original TypeSpec property names before padding - Implemented
_backcompat_attr_to_rest_fieldmapping that uses original names when available, falling back to attribute names otherwise - Enhanced serialization functions to use backward-compatible names for attribute lists and dictionaries
- Added comprehensive test matrix covering all combinations of wire names, attribute names, TSP names, visibility, and structure variations
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| sdk/core/azure-core/tests/test_serialization.py | Adds comprehensive test matrix (TestBackcompatPropertyMatrix) covering all combinations of backcompat scenarios including regular, nested, and flattened models with different wire names, padded attributes, and readonly properties |
| sdk/core/azure-core/tests/specs_sdk/modeltypes/modeltypes/_utils/model_base.py | Implements _backcompat_attr_to_rest_field mapping in Model class initialization, adds _get_backcompat_attribute_name helper method, and extends _RestField and rest_field to accept original_tsp_name parameter |
| sdk/core/azure-core/azure/core/serialization.py | Adds _get_backcompat_attr_to_rest_field helper function and updates _get_flattened_attribute, attribute_list, and as_attribute_dict to use backcompat mappings for proper property name resolution |
sdk/core/azure-core/tests/specs_sdk/modeltypes/modeltypes/_utils/model_base.py
Outdated
Show resolved
Hide resolved
sdk/core/azure-core/tests/specs_sdk/modeltypes/modeltypes/_utils/model_base.py
Outdated
Show resolved
Hide resolved
msyyc
reviewed
Nov 18, 2025
2 tasks
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
pvaneck
reviewed
Nov 19, 2025
msyyc
approved these changes
Dec 3, 2025
…into fix_backcompat_padding
github-merge-queue bot
pushed a commit
to microsoft/typespec
that referenced
this pull request
Dec 4, 2025
fix #9013 Related PR: - [ ] Azure/azure-sdk-for-python#44084 - [x] #9019 --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com> Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
pvaneck
reviewed
Dec 4, 2025
msyyc
reviewed
Dec 8, 2025
lmazuel
approved these changes
Dec 8, 2025
Member
lmazuel
left a comment
lmazuel
left a comment
There was a problem hiding this comment.
Didn't look into the details, but this matches the strategy we discussed offline
pvaneck
approved these changes
Dec 8, 2025
Member
|
/check-enforcer override |
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.
We are running into issues with the backcompat functions
attribute_listandas_attribute_dictbecause there are some properties that we didn't pad in auto rest generated code (i.e.keys), but that we pad now in tsp generated code. We want to return the old non-padded properties in this case