{Core} Fix incorrect _get_message and _get_tag in MergedStatusTag#31574
Merged
Conversation
ReaNAiveD
requested review from
bebound,
calvinhzy,
evelyn-ys,
jiasli,
jsntcy,
kairu-ms,
necusjz and
zhoxing-ms
as code owners
️✔️AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes incorrect parameter usage in the merged tag and message helpers of MergedStatusTag so that each tag’s own methods receive the correct context.
_get_merged_tagnow passes each individual tag to its_get_tagmethod instead of the merged object._get_merged_msgnow passes each individual tag to its_get_messagemethod instead of the merged object.
Comment on lines
+109
to
+112
| return ''.join({tag._get_tag(tag) for tag in self.tags}) # pylint: disable=protected-access | ||
|
|
||
| def _get_merged_msg(self): | ||
| return '\n'.join({tag._get_message(self) for tag in self.tags}) # pylint: disable=protected-access | ||
| return '\n'.join({tag._get_message(tag) for tag in self.tags}) # pylint: disable=protected-access |
There was a problem hiding this comment.
Using a set comprehension here can lead to unpredictable ordering and will drop duplicate tags. If you need to preserve the original order (and possible duplicates), use a list or generator expression, for example: ''.join(tag._get_tag(tag) for tag in self.tags).
|
|
||
| def _get_merged_msg(self): | ||
| return '\n'.join({tag._get_message(self) for tag in self.tags}) # pylint: disable=protected-access | ||
| return '\n'.join({tag._get_message(tag) for tag in self.tags}) # pylint: disable=protected-access |
There was a problem hiding this comment.
Similar to the tag merge, this set comprehension will reorder messages and remove duplicates. Consider using \n.join(tag._get_message(tag) for tag in self.tags) to keep the original sequence intact.
Suggested change
| return '\n'.join({tag._get_message(tag) for tag in self.tags}) # pylint: disable=protected-access | |
| return '\n'.join(tag._get_message(tag) for tag in self.tags) # pylint: disable=protected-access |
kairu-ms
approved these changes
May 29, 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 is a fix for incorrect _get_message and _get_tag in MergedStatusTag. Document generation directly call _get_message from a tag but there is a bug in its implementation.
This didn't be discovered because cli call property method message(self) and tag(self) instead of _get_message and _get_tag.
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.