Skip to content

Handle ImportError when constructing DefaultAzureCredential #8294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chlowell merged 4 commits into from
Nov 13, 2019
Merged

Handle ImportError when constructing DefaultAzureCredential #8294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7463ff2
default credential handles expected ImportError
chlowell Oct 30, 2019
58460c5
update history
chlowell Oct 30, 2019
a035d7d
use logging interpolation syntax
chlowell Oct 30, 2019
ec18b8a
handle all SharedTokenCacheCredential init exceptions
chlowell Nov 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk/identity/azure-identity/HISTORY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Release History

### 1.1.0b1 Unreleased
- Constructing `DefaultAzureCredential` no longer raises `ImportError` on Python
3.8 on Windows ([8294](https://github.com/Azure/azure-sdk-for-python/pull/8294))


### 2019-11-05 1.0.1
Expand Down
16 changes: 11 additions & 5 deletions sdk/identity/azure-identity/azure/identity/_credentials/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import logging
import os

from .._constants import EnvironmentVariables
Expand All @@ -10,6 +11,8 @@
from .managed_identity import ManagedIdentityCredential
from .user import SharedTokenCacheCredential

_LOGGER = logging.getLogger(__name__)


class DefaultAzureCredential(ChainedTokenCredential):
"""A default credential capable of handling most Azure SDK authentication scenarios.
Expand All @@ -35,10 +38,13 @@ def __init__(self, **kwargs):

# SharedTokenCacheCredential is part of the default only on supported platforms.
if SharedTokenCacheCredential.supported():
credentials.append(
SharedTokenCacheCredential(
username=os.environ.get(EnvironmentVariables.AZURE_USERNAME), authority=authority, **kwargs
)
)
try:
# username is only required to disambiguate, when the cache contains tokens for multiple identities
username = os.environ.get(EnvironmentVariables.AZURE_USERNAME)
shared_cache = SharedTokenCacheCredential(username=username, authority=authority, **kwargs)
credentials.append(shared_cache)
except Exception as ex: # pylint:disable=broad-except
# transitive dependency pywin32 doesn't support 3.8 (https://github.com/mhammond/pywin32/issues/1431)
_LOGGER.info("Shared token cache is unavailable: '%s'", ex)

super(DefaultAzureCredential, self).__init__(*credentials)
16 changes: 11 additions & 5 deletions sdk/identity/azure-identity/azure/identity/aio/_credentials/default.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import logging
import os

from ..._constants import EnvironmentVariables
Expand All @@ -10,6 +11,8 @@
from .managed_identity import ManagedIdentityCredential
from .user import SharedTokenCacheCredential

_LOGGER = logging.getLogger(__name__)


class DefaultAzureCredential(ChainedTokenCredential):
"""A default credential capable of handling most Azure SDK authentication scenarios.
Expand All @@ -35,10 +38,13 @@ def __init__(self, **kwargs):

# SharedTokenCacheCredential is part of the default only on supported platforms.
if SharedTokenCacheCredential.supported():
credentials.append(
SharedTokenCacheCredential(
username=os.environ.get(EnvironmentVariables.AZURE_USERNAME), authority=authority, **kwargs
)
)
try:
# username is only required to disambiguate, when the cache contains tokens for multiple identities
username = os.environ.get(EnvironmentVariables.AZURE_USERNAME)
shared_cache = SharedTokenCacheCredential(username=username, authority=authority, **kwargs)
credentials.append(shared_cache)
except Exception as ex: # pylint:disable=broad-except
# transitive dependency pywin32 doesn't support 3.8 (https://github.com/mhammond/pywin32/issues/1431)
_LOGGER.info("Shared token cache is unavailable: '%s'", ex)

super().__init__(*credentials)
⚡