[docs] add new backcompat serialization methods to migration guide #41895
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds new backcompat serialization helper methods to the Azure Core SDK and updates the migration guide to document their usage.
- Export three new helper functions in
azure.core.serializationfor backward compatibility. - Introduce code examples in the migration guide showing how to use
as_attribute_dict. - Document the new helper methods (
is_generated_model,attribute_list) in the guide.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| sdk/core/azure-core/azure/core/serialization.py | Updated __all__ to export is_generated_model, as_attribute_dict, and attribute_list |
| doc/dev/mgmt/hybrid_model_migration.md | Added backcompat code samples and a section for additional helper methods |
Comments suppressed due to low confidence (3)
doc/dev/mgmt/hybrid_model_migration.md:277
- The Additional Helper Methods section lists is_generated_model and attribute_list but omits as_attribute_dict. Consider adding a documentation entry for as_attribute_dict to provide a complete overview of helper methods.
For edge cases and generic code that works with models, Azure Core provides these utility methods in `azure.core.serialization`:
sdk/core/azure-core/azure/core/serialization.py:14
- [nitpick] Add unit tests covering the new serialization helper methods (as_attribute_dict, is_generated_model, attribute_list) to ensure their behavior is validated across different model scenarios.
__all__ = ["NULL", "AzureJSONEncoder", "is_generated_model", "as_attribute_dict", "attribute_list"]
sdk/core/azure-core/azure/core/serialization.py:14
- The newly added names in all are not defined or imported in this module, which will cause a NameError. Ensure that is_generated_model, as_attribute_dict, and attribute_list are implemented or imported before exporting them.
__all__ = ["NULL", "AzureJSONEncoder", "is_generated_model", "as_attribute_dict", "attribute_list"]
pvaneck
reviewed
Jul 3, 2025
…into core/addSerializationMethodsToAll
Co-authored-by: Paul Van Eck <paulvaneck@microsoft.com>
mccoyp
approved these changes
Jul 10, 2025
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.
No description provided.