Merge pull request #835 from tseaver/818-unify_rfc_3339_format

#818: unify RFC 3339 timestamp format strubg

Author: tseaver

gcloud/_helpers.py

@@ -31,6 +31,8 @@ class Local(object):
 except ImportError:
     app_identity = None
 
+_RFC3339_MICROS = '%Y-%m-%dT%H:%M:%S.%fZ'
+
 
 class _LocalStack(Local):
     """Manage a thread-local LIFO stack of resources.

gcloud/pubsub/message.py

@@ -19,7 +19,7 @@
 
 import pytz
 
-_RFC3339_MICROS = '%Y-%m-%dT%H:%M:%S.%fZ'
+from gcloud._helpers import _RFC3339_MICROS
 
 
 class Message(object):

gcloud/pubsub/test_message.py

@@ -92,7 +92,7 @@ def _to_fail():
     def test_timestamp_w_timestamp_in_attributes(self):
         from datetime import datetime
         from pytz import utc
-        from gcloud.pubsub.message import _RFC3339_MICROS
+        from gcloud._helpers import _RFC3339_MICROS
         DATA = b'DEADBEEF'
         MESSAGE_ID = b'12345'
         TIMESTAMP = '2015-04-10T18:42:27.131956Z'

gcloud/pubsub/test_topic.py

@@ -155,6 +155,7 @@ def test_publish_single_bytes_wo_attrs_w_add_timestamp(self):
         import base64
         import datetime
         from gcloud.pubsub import topic as MUT
+        from gcloud._helpers import _RFC3339_MICROS
         from gcloud._testing import _Monkey
         NOW = datetime.datetime.utcnow()
 
@@ -167,7 +168,7 @@ def _utcnow():
         B64 = base64.b64encode(PAYLOAD).decode('ascii')
         MSGID = 'DEADBEEF'
         MESSAGE = {'data': B64,
-                   'attributes': {'timestamp': '%sZ' % NOW.isoformat()}}
+                   'attributes': {'timestamp': NOW.strftime(_RFC3339_MICROS)}}
         PATH = 'projects/%s/topics/%s' % (PROJECT, TOPIC_NAME)
         conn = _Connection({'messageIds': [MSGID]})
         topic = self._makeOne(TOPIC_NAME, project=PROJECT, connection=conn,
@@ -183,13 +184,6 @@ def _utcnow():
 
     def test_publish_single_bytes_w_add_timestamp_w_ts_in_attrs(self):
         import base64
-        import datetime
-        from gcloud.pubsub import topic as MUT
-        from gcloud._testing import _Monkey
-        NOW = datetime.datetime.utcnow()
-
-        def _utcnow():  # pragma: NO COVER
-            return NOW
 
         TOPIC_NAME = 'topic_name'
         PROJECT = 'PROJECT'
@@ -203,8 +197,7 @@ def _utcnow():  # pragma: NO COVER
         conn = _Connection({'messageIds': [MSGID]})
         topic = self._makeOne(TOPIC_NAME, project=PROJECT, connection=conn,
                               timestamp_messages=True)
-        with _Monkey(MUT, _NOW=_utcnow):
-            msgid = topic.publish(PAYLOAD, timestamp=OVERRIDE)
+        msgid = topic.publish(PAYLOAD, timestamp=OVERRIDE)
         self.assertEqual(msgid, MSGID)
         self.assertEqual(len(conn._requested), 1)
         req = conn._requested[0]

gcloud/pubsub/topic.py

@@ -18,6 +18,7 @@
 import datetime
 
 from gcloud._helpers import get_default_project
+from gcloud._helpers import _RFC3339_MICROS
 from gcloud.exceptions import NotFound
 from gcloud.pubsub._implicit_environ import get_default_connection
 
@@ -123,7 +124,7 @@ def publish(self, message, **attrs):
         :returns: message ID assigned by the server to the published message
         """
         if self.timestamp_messages and 'timestamp' not in attrs:
-            attrs['timestamp'] = '%sZ' % _NOW().isoformat()
+            attrs['timestamp'] = _NOW().strftime(_RFC3339_MICROS)
         message_b = base64.b64encode(message).decode('ascii')
         message_data = {'data': message_b, 'attributes': attrs}
         data = {'messages': [message_data]}

gcloud/storage/blob.py

@@ -22,6 +22,7 @@
 import os
 import time
 
+import pytz
 import six
 from six.moves.urllib.parse import quote  # pylint: disable=F0401
 
@@ -35,10 +36,10 @@
 from gcloud.storage._helpers import _scalar_property
 from gcloud.storage import _implicit_environ
 from gcloud.storage.acl import ObjectACL
+from gcloud._helpers import _RFC3339_MICROS
 
 
 _API_ACCESS_ENDPOINT = 'https://storage.googleapis.com'
-_GOOGLE_TIMESTAMP_FORMAT = '%Y-%m-%dT%H:%M:%S.%fZ'
 
 
 class Blob(_PropertyMixin):
@@ -749,7 +750,8 @@ def time_deleted(self):
         """
         value = self._properties.get('timeDeleted')
         if value is not None:
-            return datetime.datetime.strptime(value, _GOOGLE_TIMESTAMP_FORMAT)
+            naive = datetime.datetime.strptime(value, _RFC3339_MICROS)
+            return naive.replace(tzinfo=pytz.utc)
 
     @property
     def updated(self):
@@ -763,7 +765,8 @@ def updated(self):
         """
         value = self._properties.get('updated')
         if value is not None:
-            return datetime.datetime.strptime(value, _GOOGLE_TIMESTAMP_FORMAT)
+            naive = datetime.datetime.strptime(value, _RFC3339_MICROS)
+            return naive.replace(tzinfo=pytz.utc)
 
 
 class _UploadConfig(object):

gcloud/storage/bucket.py

@@ -36,6 +36,8 @@
 import datetime
 import copy
 import os
+
+import pytz
 import six
 
 from gcloud._helpers import get_default_project
@@ -46,7 +48,7 @@
 from gcloud.storage.acl import DefaultObjectACL
 from gcloud.storage.iterator import Iterator
 from gcloud.storage.blob import Blob
-from gcloud.storage.blob import _GOOGLE_TIMESTAMP_FORMAT
+from gcloud._helpers import _RFC3339_MICROS
 
 
 class _BlobIterator(Iterator):
@@ -693,7 +695,8 @@ def time_created(self):
         """
         value = self._properties.get('timeCreated')
         if value is not None:
-            return datetime.datetime.strptime(value, _GOOGLE_TIMESTAMP_FORMAT)
+            naive = datetime.datetime.strptime(value, _RFC3339_MICROS)
+            return naive.replace(tzinfo=pytz.utc)
 
     @property
     def versioning_enabled(self):

gcloud/storage/test_blob.py

@@ -1016,11 +1016,13 @@ def test_storage_class(self):
 
     def test_time_deleted(self):
         import datetime
+        from pytz import utc
+        from gcloud._helpers import _RFC3339_MICROS
         BLOB_NAME = 'blob-name'
         connection = _Connection()
         bucket = _Bucket(connection)
-        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37)
-        TIME_DELETED = TIMESTAMP.isoformat() + '.000Z'
+        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37, tzinfo=utc)
+        TIME_DELETED = TIMESTAMP.strftime(_RFC3339_MICROS)
         properties = {'timeDeleted': TIME_DELETED}
         blob = self._makeOne(BLOB_NAME, bucket=bucket, properties=properties)
         self.assertEqual(blob.time_deleted, TIMESTAMP)
@@ -1032,11 +1034,13 @@ def test_time_deleted_unset(self):
 
     def test_updated(self):
         import datetime
+        from pytz import utc
+        from gcloud._helpers import _RFC3339_MICROS
         BLOB_NAME = 'blob-name'
         connection = _Connection()
         bucket = _Bucket(connection)
-        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37)
-        UPDATED = TIMESTAMP.isoformat() + '.000Z'
+        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37, tzinfo=utc)
+        UPDATED = TIMESTAMP.strftime(_RFC3339_MICROS)
         properties = {'updated': UPDATED}
         blob = self._makeOne(BLOB_NAME, bucket=bucket, properties=properties)
         self.assertEqual(blob.updated, TIMESTAMP)

gcloud/storage/test_bucket.py

@@ -790,8 +790,10 @@ def test_storage_class(self):
 
     def test_time_created(self):
         import datetime
-        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37)
-        TIME_CREATED = TIMESTAMP.isoformat() + '.000Z'
+        from pytz import utc
+        from gcloud._helpers import _RFC3339_MICROS
+        TIMESTAMP = datetime.datetime(2014, 11, 5, 20, 34, 37, tzinfo=utc)
+        TIME_CREATED = TIMESTAMP.strftime(_RFC3339_MICROS)
         properties = {'timeCreated': TIME_CREATED}
         bucket = self._makeOne(properties=properties)
         self.assertEqual(bucket.time_created, TIMESTAMP)