Merge pull request #164 from plotly/jsonify-masked-numbers

Masked numbers, datetime.date json encoding

Author: chriddyp

plotly/tests/test_optional/test_utils/test_utils.py

@@ -3,20 +3,26 @@
 from nose.plugins.attrib import attr
 
 from datetime import datetime as dt
+import datetime
 import numpy as np
 import json
 import pandas as pd
 from pandas.util.testing import assert_series_equal
+import matplotlib.pyplot as plt
 
 from plotly import utils
 from plotly.grid_objs import Column
 from plotly.graph_objs import Scatter, Scatter3d, Figure, Data
+from plotly.matplotlylib import Exporter, PlotlyRenderer
+from plotly.plotly import plot
 
 ## JSON encoding
 numeric_list = [1, 2, 3]
 np_list = np.array([1, 2, 3, np.NaN, np.NAN, np.Inf, dt(2014, 1, 5)])
 mixed_list = [1, 'A', dt(2014, 1, 5), dt(2014, 1, 5, 1, 1, 1),
               dt(2014, 1, 5, 1, 1, 1, 1)]
+dt_list = [dt(2014, 1, 5), dt(2014, 1, 5, 1, 1, 1),
+           dt(2014, 1, 5, 1, 1, 1, 1)]
 
 df = pd.DataFrame(columns=['col 1'],
                   data=[1, 2, 3, dt(2014, 1, 5), pd.NaT, np.NaN, np.Inf])
@@ -72,6 +78,17 @@ def test_figure_json_encoding():
                 dt(2014, 1, 5, 1, 1, 1, 1)]))
 
 
+def test_datetime_json_encoding():
+    j1 = json.dumps(dt_list, cls=utils._plotlyJSONEncoder)
+    assert(j1 == '["2014-01-05", '
+                 '"2014-01-05 01:01:01", '
+                 '"2014-01-05 01:01:01.000001"]')
+    j2 = json.dumps({"x": dt_list}, cls=utils._plotlyJSONEncoder)
+    assert(j2 == '{"x": ["2014-01-05", '
+                 '"2014-01-05 01:01:01", '
+                 '"2014-01-05 01:01:01.000001"]}')
+
+
 def test_pandas_json_encoding():
     j1 = json.dumps(df['col 1'], cls=utils._plotlyJSONEncoder)
     assert(j1 == '[1, 2, 3, "2014-01-05", null, NaN, Infinity]')
@@ -98,3 +115,50 @@ def test_pandas_json_encoding():
 
     j6 = json.dumps(ts.index, cls=utils._plotlyJSONEncoder)
     assert(j6 == '["2011-01-01", "2011-01-01 01:00:00"]')
+
+
+def test_numpy_masked_json_encoding():
+    l = [1, 2, np.ma.core.masked]
+    j1 = json.dumps(l, cls=utils._plotlyJSONEncoder)
+    assert(j1 == '[1, 2, NaN]')
+    assert(set(l) == set([1, 2, np.ma.core.masked]))
+
+
+def test_masked_constants_example():
+    # example from: https://gist.github.com/tschaume/d123d56bf586276adb98
+    data = {
+        'esN': [0, 1, 2, 3],
+        'ewe_is0': [-398.11901997, -398.11902774,
+                    -398.11897111, -398.11882215],
+        'ewe_is1': [-398.11793027, -398.11792966, -398.11786308, None],
+        'ewe_is2': [-398.11397008, -398.11396421, None, None]
+    }
+    df = pd.DataFrame.from_dict(data)
+
+    plotopts = {'x': 'esN', 'marker': 'o'}
+    fig, ax = plt.subplots(1, 1)
+    df.plot(ax=ax, **plotopts)
+
+    renderer = PlotlyRenderer()
+    Exporter(renderer).run(fig)
+
+    json.dumps(renderer.plotly_fig, cls=utils._plotlyJSONEncoder)
+
+    jy = json.dumps(renderer.plotly_fig['data'][1]['y'],
+                    cls=utils._plotlyJSONEncoder)
+    assert(jy == '[-398.11793026999999, -398.11792966000002, '
+                 '-398.11786308000001, NaN]')
+
+
+def test_numpy_dates():
+    a = np.arange(np.datetime64('2011-07-11'), np.datetime64('2011-07-18'))
+    j1 = json.dumps(a, cls=utils._plotlyJSONEncoder)
+    assert(j1 == '["2011-07-11", "2011-07-12", "2011-07-13", '
+                 '"2011-07-14", "2011-07-15", "2011-07-16", '
+                 '"2011-07-17"]')
+
+
+def test_datetime_dot_date():
+    a = [datetime.date(2014, 1, 1), datetime.date(2014, 1, 2)]
+    j1 = json.dumps(a, cls=utils._plotlyJSONEncoder)
+    assert(j1 == '["2014-01-01", "2014-01-02"]')

plotly/utils.py

@@ -101,12 +101,12 @@ def numpyJSONEncoder(self, obj):
         if not _numpy_imported:
             raise NotEncodable
 
+        if obj is numpy.ma.core.masked:
+            return float('nan')
+
         if type(obj).__module__.split('.')[0] == numpy.__name__:
-            l = obj.tolist()
-            try:
-                return self.datetimeJSONEncoder(l)
-            except NotEncodable:
-                return l
+            return obj.tolist()
+
         else:
             raise NotEncodable
 
@@ -123,19 +123,16 @@ def datetimeJSONEncoder(self, obj):
         if _pandas_imported and obj is pandas.NaT:
             return None
 
-        if isinstance(obj, (datetime.datetime, datetime.date)):
+
+        if isinstance(obj, datetime.datetime):
             if obj.microsecond:
                 return obj.strftime('%Y-%m-%d %H:%M:%S.%f')
             elif any((obj.second, obj.minute, obj.hour)):
                 return obj.strftime('%Y-%m-%d %H:%M:%S')
             else:
                 return obj.strftime('%Y-%m-%d')
-        elif isinstance(obj[0], (datetime.datetime, datetime.date)):
-            return [o.strftime(
-                    '%Y-%m-%d %H:%M:%S.%f') if o.microsecond else
-                    o.strftime('%Y-%m-%d %H:%M:%S') if any((o.second, o.minute, o.hour)) else
-                    o.strftime('%Y-%m-%d')
-                    for o in obj]
+        elif isinstance(obj, datetime.date):
+            return obj.strftime('%Y-%m-%d')
         else:
             raise NotEncodable
 

plotly/version.py

@@ -1 +1 @@
-__version__ = '1.4.10'
+__version__ = '1.4.11'