{Core} Add dict transformation for typespec generated SDKs #30339
Conversation
This file contains 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
evelyn-ys
requested review from
jiasli,
jsntcy,
kairu-ms,
zhoxing-ms,
calvinhzy,
necusjz and
bebound
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
microsoft-github-policy-service
bot
added
Auto-Assign
|
@microsoft-github-policy-service rerun |
|
@microsoft-github-policy-service rerun |
jiasli
reviewed
Nov 26, 2024
Comment on lines
+648
to
+650
| if hasattr(obj, 'as_dict') and not hasattr(obj, '_attribute_map'): | ||
| result = {to_camel_case(k): todict(v, post_processor) for k, v in obj.as_dict().items()} | ||
| return post_processor(obj, result) if post_processor else result |
There was a problem hiding this comment.
A good question from @kairu-ms, what if the REST spec defines a asDict property?
There was a problem hiding this comment.
For now there is no such a property: https://github.com/search?q=repo%3AAzure%2Fazure-rest-api-specs%20asDict&type=code. If there is one in the future, we could rename it.
jiasli
reviewed
Nov 26, 2024
| # This is the only difference with knack.util.todict because for typespec generated SDKs | ||
| # The base model stores data in obj.__dict__['_data'] instead of in obj.__dict__ | ||
| # We need to call obj.as_dict() to extract data for this kind of model | ||
| if hasattr(obj, 'as_dict') and not hasattr(obj, '_attribute_map'): |
There was a problem hiding this comment.
Another approach to detect if obj is an SDK model is something similar to
type(obj).__base__.__name__ == 'Model'str(type(obj).__base__) returns
"<class 'azure.cli.command_modules.keyvault.vendored_sdks.azure_keyvault_securitydomain._model_base.Model'>"However, this is also not very reliable as the name Model may change at any time.
Using isinstance() is impossible as Model is defined in each SDK, such as azure.cli.command_modules.keyvault.vendored_sdks.azure_keyvault_securitydomain._model_base.Model, instead of in azure.core. There is no single Model that is the base class of all SDK objects.
Also, using isinstance() requires importing the Model class which impairs the performance.
As an example, remove_additional_prop_layer previously imports Model with
from msrest.serialization import Model#13843 changed it to use a try... catch... strategy:
azure-cli/src/azure-cli-core/azure/cli/core/commands/__init__.py
Lines 899 to 908 in 375b34d
Thus, there is no need to import Model for non-Model objects.
jiasli
approved these changes
Nov 26, 2024
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.
Related command
Description
SDK models have changed when we move from swagger generated to typespec generated. This cause issues for
knack.util.todictto do the formatter over command output. We callazure-cli/src/azure-cli-core/azure/cli/core/commands/__init__.py
Line 718 in eb55296
knack:Currently working with swagger generated models, it runs into
hasattr(obj, '__dict__')and transformsobj.__dict__.items()one by one if the item isn't private starting with_.But now for typespec generated models, a new base model is designed to store all data in
__dict__['_data']. In such case, we won't get anything by iterating__dict__as before. The new model provides aas_dictfunc instead to transform the model object to dict.Here's an example for swagger generated models(old) and typespec generated models(new)
There are three workarounds:
obj.as_dict()or get needed attributes by themselves (eg. {Keyvault}az keyvault security-domain: Migrate security domain to use track2 SDK #30252 (comment))knack.util.todictto detecthasattr(obj, 'as_dict')knack.util.todictinazure.cli.coreto detecthasattr(obj, 'as_dict')This PR works for the third solution.
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE:
az command a: Make some customer-facing breaking change[Component Name 2]
az command b: Add some customer-facing featureThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.