Rename QueueMessage.next_visible_time to time_next_visible

This is to synchronize with the nomenclature in Azure Python SDK

Issue #92.

Author: elprans

azure/functions/_abc.py

@@ -172,7 +172,7 @@ def insertion_time(self) -> typing.Optional[datetime.datetime]:
 
     @property
     @abc.abstractmethod
-    def next_visible_time(self) -> typing.Optional[datetime.datetime]:
+    def time_next_visible(self) -> typing.Optional[datetime.datetime]:
         pass
 
     @property

azure/functions/_queue.py

@@ -50,7 +50,7 @@ def insertion_time(self) -> typing.Optional[datetime.datetime]:
         return None
 
     @property
-    def next_visible_time(self) -> typing.Optional[datetime.datetime]:
+    def time_next_visible(self) -> typing.Optional[datetime.datetime]:
         """A datetime object with the time the message will be visible next."""
         return None
 

azure/worker/bindings/queue.py

@@ -17,13 +17,13 @@ def __init__(self, *,
                  dequeue_count=None,
                  expiration_time=None,
                  insertion_time=None,
-                 next_visible_time=None,
+                 time_next_visible=None,
                  pop_receipt=None):
         super().__init__(id=id, body=body, pop_receipt=pop_receipt)
         self.__dequeue_count = dequeue_count
         self.__expiration_time = expiration_time
         self.__insertion_time = insertion_time
-        self.__next_visible_time = next_visible_time
+        self.__time_next_visible = time_next_visible
 
     @property
     def dequeue_count(self):
@@ -38,8 +38,8 @@ def insertion_time(self):
         return self.__insertion_time
 
     @property
-    def next_visible_time(self):
-        return self.__next_visible_time
+    def time_next_visible(self):
+        return self.__time_next_visible
 
     def __repr__(self) -> str:
         return (
@@ -88,7 +88,7 @@ def from_proto(cls, data: protos.TypedData, *,
                 trigger_metadata, 'ExpirationTime'),
             insertion_time=cls._parse_datetime_metadata(
                 trigger_metadata, 'InsertionTime'),
-            next_visible_time=cls._parse_datetime_metadata(
+            time_next_visible=cls._parse_datetime_metadata(
                 trigger_metadata, 'NextVisibleTime'),
             pop_receipt=cls._decode_trigger_metadata_field(
                 trigger_metadata, 'PopReceipt', python_type=str)

tests/queue_functions/queue_trigger/main.py

@@ -11,8 +11,8 @@ def main(msg: azf.QueueMessage) -> str:
                             if msg.expiration_time else None),
         'insertion_time': (msg.insertion_time.isoformat()
                            if msg.insertion_time else None),
-        'next_visible_time': (msg.next_visible_time.isoformat()
-                              if msg.next_visible_time else None),
+        'time_next_visible': (msg.time_next_visible.isoformat()
+                              if msg.time_next_visible else None),
         'pop_receipt': msg.pop_receipt,
         'dequeue_count': msg.dequeue_count
     })

tests/test_queue_functions.py

@@ -27,7 +27,7 @@ def test_queue_basic(self):
 
         self.assertEqual(msg['body'], 'test-message')
         for attr in {'id', 'expiration_time', 'insertion_time',
-                     'next_visible_time', 'pop_receipt', 'dequeue_count'}:
+                     'time_next_visible', 'pop_receipt', 'dequeue_count'}:
             self.assertIsNotNone(msg.get(attr))
 
     def test_queue_return(self):