{Core} doc_string_source must be full path
#27824
Closed
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
🔄AzureCLI-FullTest
|
️✔️AzureCLI-BreakingChangeTest
|
microsoft-github-policy-service
bot
requested review from
wangzelin007 and
yonzhan
|
CI |
microsoft-github-policy-service
bot
requested review from
jiasli,
kairu-ms and
jsntcy
bebound
force-pushed
the
self-test-import
branch
from
b2dd346 to
6ce9dad
Compare
bebound
changed the title
doc_string_source must be full path
bebound
commented
Nov 13, 2023
| if method_name: | ||
| model = getattr(model, method_name, None) | ||
| if not model: | ||
| raise CLIError("command authoring error: source '{}' not found.".format(doc_string_source)) |
There was a problem hiding this comment.
model can't be empty, so this code is unreachable.
I use the same logic to concat the full path, but I'm not sure whether it will raise error when import.
bebound
requested review from
zhoxing-ms,
evelyn-ys,
calvinhzy and
necusjz
as code owners
|
Solved by #27848 |
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.
Description
This PR fixes the errors when running
az self-test --debugThe
doc_string_sourceincommands.pymust be full path now.Before this PR, in
azure-cli/src/azure-cli-core/azure/cli/core/__init__.py
Lines 707 to 718 in 1fdda16
doc_string_sourceisazure.mgmt.netapp.models#Snapshot,APIVersionExceptionis raised. Run line 718doc_string_sourceisazure.mgmt.keyvault.v2023_02_01.models#VaultProperties, it tries to importazure.mgmt.keyvault.v2023_02_01.azure.mgmt.keyvault.v2023_02_01.modelsin_get_attr()and fails. Run line 718doc_string_sourceisfile#FileService.list_directories_and_filesin azure stack, it finally importsazure.multiapi.storage.v2017_04_17.file#FileService.list_directories_and_filesIn case2, lots of
ModuleNotFoundError: No module named 'azure.mgmt.keyvault.v2023_02_01.azure'is raised.In CLI and extension, the
doc_string_sourceis full path except azure stack. I change thedoc_string_sourceto full path, so CLI does not need to callget_modelsto concat thesdk_pathandclass_pathandmodel = self.get_models(doc_string_source)can be eliminated.Close #27793
Testing Guide
Run
az self-test --debugto check the outputThis 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.