From c75568b6189ff679c16a745aaedadc83ab2d9356 Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Tue, 15 Oct 2019 09:14:55 -0700 Subject: [PATCH 1/2] rename queue messages --- .../storage/queue/aio/queue_client_async.py | 22 +++---- .../azure/storage/queue/models.py | 18 ++--- .../azure/storage/queue/queue_client.py | 22 +++---- .../azure-storage-queue/tests/test_queue.py | 66 +++++++++---------- .../tests/test_queue_async.py | 66 +++++++++---------- 5 files changed, 97 insertions(+), 97 deletions(-) diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/queue_client_async.py b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/queue_client_async.py index b8cf779f01ac..ea8193259578 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/aio/queue_client_async.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/aio/queue_client_async.py @@ -388,10 +388,10 @@ async def enqueue_message( # type: ignore ) queue_message = QueueMessage(content=new_message.message_text) queue_message.id = enqueued[0].message_id - queue_message.insertion_time = enqueued[0].insertion_time - queue_message.expiration_time = enqueued[0].expiration_time + queue_message.inserted_on = enqueued[0].insertion_time + queue_message.expires_on = enqueued[0].expiration_time queue_message.pop_receipt = enqueued[0].pop_receipt - queue_message.time_next_visible = enqueued[0].time_next_visible + queue_message.next_visible_on = enqueued[0].time_next_visible return queue_message except StorageErrorException as error: process_storage_error(error) @@ -514,15 +514,15 @@ async def update_message( message_id = message.id message_text = content or message.content receipt = pop_receipt or message.pop_receipt - insertion_time = message.insertion_time - expiration_time = message.expiration_time + inserted_on = message.inserted_on + expires_on = message.expires_on dequeue_count = message.dequeue_count except AttributeError: message_id = message message_text = content receipt = pop_receipt - insertion_time = None - expiration_time = None + inserted_on = None + expires_on = None dequeue_count = None if receipt is None: @@ -547,11 +547,11 @@ async def update_message( ) new_message = QueueMessage(content=message_text) new_message.id = message_id - new_message.insertion_time = insertion_time - new_message.expiration_time = expiration_time + new_message.inserted_on = inserted_on + new_message.expires_on = expires_on new_message.dequeue_count = dequeue_count new_message.pop_receipt = response["popreceipt"] - new_message.time_next_visible = response["time_next_visible"] + new_message.next_visible_on = response["time_next_visible"] return new_message except StorageErrorException as error: process_storage_error(error) @@ -581,7 +581,7 @@ async def peek_messages(self, max_messages=None, timeout=None, **kwargs): # typ The server timeout, expressed in seconds. :return: A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that - time_next_visible and pop_receipt will not be populated as peek does + next_visible_on and pop_receipt will not be populated as peek does not pop the message and can only retrieve already visible messages. :rtype: list(:class:`~azure.storage.queue.QueueMessage`) diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/models.py b/sdk/storage/azure-storage-queue/azure/storage/queue/models.py index 5173b5dcc1e8..87a3992de8c8 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/models.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/models.py @@ -176,9 +176,9 @@ class QueueMessage(DictMixin): identifies the message in the queue. This value may be used together with the value of pop_receipt to delete a message from the queue after it has been retrieved with the receive messages operation. - :ivar date insertion_time: + :ivar date inserted_on: A UTC date value representing the time the messages was inserted. - :ivar date expiration_time: + :ivar date expires_on: A UTC date value representing the time the message expires. :ivar int dequeue_count: Begins with a value of 1 the first time the message is received. This @@ -191,30 +191,30 @@ class QueueMessage(DictMixin): delete a message from the queue after it has been retrieved with the receive messages operation. Only returned by receive messages operations. Set to None for peek messages. - :ivar date time_next_visible: + :ivar date next_visible_on: A UTC date value representing the time the message will next be visible. Only returned by receive messages operations. Set to None for peek messages. """ def __init__(self, content=None): self.id = None - self.insertion_time = None - self.expiration_time = None + self.inserted_on = None + self.expires_on = None self.dequeue_count = None self.content = content self.pop_receipt = None - self.time_next_visible = None + self.next_visible_on = None @classmethod def _from_generated(cls, generated): message = cls(content=generated.message_text) message.id = generated.message_id - message.insertion_time = generated.insertion_time - message.expiration_time = generated.expiration_time + message.inserted_on = generated.insertion_time + message.expires_on = generated.expiration_time message.dequeue_count = generated.dequeue_count if hasattr(generated, 'pop_receipt'): message.pop_receipt = generated.pop_receipt - message.time_next_visible = generated.time_next_visible + message.next_visible_on = generated.time_next_visible return message 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 index d71f729c2482..ce03b07f85ac 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/queue_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/queue_client.py @@ -513,10 +513,10 @@ def enqueue_message( # type: ignore **kwargs) queue_message = QueueMessage(content=new_message.message_text) queue_message.id = enqueued[0].message_id - queue_message.insertion_time = enqueued[0].insertion_time - queue_message.expiration_time = enqueued[0].expiration_time + queue_message.inserted_on = enqueued[0].insertion_time + queue_message.expires_on = enqueued[0].expiration_time queue_message.pop_receipt = enqueued[0].pop_receipt - queue_message.time_next_visible = enqueued[0].time_next_visible + queue_message.next_visible_on = enqueued[0].time_next_visible return queue_message except StorageErrorException as error: process_storage_error(error) @@ -631,15 +631,15 @@ def update_message(self, message, visibility_timeout=None, pop_receipt=None, # t message_id = message.id message_text = content or message.content receipt = pop_receipt or message.pop_receipt - insertion_time = message.insertion_time - expiration_time = message.expiration_time + inserted_on = message.inserted_on + expires_on = message.expires_on dequeue_count = message.dequeue_count except AttributeError: message_id = message message_text = content receipt = pop_receipt - insertion_time = None - expiration_time = None + inserted_on = None + expires_on = None dequeue_count = None if receipt is None: @@ -664,11 +664,11 @@ def update_message(self, message, visibility_timeout=None, pop_receipt=None, # t **kwargs) new_message = QueueMessage(content=message_text) new_message.id = message_id - new_message.insertion_time = insertion_time - new_message.expiration_time = expiration_time + new_message.inserted_on = inserted_on + new_message.expires_on = expires_on new_message.dequeue_count = dequeue_count new_message.pop_receipt = response['popreceipt'] - new_message.time_next_visible = response['time_next_visible'] + new_message.next_visible_on = response['time_next_visible'] return new_message except StorageErrorException as error: process_storage_error(error) @@ -698,7 +698,7 @@ def peek_messages(self, max_messages=None, timeout=None, **kwargs): # type: igno The server timeout, expressed in seconds. :return: A list of :class:`~azure.storage.queue.QueueMessage` objects. Note that - time_next_visible and pop_receipt will not be populated as peek does + next_visible_on and pop_receipt will not be populated as peek does not pop the message and can only retrieve already visible messages. :rtype: list(:class:`~azure.storage.queue.QueueMessage`) diff --git a/sdk/storage/azure-storage-queue/tests/test_queue.py b/sdk/storage/azure-storage-queue/tests/test_queue.py index c1a1e40b15e0..f7a03392df77 100644 --- a/sdk/storage/azure-storage-queue/tests/test_queue.py +++ b/sdk/storage/azure-storage-queue/tests/test_queue.py @@ -275,8 +275,8 @@ def test_put_message(self, resource_group, location, storage_account, storage_ac # Asserts self.assertIsNotNone(message) self.assertNotEqual('', message.id) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) self.assertNotEqual('', message.pop_receipt) self.assertEqual(u'message4', message.content) @@ -295,8 +295,8 @@ def test_put_message_large_time_to_live(self, resource_group, location, storage_ # Assert self.assertGreaterEqual( - messages[0].expiration_time, - messages[0].insertion_time + timedelta(seconds=1024 * 1024 * 1024 - 3600)) + messages[0].expires_on, + messages[0].inserted_on + timedelta(seconds=1024 * 1024 * 1024 - 3600)) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -311,7 +311,7 @@ def test_put_message_infinite_time_to_live(self, resource_group, location, stora messages = queue_client.peek_messages() # Assert - self.assertEqual(messages[0].expiration_time.year, date.max.year) + self.assertEqual(messages[0].expires_on.year, date.max.year) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -334,9 +334,9 @@ def test_get_messages(self, resource_group, location, storage_account, storage_a self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -362,9 +362,9 @@ def test_get_messages_with_options(self, resource_group, location, storage_accou self.assertNotEqual('', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertNotEqual('', message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertNotEqual('', message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -388,9 +388,9 @@ def test_peek_messages(self, resource_group, location, storage_account, storage_ self.assertNotEqual('', message.content) self.assertIsNone(message.pop_receipt) self.assertEqual(0, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertIsNone(message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertIsNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -414,9 +414,9 @@ def test_peek_messages_with_options(self, resource_group, location, storage_acco self.assertNotEqual('', message.content) self.assertIsNone(message.pop_receipt) self.assertEqual(0, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertIsNone(message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertIsNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -477,8 +477,8 @@ def test_update_message(self, resource_group, location, storage_account, storage # Update response self.assertIsNotNone(message) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.time_next_visible) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsNotNone(message.next_visible_on) + self.assertIsInstance(message.next_visible_on, datetime) # Get response self.assertIsNotNone(list_result2) @@ -488,9 +488,9 @@ def test_update_message(self, resource_group, location, storage_account, storage self.assertEqual(u'message1', message.content) self.assertEqual(2, message.dequeue_count) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.insertion_time) - self.assertIsNotNone(message.expiration_time) - self.assertIsNotNone(message.time_next_visible) + self.assertIsNotNone(message.inserted_on) + self.assertIsNotNone(message.expires_on) + self.assertIsNotNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -514,8 +514,8 @@ def test_update_message_content(self, resource_group, location, storage_account, # Update response self.assertIsNotNone(message) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.time_next_visible) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsNotNone(message.next_visible_on) + self.assertIsInstance(message.next_visible_on, datetime) # Get response self.assertIsNotNone(list_result2) @@ -525,9 +525,9 @@ def test_update_message_content(self, resource_group, location, storage_account, self.assertEqual(u'new text', message.content) self.assertEqual(2, message.dequeue_count) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.insertion_time) - self.assertIsNotNone(message.expiration_time) - self.assertIsNotNone(message.time_next_visible) + self.assertIsNotNone(message.inserted_on) + self.assertIsNotNone(message.expires_on) + self.assertIsNotNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -933,9 +933,9 @@ def test_unicode_get_messages_unicode_data(self, resource_group, location, stora self.assertEqual(u'message1㚈', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -959,9 +959,9 @@ def test_unicode_update_message_unicode_data(self, resource_group, location, sto self.assertEqual(u'啊齄丂狛狜', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(2, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) # ------------------------------------------------------------------------------ diff --git a/sdk/storage/azure-storage-queue/tests/test_queue_async.py b/sdk/storage/azure-storage-queue/tests/test_queue_async.py index a287e3dd9a91..21f523c825bc 100644 --- a/sdk/storage/azure-storage-queue/tests/test_queue_async.py +++ b/sdk/storage/azure-storage-queue/tests/test_queue_async.py @@ -301,8 +301,8 @@ async def test_put_message(self, resource_group, location, storage_account, stor # Asserts self.assertIsNotNone(message) self.assertNotEqual('', message.id) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) self.assertNotEqual('', message.pop_receipt) self.assertEqual(u'message4', message.content) @@ -321,8 +321,8 @@ async def test_put_message_large_time_to_live(self, resource_group, location, st # Assert self.assertGreaterEqual( - messages[0].expiration_time, - messages[0].insertion_time + timedelta(seconds=1024 * 1024 * 1024 - 3600)) + messages[0].expires_on, + messages[0].inserted_on + timedelta(seconds=1024 * 1024 * 1024 - 3600)) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -337,7 +337,7 @@ async def test_put_message_infinite_time_to_live(self, resource_group, location, messages = await queue_client.peek_messages() # Assert - self.assertEqual(messages[0].expiration_time.year, date.max.year) + self.assertEqual(messages[0].expires_on.year, date.max.year) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -364,9 +364,9 @@ async def test_get_messages(self, resource_group, location, storage_account, sto self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -394,9 +394,9 @@ async def test_get_messages_with_options(self, resource_group, location, storage self.assertNotEqual('', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertNotEqual('', message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertNotEqual('', message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -420,9 +420,9 @@ async def test_peek_messages(self, resource_group, location, storage_account, st self.assertNotEqual('', message.content) self.assertIsNone(message.pop_receipt) self.assertEqual(0, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertIsNone(message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertIsNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -446,9 +446,9 @@ async def test_peek_messages_with_options(self, resource_group, location, storag self.assertNotEqual('', message.content) self.assertIsNone(message.pop_receipt) self.assertEqual(0, message.dequeue_count) - self.assertNotEqual('', message.insertion_time) - self.assertNotEqual('', message.expiration_time) - self.assertIsNone(message.time_next_visible) + self.assertNotEqual('', message.inserted_on) + self.assertNotEqual('', message.expires_on) + self.assertIsNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -514,8 +514,8 @@ async def test_update_message(self, resource_group, location, storage_account, s # Update response self.assertIsNotNone(message) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.time_next_visible) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsNotNone(message.next_visible_on) + self.assertIsInstance(message.next_visible_on, datetime) # Get response self.assertIsNotNone(list_result2) @@ -525,9 +525,9 @@ async def test_update_message(self, resource_group, location, storage_account, s self.assertEqual(u'message1', message.content) self.assertEqual(2, message.dequeue_count) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.insertion_time) - self.assertIsNotNone(message.expiration_time) - self.assertIsNotNone(message.time_next_visible) + self.assertIsNotNone(message.inserted_on) + self.assertIsNotNone(message.expires_on) + self.assertIsNotNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -556,8 +556,8 @@ async def test_update_message_content(self, resource_group, location, storage_ac # Update response self.assertIsNotNone(message) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.time_next_visible) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsNotNone(message.next_visible_on) + self.assertIsInstance(message.next_visible_on, datetime) # Get response self.assertIsNotNone(list_result2) @@ -567,9 +567,9 @@ async def test_update_message_content(self, resource_group, location, storage_ac self.assertEqual(u'new text', message.content) self.assertEqual(2, message.dequeue_count) self.assertIsNotNone(message.pop_receipt) - self.assertIsNotNone(message.insertion_time) - self.assertIsNotNone(message.expiration_time) - self.assertIsNotNone(message.time_next_visible) + self.assertIsNotNone(message.inserted_on) + self.assertIsNotNone(message.expires_on) + self.assertIsNotNone(message.next_visible_on) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -992,9 +992,9 @@ async def test_unicode_get_messages_unicode_data(self, resource_group, location, self.assertEqual(u'message1㚈', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(1, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) @ResourceGroupPreparer() @StorageAccountPreparer(name_prefix='pyacrstorage') @@ -1021,9 +1021,9 @@ async def test_unicode_update_message_unicode_data(self, resource_group, locatio self.assertEqual(u'啊齄丂狛狜', message.content) self.assertNotEqual('', message.pop_receipt) self.assertEqual(2, message.dequeue_count) - self.assertIsInstance(message.insertion_time, datetime) - self.assertIsInstance(message.expiration_time, datetime) - self.assertIsInstance(message.time_next_visible, datetime) + self.assertIsInstance(message.inserted_on, datetime) + self.assertIsInstance(message.expires_on, datetime) + self.assertIsInstance(message.next_visible_on, datetime) # ------------------------------------------------------------------------------ From 5ee38b735981d3bee2b9a1c9e2b5bc419c36a6d6 Mon Sep 17 00:00:00 2001 From: Krista Pratico Date: Tue, 15 Oct 2019 11:31:32 -0700 Subject: [PATCH 2/2] update history --- sdk/storage/azure-storage-queue/HISTORY.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sdk/storage/azure-storage-queue/HISTORY.md b/sdk/storage/azure-storage-queue/HISTORY.md index 9d9ead72bb17..52c0ce5168ca 100644 --- a/sdk/storage/azure-storage-queue/HISTORY.md +++ b/sdk/storage/azure-storage-queue/HISTORY.md @@ -6,6 +6,8 @@ - `set_queue_access_policy` has required parameter `signed_identifiers`. - NoRetry policy has been removed. Use keyword argument `retry_total=0` for no retries. +- `QueueMessage` has had its parameters renamed from `insertion_time`, `time_next_visible`, `expiration_time` +to `inserted_on`, `next_visible_on`, `expires_on`, respectively. **New features**