Azure / azure-storage-python

Microsoft Azure Storage Library for Python
https://azure-storage.readthedocs.io
MIT License
338 stars 240 forks source link

Undocumented breaking change to azure.storage.blob.baseblobservice.BaseBlobService.generate_blob_shared_access_signature in 2.0 #595

Closed taymonbeal closed 5 years ago

taymonbeal commented 5 years ago

Which service(blob, file, queue) does this issue concern?

Blob

Which version of the SDK was used? Please provide the output of pip freeze.

azure-common==1.1.20
azure-storage-blob==2.0.1
azure-storage-common==2.0.0

What problem was encountered?

azure.storage.blob.baseblobservice.BaseBlobService.generate_blob_shared_access_signature acquired a new parameter, snapshot, in 2.0. This parameter was inserted before permission. This breaks code that passes permission positionally. Notably, django-storages does this.

Have you found a mitigation/solution?

Patch dependents to pass permission by keyword.

zezha-msft commented 5 years ago

Hi @taymonbeal, thanks for reaching out!

Sorry for the inconvenience! We'll make sure to be more explicit in the changelog in future releases.