Merge pull request #109 from GetStream/add-timezone

Set timezone as utc in serialization hooks

Author: pterk

setup.py

@@ -16,7 +16,7 @@
 if sys.version_info < (2, 7, 9):
     requests = "requests[security]>=2.4.1,<3"
 
-install_requires = ["pycryptodomex>=3.4.7,<4", requests, "six>=1.8.0"]
+install_requires = ["pycryptodomex>=3.4.7,<4", requests, "six>=1.8.0", "pytz>=2019.3"]
 
 if sys.version_info < (2, 7, 0):
     install_requires.append("pyOpenSSL<18.0.0")

stream/serializer.py

@@ -1,6 +1,7 @@
 import datetime
 import json
 import six
+import pytz
 
 """
 Adds the ability to send date and datetime objects to the API
@@ -13,7 +14,9 @@
 
 def _datetime_encoder(obj):
     if isinstance(obj, datetime.datetime):
-        return datetime.datetime.strftime(obj, DATETIME_FORMAT)
+        if obj.utcoffset() is None:  # support for <= 3.3
+            obj = pytz.utc.localize(obj)
+        return datetime.datetime.strftime(obj.astimezone(pytz.utc), DATETIME_FORMAT)
     if isinstance(obj, datetime.date):
         return datetime.datetime.strftime(obj, DATE_FORMAT)
 
@@ -31,13 +34,17 @@ def _datetime_decoder(dict_):
             try:
                 # The api always returns times like this
                 # 2014-07-25T09:12:24.735
-                datetime_obj = datetime.datetime.strptime(value, DATETIME_FORMAT)
+                datetime_obj = pytz.utc.localize(
+                    datetime.datetime.strptime(value, DATETIME_FORMAT)
+                )
                 dict_[key] = datetime_obj
             except (ValueError, TypeError):
                 try:
                     # The api always returns times like this
                     # 2014-07-25T09:12:24.735
-                    datetime_obj = datetime.datetime.strptime(value, DATE_FORMAT)
+                    datetime_obj = pytz.utc.localize(
+                        datetime.datetime.strptime(value, DATE_FORMAT)
+                    )
                     dict_[key] = datetime_obj.date()
                 except (ValueError, TypeError):
                     continue

stream/tests/test_client.py

@@ -4,6 +4,7 @@
 from stream.exceptions import ApiKeyException, InputException
 import random
 import jwt
+import pytz
 
 try:
     from unittest.case import TestCase
@@ -831,7 +832,7 @@ def test_uniqueness(self):
         b.) The same time and foreign id
         """
 
-        utcnow = datetime.datetime.utcnow()
+        utcnow = datetime.datetime.now(tz=pytz.utc)
         activity_data = {"actor": 1, "verb": "tweet", "object": 1, "time": utcnow}
         self.user1.add_activity(activity_data)
         self.user1.add_activity(activity_data)
@@ -869,7 +870,7 @@ def test_uniqueness_topic(self):
 
     def test_uniqueness_foreign_id(self):
         now = datetime.datetime.now(tzlocal())
-        utcnow = (now - now.utcoffset()).replace(tzinfo=None)
+        utcnow = now.astimezone(pytz.utc)
 
         activity_data = {
             "actor": 1,
@@ -900,15 +901,15 @@ def test_uniqueness_foreign_id(self):
 
     def test_time_ordering(self):
         """
-        datetime.datetime.utcnow() is our recommended approach
+        datetime.datetime.now(tz=pytz.utc) is our recommended approach
         so if we add an activity
         add one using time
         add another activity it should be in the right spot
         """
 
         # timedelta is used to "make sure" that ordering is known even though
         # server time is not
-        custom_time = datetime.datetime.utcnow() - dt.timedelta(days=1)
+        custom_time = datetime.datetime.now(tz=pytz.utc) - dt.timedelta(days=1)
 
         feed = self.user2
         for index, activity_time in enumerate([None, custom_time, None]):
@@ -952,8 +953,8 @@ def test_wrong_feed_spec(self):
 
     def test_serialization(self):
         today = datetime.date.today()
-        then = datetime.datetime.now().replace(microsecond=0)
-        now = datetime.datetime.now()
+        now = datetime.datetime.now(tz=pytz.utc)
+        then = now.replace(microsecond=0)
         data = dict(
             string="string",
             float=0.1,