Skip to content
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

upgrade azure-storage and pass token_credential argument (#3005) #3008

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

upgrade azure-storage and pass token_credential argument (#3005) #3008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8949d7
upgrade azure-storage to the latest version that supports BlockBlobSe…
vbarbaresi Oct 12, 2020
4e73339
syntax: use kwargs.get default argument
vbarbaresi Oct 13, 2020
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
4 changes: 3 additions & 1 deletion luigi/contrib/azureblob.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def __init__(self, account_name=None, account_key=None, sas_token=None, **kwargs
* `token_credential` - A token credential used to authenticate HTTPS requests. The token value should be updated before its expiration.
"""
self.options = {"account_name": account_name, "account_key": account_key, "sas_token": sas_token}
kwargs["protocol"] = kwargs.get("protocol", "https") # Default protocol to https if it's not set
self.kwargs = kwargs

@property
Expand All @@ -74,7 +75,8 @@ def connection(self):
connection_string=self.kwargs.get("connection_string"),
endpoint_suffix=self.kwargs.get("endpoint_suffix"),
custom_domain=self.kwargs.get("custom_domain"),
is_emulated=self.kwargs.get("is_emulated") or False)
is_emulated=self.kwargs.get("is_emulated", False),
token_credential=self.kwargs.get("token_credential"))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will azure-storage<=0.36 allow for the passing of token_credential without fail? (even if without impact)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, it immediately fails

>>> blockblobservice.BlockBlobService(account_name="a", token_credential="a")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: __init__() got an unexpected keyword argument 'token_credential'

do you prefer to keep some compatibility in here in case users aren't able to upgrade their packages?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wait, i see the hard update on az dependencies anyway.

So either we make this change, as is, and include it as an explicit breaking change. Or we explore options for enabling both.

I'm not immediately thinking of an easy way to keep compatibility.

azure-storage==0.36 is also from 2017...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can refactor these keyword arguments in a dict, and add token_credential argument only if we're using the new azure package:

from pkg_resources import parse_version
new_azure_package = parse_version(azure.storage.blob.__version__) >= parse_version("2.1.0")

(Under a try/except AttributeError because this attribute didn't exist in the old package, it's azure.storage.__version__ )

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed it in another branch 0566938
I can cherry-pick this here, it's up to you


def upload(self, tmp_path, container, blob, **kwargs):
logging.debug("Uploading file '{tmp_path}' to container '{container}' and blob '{blob}'".format(
Expand Down
6 changes: 4 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ deps =
pymongo==3.4.0
toml<2.0.0
responses<1.0.0
azure-storage<=0.36
azure-storage-common==2.1.0
azure-storage-blob==2.1.0
datadog==0.22.0
prometheus-client==0.5.0
dropbox: dropbox>=9.3.0<10.0
Expand Down Expand Up @@ -124,7 +125,8 @@ deps =
Sphinx>=1.4.4,<1.5
sphinx_rtd_theme
enum34>1.1.0
azure-storage<=0.36
azure-storage-common==2.1.0
azure-storage-blob==2.1.0
prometheus-client==0.5.0
commands =
# build API docs
Expand Down