azure-storage-blob upgrade 12.28.0 -> 12.29.0 typing error in BlobClient append_block

[ghaarsma]

• azure-storage-blob:
• 12.29.0:
• Windows / Linux:
• 3.13:

After azure-storage-blob upgrade 12.28.0 -> 12.29.0, we are getting mypy errors when passing a str object to BlobClient append_block

• The 12.29 release notes, don't mention any change in this function
• The documentation still shows that you can pass a str

mypy error log

(venv) PS C:\Users\Python\dwsc-site> mypy
storage.py:292: error: Argument "data" to "append_block" of "BlobClient" has incompatible type "str"; expected "bytes | Iterable[bytes] | IO[bytes]"  [arg-type]
storage.py:292: note: Following member(s) of "str" have conflicts:
storage.py:292: note:     Expected:
storage.py:292: note:         def __iter__(self) -> Iterator[bytes]
storage.py:292: note:     Got:
storage.py:292: note:         def __iter__(self) -> Iterator[str]

[kashifkhan]

Thank you for the feedback @ghaarsma . Ive forwarded the issue to the team that can help you further

[github-actions]

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @jalauzon-msft @vincenttran-msft.

[jalauzon-msft]

Hi @ghaarsma, thanks for reaching out. We intentionally removed the typing support for str as we are deprecating str support in favor of bytes. We did not change any functionality so code will continue to work, and you can use a type: ignore if you wish, but we recommend you switch to bytes based inputs.

The documentation has since been updated (it is a bit delayed from release) but apologies for not including in the CHANGELOG.

[ghaarsma]

Understood. I did update our code base and switched to bytes. I think, in the future, al this could be more elegantly handled with a DeprecationWarning or a FutureWarning.

[jalauzon-msft]

Agreed we could have handled this a little better. We wanted to be subtle as I didn't think there were many users relying on str but a warning in a previous release would probably have been a good idea. Will keep this in mind for future typing breaking changes, thanks.