From 5f15f6386d55a7d41be7659f0e6f5ce4607bc62c Mon Sep 17 00:00:00 2001 From: Vincent Tran Date: Wed, 22 Feb 2023 16:48:52 -0800 Subject: [PATCH 1/2] qsc done sync&async --- .../storage/queue/_queue_service_client.py | 60 +++++++++---------- .../queue/aio/_queue_service_client_async.py | 58 +++++++++--------- 2 files changed, 55 insertions(+), 63 deletions(-) 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 index 6b5422756a52..8b7eca142311 100644 --- 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 @@ -35,8 +35,8 @@ from ._models import ( CorsRule, Metrics, - QueueProperties, QueueAnalyticsLogging, + QueueProperties ) @@ -111,7 +111,7 @@ def __init__( self._client._config.version = get_api_version(kwargs) # pylint: disable=protected-access self._configure_encryption(kwargs) - def _format_url(self, hostname): + def _format_url(self, hostname: str) -> str: """Format the endpoint URL according to the current location mode hostname. """ @@ -155,8 +155,7 @@ def from_connection_string( return cls(account_url, credential=credential, **kwargs) @distributed_trace - def get_service_stats(self, **kwargs): - # type: (Any) -> Dict[str, Any] + def get_service_stats(self, **kwargs: 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 @@ -189,8 +188,7 @@ def get_service_stats(self, **kwargs): process_storage_error(error) @distributed_trace - def get_service_properties(self, **kwargs): - # type: (Any) -> Dict[str, Any] + def get_service_properties(self, **kwargs: Any) -> Dict[str, Any]: """Gets the properties of a storage account's Queue service, including Azure Storage Analytics. @@ -217,14 +215,13 @@ def get_service_properties(self, **kwargs): process_storage_error(error) @distributed_trace - def set_service_properties( # type: ignore - self, analytics_logging=None, # type: Optional[QueueAnalyticsLogging] - hour_metrics=None, # type: Optional[Metrics] - minute_metrics=None, # type: Optional[Metrics] - cors=None, # type: Optional[List[CorsRule]] - **kwargs # type: Any - ): - # type: (...) -> None + def set_service_properties( + self, analytics_logging: Optional["QueueAnalyticsLogging"] = None, + hour_metrics: Optional["Metrics"] = None, + minute_metrics: Optional["Metrics"] = None, + cors: Optional[List["CorsRule"]] = None, + **kwargs: Any + ) -> None: """Sets the properties of a storage account's Queue service, including Azure Storage Analytics. @@ -274,11 +271,10 @@ def set_service_properties( # type: ignore @distributed_trace def list_queues( - self, name_starts_with=None, # type: Optional[str] - include_metadata=False, # type: Optional[bool] - **kwargs # type: Any - ): - # type: (...) -> ItemPaged[QueueProperties] + self, name_starts_with: Optional[str] = None, + include_metadata: Optional[bool] = False, + **kwargs: Any + ) -> ItemPaged["QueueProperties"]: """Returns a generator to list the queues under the specified account. The generator will lazily follow the continuation tokens returned by @@ -328,11 +324,10 @@ def list_queues( @distributed_trace def create_queue( - self, name, # type: str - metadata=None, # type: Optional[Dict[str, str]] - **kwargs # type: Any - ): - # type: (...) -> QueueClient + self, name: str, + metadata: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> QueueClient: """Creates a new queue under the specified account. If a queue with the same name already exists, the operation fails. @@ -366,10 +361,9 @@ def create_queue( @distributed_trace def delete_queue( self, - queue, # type: Union[QueueProperties, str] - **kwargs # type: Any - ): - # type: (...) -> None + queue: Union["QueueProperties", str], + **kwargs: Any + ) -> None: """Deletes the specified queue and any messages it contains. When a queue is successfully deleted, it is immediately marked for deletion @@ -402,11 +396,11 @@ def delete_queue( kwargs.setdefault('merge_span', True) queue_client.delete_queue(timeout=timeout, **kwargs) - def get_queue_client(self, - queue, # type: Union[QueueProperties, str] - **kwargs # type: Any - ): - # type: (...) -> QueueClient + def get_queue_client( + self, + queue: Union["QueueProperties", str], + **kwargs: Any + ) -> 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/aio/_queue_service_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py index 191a15f40969..e09181d89207 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py @@ -36,8 +36,8 @@ from .._models import ( CorsRule, Metrics, - QueueProperties, QueueAnalyticsLogging, + QueueProperties, ) @@ -103,8 +103,7 @@ def __init__( self._configure_encryption(kwargs) @distributed_trace_async - async def get_service_stats(self, **kwargs): - # type: (Optional[Any]) -> Dict[str, Any] + async def get_service_stats(self, **kwargs: 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 @@ -137,8 +136,7 @@ async def get_service_stats(self, **kwargs): process_storage_error(error) @distributed_trace_async - async def get_service_properties(self, **kwargs): - # type: (Optional[Any]) -> Dict[str, Any] + async def get_service_properties(self, **kwargs: Any) -> Dict[str, Any]: """Gets the properties of a storage account's Queue service, including Azure Storage Analytics. @@ -165,14 +163,13 @@ async def get_service_properties(self, **kwargs): process_storage_error(error) @distributed_trace_async - async def set_service_properties( # type: ignore - self, analytics_logging=None, # type: Optional[QueueAnalyticsLogging] - hour_metrics=None, # type: Optional[Metrics] - minute_metrics=None, # type: Optional[Metrics] - cors=None, # type: Optional[List[CorsRule]] - **kwargs - ): - # type: (...) -> None + async def set_service_properties( + self, analytics_logging: Optional["QueueAnalyticsLogging"] = None, + hour_metrics: Optional["Metrics"] = None, + minute_metrics: Optional["Metrics"] = None, + cors: Optional[List["CorsRule"]] = None, + **kwargs: Any + ) -> None: """Sets the properties of a storage account's Queue service, including Azure Storage Analytics. @@ -222,10 +219,10 @@ async def set_service_properties( # type: ignore @distributed_trace def list_queues( - self, name_starts_with=None, # type: Optional[str] - include_metadata=False, # type: Optional[bool] - **kwargs - ): # type: (...) -> AsyncItemPaged + self, name_starts_with: Optional[str] = None, + include_metadata: Optional[bool] = False, + **kwargs: Any + ) -> AsyncItemPaged: """Returns a generator to list the queues under the specified account. The generator will lazily follow the continuation tokens returned by @@ -274,12 +271,11 @@ def list_queues( ) @distributed_trace_async - async def create_queue( # type: ignore - self, name, # type: str - metadata=None, # type: Optional[Dict[str, str]] - **kwargs - ): - # type: (...) -> QueueClient + async def create_queue( + self, name: str, + metadata: Optional[Dict[str, str]] = None, + **kwargs: Any + ) -> QueueClient: """Creates a new queue under the specified account. If a queue with the same name already exists, the operation fails. @@ -311,11 +307,10 @@ async def create_queue( # type: ignore return queue @distributed_trace_async - async def delete_queue( # type: ignore - self, queue, # type: Union[QueueProperties, str] - **kwargs - ): - # type: (...) -> None + async def delete_queue( + self, queue: Union["QueueProperties", str], + **kwargs: Any + ) -> None: """Deletes the specified queue and any messages it contains. When a queue is successfully deleted, it is immediately marked for deletion @@ -348,8 +343,11 @@ async def delete_queue( # type: ignore kwargs.setdefault('merge_span', True) await 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: Union["QueueProperties", str], + **kwargs: Any + ) -> QueueClient: """Get a client to interact with the specified queue. The queue need not already exist. From 050f7e9f879dfc9c00500fd4ba8f06a9bc41971e Mon Sep 17 00:00:00 2001 From: Vincent Tran Date: Wed, 22 Feb 2023 17:18:23 -0800 Subject: [PATCH 2/2] Remove #type ignore, fix dict() --- .../azure/storage/queue/_queue_service_client.py | 8 ++++---- .../storage/queue/aio/_queue_service_client_async.py | 12 ++++++------ 2 files changed, 10 insertions(+), 10 deletions(-) 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 index 8b7eca142311..22990c6ef1b3 100644 --- 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 @@ -181,7 +181,7 @@ def get_service_stats(self, **kwargs: Any) -> Dict[str, Any]: """ timeout = kwargs.pop('timeout', None) try: - stats = self._client.service.get_statistics( # type: ignore + stats = self._client.service.get_statistics( timeout=timeout, use_location=LocationMode.SECONDARY, **kwargs) return service_stats_deserialize(stats) except HttpResponseError as error: @@ -209,7 +209,7 @@ def get_service_properties(self, **kwargs: Any) -> Dict[str, Any]: """ timeout = kwargs.pop('timeout', None) try: - service_props = self._client.service.get_properties(timeout=timeout, **kwargs) # type: ignore + service_props = self._client.service.get_properties(timeout=timeout, **kwargs) return service_properties_deserialize(service_props) except HttpResponseError as error: process_storage_error(error) @@ -265,7 +265,7 @@ def set_service_properties( cors=cors ) try: - return self._client.service.set_properties(props, timeout=timeout, **kwargs) # type: ignore + return self._client.service.set_properties(props, timeout=timeout, **kwargs) except HttpResponseError as error: process_storage_error(error) @@ -337,7 +337,7 @@ def create_queue( :param metadata: A dict with name_value pairs to associate with the queue as metadata. Example: {'Category': 'test'} - :type metadata: dict(str, str) + :type metadata: Dict[str, str] :keyword int timeout: The timeout parameter is expressed in seconds. :rtype: ~azure.storage.queue.QueueClient diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py index e09181d89207..db84771a840f 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/_queue_service_client_async.py @@ -92,12 +92,12 @@ def __init__( ) -> None: kwargs['retry_policy'] = kwargs.get('retry_policy') or ExponentialRetry(**kwargs) loop = kwargs.pop('loop', None) - super(QueueServiceClient, self).__init__( # type: ignore + super(QueueServiceClient, self).__init__( account_url, credential=credential, loop=loop, **kwargs) - self._client = AzureQueueStorage(self.url, base_url=self.url, pipeline=self._pipeline, loop=loop) # type: ignore + self._client = AzureQueueStorage(self.url, base_url=self.url, pipeline=self._pipeline, loop=loop) self._client._config.version = get_api_version(kwargs) # pylint: disable=protected-access self._loop = loop self._configure_encryption(kwargs) @@ -129,7 +129,7 @@ async def get_service_stats(self, **kwargs: Any) -> Dict[str, Any]: """ timeout = kwargs.pop('timeout', None) try: - stats = await self._client.service.get_statistics( # type: ignore + stats = await self._client.service.get_statistics( timeout=timeout, use_location=LocationMode.SECONDARY, **kwargs) return service_stats_deserialize(stats) except HttpResponseError as error: @@ -157,7 +157,7 @@ async def get_service_properties(self, **kwargs: Any) -> Dict[str, Any]: """ timeout = kwargs.pop('timeout', None) try: - service_props = await self._client.service.get_properties(timeout=timeout, **kwargs) # type: ignore + service_props = await self._client.service.get_properties(timeout=timeout, **kwargs) return service_properties_deserialize(service_props) except HttpResponseError as error: process_storage_error(error) @@ -213,7 +213,7 @@ async def set_service_properties( cors=cors ) try: - return await self._client.service.set_properties(props, timeout=timeout, **kwargs) # type: ignore + return await self._client.service.set_properties(props, timeout=timeout, **kwargs) except HttpResponseError as error: process_storage_error(error) @@ -285,7 +285,7 @@ async def create_queue( :param metadata: A dict with name_value pairs to associate with the queue as metadata. Example: {'Category': 'test'} - :type metadata: dict(str, str) + :type metadata: Dict[str, str] :keyword int timeout: The timeout parameter is expressed in seconds. :rtype: ~azure.storage.queue.aio.QueueClient