Add unit test for datetimes.

Author: theengineear

plotly/tests/test_optional/test_utils/test_utils.py

@@ -5,6 +5,7 @@
 from unittest import TestCase
 
 import math
+import pytz
 from datetime import datetime as dt
 import datetime
 import numpy as np
@@ -88,6 +89,39 @@ def test_encode_as_numpy(self):
         res = utils.PlotlyJSONEncoder.encode_as_numpy(np.ma.core.masked)
         self.assertTrue(math.isnan(res))
 
+    def test_encode_as_datetime(self):
+
+        # should *fail* without 'utcoffset' and 'isoformat' and '__sub__' attrs
+        non_datetimes = [datetime.date(2013, 10, 1), 'noon', 56, '00:00:00']
+        for obj in non_datetimes:
+            self.assertRaises(utils.NotEncodable,
+                              utils.PlotlyJSONEncoder.encode_as_datetime, obj)
+
+        # should succeed with 'utcoffset', 'isoformat' and '__sub__' attrs
+        res = utils.PlotlyJSONEncoder.encode_as_datetime(
+            datetime.datetime(2013, 10, 1)
+        )
+        self.assertEqual(res, '2013-10-01')
+
+        # should not include extraneous microsecond info if DNE
+        res = utils.PlotlyJSONEncoder.encode_as_datetime(
+            datetime.datetime(2013, 10, 1, microsecond=0)
+        )
+        self.assertEqual(res, '2013-10-01')
+
+        # should include microsecond info if present
+        res = utils.PlotlyJSONEncoder.encode_as_datetime(
+            datetime.datetime(2013, 10, 1, microsecond=10)
+        )
+        self.assertEqual(res, '2013-10-01 00:00:00.000010')
+
+        # should convert tzinfo to utc. Note that in october, we're in EDT!
+        # therefore the 4 hour difference is correct.
+        naive_datetime = datetime.datetime(2013, 10, 1)
+        aware_datetime = pytz.timezone('US/Eastern').localize(naive_datetime)
+
+        res = utils.PlotlyJSONEncoder.encode_as_datetime(aware_datetime)
+        self.assertEqual(res, '2013-10-01 04:00:00')
 
 ## JSON encoding
 numeric_list = [1, 2, 3]