Added error messages for stream_validate.

theengineear · theengineear · commit c240ffa6ad5a · 2014-05-12T17:01:33.000-07:00
diff --git a/plotly/plotly/plotly.py b/plotly/plotly/plotly.py
@@ -367,7 +367,8 @@ def open(self):
                                                 'plotly-streamtoken': self.stream_id})
 
 
-    def write(self, data, reconnect_on=(200, '', 408)):
+    def write(self, data, layout=None, validate=True,
+              reconnect_on=(200, '', 408)):
         """ Write `data` to your stream. This will plot the
         `data` in your graph in real-time.
 
@@ -392,6 +393,15 @@ def write(self, data, reconnect_on=(200, '', 408)):
         """
 
         # TODO: Verify the data
+        if validate:
+            if 'type' not in data:
+                data['type'] = 'scatter'
+            tools.validate(data, data['type'])  # todo: add error message
+            tools.validate_stream(data, data['type'])  # todo: add error message
+            if layout is not None:
+                tools.validate(layout, 'Layout')  # todo: add error message
+
+        # TODO: allow string version of this?
         jdata = json.dumps(data, cls=utils._plotlyJSONEncoder)
         jdata += "\n"
 
diff --git a/plotly/tools.py b/plotly/tools.py
@@ -359,3 +359,28 @@ def validate(obj, obj_type):
         raise exceptions.PlotlyError(
             "'{}' is not a recognizable graph_obj.".
             format(obj_type))
+
+
+def validate_stream(obj, obj_type):
+    info = graph_objs.INFO[graph_objs.NAME_TO_KEY[obj_type]]
+    for key, val in obj.items():
+        if key == 'type':
+            continue
+        if 'streamable' in info[key]:
+            if not info[key]['streamable']:
+                raise exceptions.PlotlyError(
+                    "The '{}' key is not streamable in the '{}' object".format(
+                        key, obj_type
+                    )
+                )
+        else:
+            raise exceptions.PlotlyError(
+                "The '{}' key is not streamable in the '{}' object".format(
+                    key, obj_type
+                )
+            )
+        try:
+            sub_obj_type = graph_objs.KEY_TO_NAME[key]
+            validate_stream(val, sub_obj_type)
+        except KeyError:
+            pass
