Improved MyPy typing for queues (Azure#21964)

tasherif-msft · web-flow · commit c06ea32256e6 · 2021-12-10T23:32:06.000-08:00
* settings files

* gitignore

* fixed queue mypy
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py
@@ -122,8 +122,12 @@ def _format_url(self, hostname):
             self._query_str)
 
     @classmethod
-    def from_queue_url(cls, queue_url, credential=None, **kwargs):
-        # type: (str, Optional[Any], Any) -> QueueClient
+    def from_queue_url(cls,
+                       queue_url,  # type: str
+                       credential=None,  # type: Optional[Any]
+                       **kwargs  # type: Any
+                       ):
+        # type: (...) -> QueueClient
         """A client to interact with a specific Queue.
 
         :param str queue_url: The full URI to the queue, including SAS token if used.
@@ -163,9 +167,9 @@ def from_queue_url(cls, queue_url, credential=None, **kwargs):
     def from_connection_string(
             cls, conn_str,  # type: str
             queue_name,  # type: str
-            credential=None,  # type: Any
+            credential=None,  # type: Optional[Any]
             **kwargs  # type: Any
-        ):
+     ):
         # type: (...) -> QueueClient
         """Create QueueClient from a Connection String.
 
@@ -199,7 +203,7 @@ def from_connection_string(
 
     @distributed_trace
     def create_queue(self, **kwargs):
-        # type: (Optional[Any]) -> None
+        # type: (Any) -> None
         """Creates a new queue in the storage account.
 
         If a queue with the same name already exists, the operation fails with
@@ -240,7 +244,7 @@ def create_queue(self, **kwargs):
 
     @distributed_trace
     def delete_queue(self, **kwargs):
-        # type: (Optional[Any]) -> None
+        # type: (Any) -> None
         """Deletes the specified queue and any messages it contains.
 
         When a queue is successfully deleted, it is immediately marked for deletion
@@ -272,7 +276,7 @@ def delete_queue(self, **kwargs):
 
     @distributed_trace
     def get_queue_properties(self, **kwargs):
-        # type: (Optional[Any]) -> QueueProperties
+        # type: (Any) -> QueueProperties
         """Returns all user-defined metadata for the specified queue.
 
         The data returned does not include the queue's list of messages.
@@ -303,8 +307,11 @@ def get_queue_properties(self, **kwargs):
         return response # type: ignore
 
     @distributed_trace
-    def set_queue_metadata(self, metadata=None, **kwargs):
-        # type: (Optional[Dict[str, Any]], Optional[Any]) -> None
+    def set_queue_metadata(self,
+                           metadata=None,  # type: Optional[Dict[str, Any]]
+                           **kwargs  # type: Any
+                           ):
+        # type: (...) -> None
         """Sets user-defined metadata on the specified queue.
 
         Metadata is associated with the queue as name-value pairs.
@@ -339,7 +346,7 @@ def set_queue_metadata(self, metadata=None, **kwargs):
 
     @distributed_trace
     def get_queue_access_policy(self, **kwargs):
-        # type: (Optional[Any]) -> Dict[str, Any]
+        # type: (Any) -> Dict[str, AccessPolicy]
         """Returns details about any stored access policies specified on the
         queue that may be used with Shared Access Signatures.
 
@@ -359,8 +366,11 @@ def get_queue_access_policy(self, **kwargs):
         return {s.id: s.access_policy or AccessPolicy() for s in identifiers}
 
     @distributed_trace
-    def set_queue_access_policy(self, signed_identifiers, **kwargs):
-        # type: (Dict[str, AccessPolicy], Optional[Any]) -> None
+    def set_queue_access_policy(self,
+                                signed_identifiers,  # type: Dict[str, AccessPolicy]
+                                **kwargs  # type: Any
+                                ):
+        # type: (...) -> None
         """Sets stored access policies for the queue that may be used with Shared
         Access Signatures.
 
@@ -413,10 +423,11 @@ def set_queue_access_policy(self, signed_identifiers, **kwargs):
             process_storage_error(error)
 
     @distributed_trace
-    def send_message( # type: ignore
-            self, content, # type: Any
-            **kwargs  # type: Optional[Any]
-        ):
+    def send_message(
+            self,
+            content,  # type: Any
+            **kwargs  # type: Any
+    ):
         # type: (...) -> QueueMessage
         """Adds a new message to the back of the message queue.
 
@@ -492,7 +503,7 @@ def send_message( # type: ignore
 
     @distributed_trace
     def receive_message(self, **kwargs):
-        # type: (Optional[Any]) -> QueueMessage
+        # type: (Any) -> QueueMessage
         """Removes one message from the front of the queue.
 
         When the message is retrieved from the queue, the response includes the message
@@ -548,7 +559,7 @@ def receive_message(self, **kwargs):
 
     @distributed_trace
     def receive_messages(self, **kwargs):
-        # type: (Optional[Any]) -> ItemPaged[QueueMessage]
+        # type: (Any) -> ItemPaged[QueueMessage]
         """Removes one or more messages from the front of the queue.
 
         When a message is retrieved from the queue, the response includes the message
@@ -618,8 +629,13 @@ def receive_messages(self, **kwargs):
             process_storage_error(error)
 
     @distributed_trace
-    def update_message(self, message, pop_receipt=None, content=None, **kwargs):
-        # type: (Any, Optional[str], Optional[Any], Any) -> QueueMessage
+    def update_message(self,
+                       message,  # type: Any
+                       pop_receipt=None,  # type: Optional[str]
+                       content=None,  # type: Optional[Any]
+                       **kwargs  # type: Any
+                       ):
+        # type: (...) -> QueueMessage
         """Updates the visibility timeout of a message. You can also use this
         operation to update the contents of a message.
 
@@ -715,8 +731,11 @@ def update_message(self, message, pop_receipt=None, content=None, **kwargs):
             process_storage_error(error)
 
     @distributed_trace
-    def peek_messages(self, max_messages=None, **kwargs):
-        # type: (Optional[int], Optional[Any]) -> List[QueueMessage]
+    def peek_messages(self,
+                      max_messages=None,  # type: Optional[int]
+                      **kwargs  # type: Any
+                      ):
+        # type: (...) -> List[QueueMessage]
         """Retrieves one or more messages from the front of the queue, but does
         not alter the visibility of the message.
 
@@ -774,7 +793,7 @@ def peek_messages(self, max_messages=None, **kwargs):
 
     @distributed_trace
     def clear_messages(self, **kwargs):
-        # type: (Optional[Any]) -> None
+        # type: (Any) -> None
         """Deletes all messages from the specified queue.
 
         :keyword int timeout:
@@ -796,8 +815,12 @@ def clear_messages(self, **kwargs):
             process_storage_error(error)
 
     @distributed_trace
-    def delete_message(self, message, pop_receipt=None, **kwargs):
-        # type: (Any, Optional[str], Any) -> None
+    def delete_message(self,
+                       message,  # type: Any
+                       pop_receipt=None,  # type: Optional[str]
+                       **kwargs  # type: Any
+                       ):
+        # type: (...) -> None
         """Deletes the specified message.
 
         Normally after a client retrieves a message with the receive messages operation,
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py
@@ -153,7 +153,7 @@ def from_connection_string(
 
     @distributed_trace
     def get_service_stats(self, **kwargs):
-        # type: (Optional[Any]) -> Dict[str, Any]
+        # type: (Any) -> Dict[str, Any]
         """Retrieves statistics related to replication for the Queue service.
 
         It is only available when read-access geo-redundant replication is enabled for
@@ -187,7 +187,7 @@ def get_service_stats(self, **kwargs):
 
     @distributed_trace
     def get_service_properties(self, **kwargs):
-        # type: (Optional[Any]) -> Dict[str, Any]
+        # type: (Any) -> Dict[str, Any]
         """Gets the properties of a storage account's Queue service, including
         Azure Storage Analytics.
 
@@ -219,7 +219,7 @@ def set_service_properties( # type: ignore
             hour_metrics=None,  # type: Optional[Metrics]
             minute_metrics=None,  # type: Optional[Metrics]
             cors=None,  # type: Optional[List[CorsRule]]
-            **kwargs
+            **kwargs  # type: Any
         ):
         # type: (...) -> None
         """Sets the properties of a storage account's Queue service, including
@@ -273,7 +273,7 @@ def set_service_properties( # type: ignore
     def list_queues(
             self, name_starts_with=None,  # type: Optional[str]
             include_metadata=False,  # type: Optional[bool]
-            **kwargs
+            **kwargs  # type: Any
         ):
         # type: (...) -> ItemPaged[QueueProperties]
         """Returns a generator to list the queues under the specified account.
@@ -323,7 +323,7 @@ def list_queues(
     def create_queue(
             self, name,  # type: str
             metadata=None,  # type: Optional[Dict[str, str]]
-            **kwargs
+            **kwargs  # type: Any
         ):
         # type: (...) -> QueueClient
         """Creates a new queue under the specified account.
@@ -358,8 +358,9 @@ def create_queue(
 
     @distributed_trace
     def delete_queue(
-            self, queue,  # type: Union[QueueProperties, str]
-            **kwargs
+            self,
+            queue,  # type: Union[QueueProperties, str]
+            **kwargs  # type: Any
         ):
         # type: (...) -> None
         """Deletes the specified queue and any messages it contains.
@@ -394,8 +395,11 @@ def delete_queue(
         kwargs.setdefault('merge_span', True)
         queue_client.delete_queue(timeout=timeout, **kwargs)
 
-    def get_queue_client(self, queue, **kwargs):
-        # type: (Union[QueueProperties, str], Optional[Any]) -> QueueClient
+    def get_queue_client(self,
+                         queue,  # type: Union[QueueProperties, str]
+                         **kwargs  # type: Any
+                         ):
+        # type: (...) -> QueueClient
         """Get a client to interact with the specified queue.
 
         The queue need not already exist.
diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_serialize.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_serialize.py
@@ -3,6 +3,7 @@
 # Licensed under the MIT License. See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
+from typing import (Any, Dict)
 
 _SUPPORTED_API_VERSIONS = [
     '2019-02-02',
@@ -18,7 +19,7 @@
 
 
 def get_api_version(kwargs):
-    # type: (Dict[str, Any], str) -> str
+    # type: (Dict[str, Any]) -> str
     api_version = kwargs.get('api_version', None)
     if api_version and api_version not in _SUPPORTED_API_VERSIONS:
         versions = '\n'.join(_SUPPORTED_API_VERSIONS)
