Warning when obsolete msal-extensions is detected #752
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
jiasli
reviewed
Sep 26, 2024
| # Can't run this in module or class level otherwise you'll get circular import error | ||
| try: | ||
| from msal_extensions import __version__ as v | ||
| major, minor, _ = v.split(".", maxsplit=3) |
There was a problem hiding this comment.
Just as an FYI, Azure CLI uses packaging.version for version parsing:
but it may be too heavy for MSAL.
There was a problem hiding this comment.
Indeed. In fact, msal-extensions used to also use packaging.version but have since removed it in https://github.com/AzureAD/microsoft-authentication-extensions-for-python/pull/125.
jiasli
reviewed
Sep 26, 2024
| @@ -194,6 +194,21 @@ def obtain_token_by_username_password(self, username, password, **kwargs): | |||
| username, password, headers=headers, **kwargs) | |||
|
|
|||
|
|
|||
| def _msal_extension_check(): | |||
| # Can't run this in module or class level otherwise you'll get circular import error | |||
There was a problem hiding this comment.
Nice comment! Makes things clear.
jiasli
approved these changes
Sep 26, 2024
rayluo
force-pushed
the
msal-extensions-check
branch
from
28af693
to
bb6d872
Compare
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.
The lengthy discussion in "Updates to msal/application.py may now be out-of-sync with msal_extensions"
#745 considered a mitigation of introducing a new optional dependency
msal[extensions]for MSAL. However, after offline discussion, we believe it has two drawbacks: (1) it is hardly discoverable for mostmsal-extensionsusers, and (2) it introduces a permanent "msal[extensions]" declaration only for trivial gain.So, we ended up settling on an alternative. MSAL will now detect the
msal-extensionsfrom the current environment. If its version is lower than 1.2.0, MSAL will emit a warning like this:This PR will close #745 .
CC @jiasli , @kcphila