{Core} Stop importing pkg_resources when getting versions#14905
Merged
{Core} Stop importing pkg_resources when getting versions#14905
Conversation
jiasli
requested review from
Juliehzl,
arrownj,
fengzhou-msft,
haroldrandom,
jsntcy and
mmyyrroonn
as code owners
Member
Author
Side-notesIn PyCharm, setting a breakpoint at to However, when directly executing The Instead, you may put in Full callstack for `python -m azure.cli version`Then if you start debugging in PyCharm, the output shows how PyCharm imports Full callstack for debugging in PyCharm |
Collaborator
|
Core |
arrownj
reviewed
Aug 26, 2020
| # return [d for d in list(working_set) if d.key == CLI_PACKAGE_NAME or d.key.startswith(COMPONENT_PREFIX)] | ||
|
|
||
| # Use the hard-coded version instead of querying all modules under site-packages. | ||
| from azure.cli.__main__ import __version__ as azure_cli_version |
Contributor
There was a problem hiding this comment.
From azure-cli-core perspective, we should not assume there is a azure-cli repo. That is to say, azure.cli.__main__ may not exist.
Member
Author
There was a problem hiding this comment.
Good catch! As now azure-cli and azure-cli-core have the same version, we don't need this dependency anymore.
Also importing azure.cli.__main__ will cause __main__ to be executed, thus causing CI failure:
=====================
| Discovering Tests |
=====================
az: 'test' is not in the 'az' command group. See 'az --help'. If the command is from an extension, please make sure the corresponding extension is installed. To learn more about extensions, please visit https://docs.microsoft.com/en-us/cli/azure/azure-cli-extensions-overview
The most similar choice to 'test' is:
rest
3 tasks
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
5 participants
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
az versionand the version check introduced in #14803 query the local versions of Azure CLI modules:azure-cliazure-cli-command-modules-nspkgazure-cli-coreazure-cli-nspkgazure-cli-telemetryThe current implementation uses
pkg_resources.working_setwhich takes ~200ms to load:This is outstanding compared to
az version's 500ms running time.This PR uses the hard-coded version instead of querying all modules under
site-packagesusingpkg_resources.Removal of
azure-cli-dev-toolsandazure-cli-testsdkThis PR removes
azure-cli-dev-toolsandazure-cli-testsdk. The removal only applies to dev CLI, and won't affect the released CLI (they are not present at all). It is safe for public users.After the change, the dev CLI and released CLI have the same output.
Performance
The performance improvement is significant - from ~500ms to ~300ms:
site-packagesis not imported anymore:Testing Guide
az version Measure-Command {az version}