Skip to content

Type hints incorrect for BlobClient.delete_blob() #13261

@howardjones

Description

@howardjones
  • Package Name: azure-storage-blob
  • Package Version: 12.4.0
  • Operating System: Linux (ubuntu 18 LTS)
  • Python Version: 3.8.0

Describe the bug
A clear and concise description of what the bug is.

Docs for BlobClient.delete_blob() say that it takes a string parameter for delete_snapshots. The type hints on the function itself say that this is a bool.

https://docs.microsoft.com/en-us/python/api/azure-storage-blob/azure.storage.blob.blobclient?view=azure-python#delete-blob-delete-snapshots-false----kwargs-

 @distributed_trace
    def delete_blob(self, delete_snapshots=False, **kwargs):
        # type: (bool, **Any) -> None

Expected behavior
A clear and concise description of what you expected to happen.

The docs should reflect reality. My IDE shouldn't flag my valid code as incorrect.

Metadata

Metadata

Labels

ClientThis issue points to a problem in the data-plane of the library.StorageStorage Service (Queues, Blobs, Files)bugThis issue requires a change to an existing behavior in the product in order to be resolved.customer-reportedIssues that are reported by GitHub users external to the Azure organization.questionThe issue doesn't require a change to the product in order to be resolved. Most issues start as that

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions