[Storage] Fix mypy regressions for Blob, Queue, File Share
#43610
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
weirongw23-msft
requested review from
annatisch,
jalauzon-msft and
vincenttran-msft
as code owners
There was a problem hiding this comment.
Pull Request Overview
This PR fixes mypy regressions in the Azure Storage SDK by adding explicit type annotations for instance attributes across Blob, Queue, and File Share client classes.
Key changes:
- Added type annotations to client classes to satisfy
mypytype checking requirements - Added property access statements in sample code to ensure the annotated attributes are validated by
mypy
Reviewed Changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py | Added queue_name: str attribute annotation to QueueClient |
| sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_client_async.py | Added queue_name: str attribute annotation to async QueueClient |
| sdk/storage/azure-storage-queue/samples/queue_samples_hello_world.py | Added property access to validate queue_name attribute |
| sdk/storage/azure-storage-queue/samples/queue_samples_hello_world_async.py | Added property access to validate queue_name attribute |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.pyi | Added type annotations for share_name, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.pyi | Added type annotations for share_name, file_name, file_path, directory_path, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.pyi | Added type annotations for share_name, directory_path, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_share_client_async.pyi | Added type annotations for share_name, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_file_client_async.pyi | Added type annotations for share_name, file_name, file_path, directory_path, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/azure/storage/fileshare/aio/_directory_client_async.pyi | Added type annotations for share_name, directory_path, allow_trailing_dot, allow_source_trailing_dot, and file_request_intent |
| sdk/storage/azure-storage-file-share/samples/file_samples_share.py | Added property accesses to validate ShareClient attributes |
| sdk/storage/azure-storage-file-share/samples/file_samples_share_async.py | Added property accesses to validate async ShareClient attributes |
| sdk/storage/azure-storage-file-share/samples/file_samples_hello_world.py | Added property accesses to validate ShareFileClient attributes |
| sdk/storage/azure-storage-file-share/samples/file_samples_hello_world_async.py | Added property accesses to validate async ShareFileClient attributes |
| sdk/storage/azure-storage-file-share/samples/file_samples_directory.py | Added property accesses to validate ShareDirectoryClient attributes |
| sdk/storage/azure-storage-file-share/samples/file_samples_directory_async.py | Added property accesses to validate async ShareDirectoryClient attributes |
| sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.pyi | Added type annotations for container_name, blob_name, snapshot, and version_id |
| sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.pyi | Added type annotations for container_name, blob_name, snapshot, and version_id |
| sdk/storage/azure-storage-blob/samples/blob_samples_hello_world.py | Added property accesses to validate BlobClient and ContainerClient attributes |
| sdk/storage/azure-storage-blob/samples/blob_samples_hello_world_async.py | Added property accesses to validate async BlobClient and ContainerClient attributes |
API Change CheckAPIView identified API level changes in this PR and created the following API reviews |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solves #43601