-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
{Core} Add dict transformation for typespec generated SDKs #30339
Draft
evelyn-ys
wants to merge
3
commits into
Azure:dev
Choose a base branch
from
evelyn-ys:result_to_dict
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
November 14, 2024 01:42
❌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
Auto assign by bot
Core
CLI core infrastructure
labels
Nov 14, 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.todict
to 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_dict
func instead to transform the model object to dict.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))obj.as_dict()
in cli core before callingknack.util.todict
for all modulesknack.util.todict
to detecthasattr(obj, 'as_dict')
This PR works for the second 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.