{Core} Fix bug in deprecation register when action argument is missing#32104
Merged
{Core} Fix bug in deprecation register when action argument is missing#32104
Conversation
ReaNAiveD
requested review from
bebound,
calvinhzy,
evelyn-ys,
jiasli,
jsntcy,
kairu-ms,
necusjz and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a KeyError bug in the deprecation register when registering breaking changes for arguments that have an implicit action. The fix uses the safer .get() method to handle missing action keys, allowing the system to gracefully handle arguments without explicit actions.
- Replace dictionary access with
.get()method to safely retrieve action value - Handle cases where arguments have implicit actions by allowing
Noneto be passed - Improve robustness of the breaking change registration system
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Collaborator
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
microsoft-github-policy-service
bot
added
Auto-Assign
zhoxing-ms
approved these changes
Sep 15, 2025
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.
Related command
Description
This PR addresses a
KeyErrorthat occurred when registering an upcoming breaking change on an argument with an implicit action. The issue is resolved by using the.get()method to safely returnNoneif the key does not exist.Additionally,
_argument_breaking_change_actionacceptsNoneas a valid action. In such cases, the base action class defaults toargparse.Action, which raises aNotImplementedErrorwhen its__call__method is invoked. TheArgumentBreakingChangeActionclass catches this exception and falls back to behaving like a store action.This behavior aligns with the implementation in Knack:
https://github.com/microsoft/knack/blob/fb5699615a3c8b93c6bf8068306709af1c37a079/knack/arguments.py#L163-L216.
This will resolve the comments in code in #32070.
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.