Added 'get_ordered' method to graph_objects. returns an ordered dict.

theengineear · theengineear · commit ba847848c719 · 2014-05-29T12:39:38.000-07:00
Notes:
1. references in the returned dict are NOT broken (no copies)
2. returned dict is ordered according to graph_references' INFO
diff --git a/plotly/graph_objs/graph_objs.py b/plotly/graph_objs/graph_objs.py
@@ -434,6 +434,21 @@ def to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80):
         string += "{eol}{indent}])".format(eol=eol, indent=' ' * indent * level)
         return string
 
+    def get_ordered(self, caller=True):
+        if caller:
+            try:
+                self.to_graph_objs(caller=False)
+            except exceptions.PlotlyGraphObjectError as err:
+                err.add_note("Could not order list because it could not be "
+                             "converted to a valid graph object.")
+                err.prepare()
+                raise
+        ordered_list = []
+        for index, entry in enumerate(self):
+            ordered_list += [entry.get_ordered()]
+        return ordered_list
+
+
     def force_clean(self, caller=True):
         """Attempts to convert to graph_objs and calls force_clean() on entries.
 
@@ -753,6 +768,34 @@ def to_string(self, level=0, indent=4, eol='\n', pretty=True, max_chars=80):
         string += "{eol}{indent})".format(eol=eol, indent=' ' * indent * level)
         return string
 
+    def get_ordered(self, caller=True):
+        if caller:  # change everything to 'order-able' objs
+            try:
+                self.to_graph_objs(caller=False)
+            except exceptions.PlotlyGraphObjectError as err:
+                err.add_note("dictionary could not be ordered because it "
+                             "could not be converted to a valid plotly graph "
+                             "object.")
+                err.prepare()
+                raise
+        obj_type = NAME_TO_KEY[self.__class__.__name__]
+        ordered_dict = collections.OrderedDict()
+        # grab keys like xaxis1, xaxis2, etc...
+        unordered_keys = [key for key in self if key not in INFO[obj_type]]
+        for key in INFO[obj_type]:
+            if key in self:
+                if isinstance(self[key], (PlotlyDict, PlotlyList)):
+                    ordered_dict[key] = self[key].get_ordered(caller=False)
+                else:
+                    ordered_dict[key] = self[key]
+        for key in unordered_keys:
+            if isinstance(self[key], (PlotlyDict, PlotlyList)):
+                ordered_dict[key] = self[key].get_ordered(caller=False)
+            else:
+                ordered_dict[key] = self[key]
+        return ordered_dict
+
+
     def force_clean(self, caller=True):
         """Attempts to convert to graph_objs and call force_clean() on values.
 
