reordering, override some objs after type() creation

Author: etpinard

plotly/graph_objs/graph_objs.py

@@ -39,6 +39,7 @@
     from collections import OrderedDict
 
 
+# (1) Make primitive graph objects
 class PlotlyList(list):
     """A container for PlotlyDicts, inherits from standard list.
 
@@ -690,17 +691,97 @@ def force_clean(self, caller=True):
                 del self[key]
 
 
-class Data(PlotlyList):
-    """A list of traces to be shown on a plot/graph.
+class PlotlyTrace(PlotlyDict):
+    """A general data class for plotly.
 
-    Any operation that can be done with a standard list may be used with Data.
-    Instantiation requires an iterable (just like list does), for example:
+    The PlotlyTrace object is not meant for user interaction. It's sole
+    purpose is to improve the structure of the object hierarchy established
+    in this module.
 
-    Data([Scatter(), Heatmap(), Box()])
+    Users should work with the subclasses of PlotlyTrace: Scatter, Box, Bar,
+    Heatmap, etc.
 
-    Valid entry types: (dict or any Trace subclass, e.g. Scatter, Box, etc.)
+    For help with these subclasses, run:
+    `help(plotly.graph_objs.Obj)` where Obj == Scatter, Box, Bar, Heatmap, etc.
 
     """
+    def __init__(self, *args, **kwargs):
+        super(PlotlyTrace, self).__init__(*args, **kwargs)
+        if self.__class__.__name__ == 'PlotlyTrace':
+            warnings.warn("\nThe PlotlyTrace class is a base class of "
+                          "dictionary-like plot types.\nIt is not meant to be "
+                          "a user interface.")
+
+    def to_string(self, level=0, indent=4, eol='\n',
+                  pretty=True, max_chars=80):
+        """Returns a formatted string showing graph_obj constructors.
+
+        Example:
+
+            print obj.to_string()
+
+        Keyword arguments:
+        level (default = 0) -- set number of indentations to start with
+        indent (default = 4) -- set indentation amount
+        eol (default = '\n') -- set end of line character(s)
+        pretty (default = True) -- curtail long list output with a '...'
+        max_chars (default = 80) -- set max characters per line
+
+        """
+        self.to_graph_objs()
+        if self.__class__.__name__ != "Trace":
+            trace_type = self.pop('type')
+            string = super(PlotlyTrace, self).to_string(level=level,
+                                                        indent=indent,
+                                                        eol=eol,
+                                                        pretty=pretty,
+                                                        max_chars=max_chars)
+            self['type'] = trace_type
+        else:
+            string = super(PlotlyTrace, self).to_string(level=level,
+                                                        indent=indent,
+                                                        eol=eol,
+                                                        pretty=pretty,
+                                                        max_chars=max_chars)
+        return string
+
+
+class Trace(PlotlyTrace):
+    """A general data class for plotly. Never validated...
+
+    This class should be used only for the right reason. This class does not
+    do much validation because plotly usually accepts more trace specifiers
+    and more value type varieties, e.g., 'x', 'y', 'r', 't', marker = [
+    array], etc.
+
+    If you are getting errors locally, you might try using this case if
+    you're sure that what you're attempting to plot is valid.
+
+    Also, when getting figures from plotly, you may get back `Trace` types if
+    the figure was constructed with data objects that don't fall into any of
+    the class categorizations that are defined in this api.
+
+    """
+    pass
+
+
+# (2) Generate graph objects using OBJ_MAP
+# With type(name, bases, dict) :
+# - name will be the new class name
+# - bases are the base classes that the new class inherits from
+# - dict holds attributes for the new class, e.g., __doc__
+for obj in OBJ_MAP:
+    base_name = graph_objs_tools.OBJ_MAP[obj]['base_name']
+    if base_name == 'PlotlyList':
+        doc = graph_objs_tools.make_list_doc(obj)
+    else:
+        doc = graph_objs_tools.make_dict_doc(obj)
+    base = globals()[base_name]
+    globals()[obj] = type(obj, (base,), {'__doc__': doc, '__name__': obj})
+
+
+# (3) Patch 'custom' methods into some graph objects
+def patch_Data(Data):
     def to_graph_objs(self, caller=True):  # TODO TODO TODO! check logic!
         """Change any nested collections to subclasses of PlotlyDict/List.
 
@@ -736,25 +817,13 @@ def to_graph_objs(self, caller=True):  # TODO TODO TODO! check logic!
                     ),
                 )
         super(Data, self).to_graph_objs(caller=caller)
+    Data.to_graph_objs = to_graph_objs  # override method!
+    return Data
 
+Data = patch_Data(Data)
 
-class Annotations(PlotlyList):
-    """A list-like object to contain all figure notes.
-
-    Any operation that can be done with a standard list may be used with
-    Annotations. Instantiation requires an iterable (just like list does),
-    for example:
-
-    Annotations([Annotation(), Annotation(), Annotation()])
-
-    This Annotations list is validated upon instantiation, meaning exceptions
-    will be thrown if any invalid entries are found.
 
-    Valid entry types: (dict or Annotation)
-
-    For help on Annotation, run `help(plotly.graph_objs.Annotation)`
-
-    """
+def patch_Annotations(Annotations):
     def to_graph_objs(self, caller=True):
         """Change any nested collections to subclasses of PlotlyDict/List.
 
@@ -788,91 +857,13 @@ def to_graph_objs(self, caller=True):
                     ),
                 )
         super(Annotations, self).to_graph_objs(caller=caller)
+    Annotations.to_graph_objs = to_graph_objs  # override method!
+    return Annotations
 
+Annotations = patch_Annotations(Annotations)
 
-class PlotlyTrace(PlotlyDict):
-    """A general data class for plotly.
-
-    The PlotlyTrace object is not meant for user interaction. It's sole
-    purpose is to improve the structure of the object hierarchy established
-    in this module.
-
-    Users should work with the subclasses of PlotlyTrace: Scatter, Box, Bar,
-    Heatmap, etc.
 
-    For help with these subclasses, run:
-    `help(plotly.graph_objs.Obj)` where Obj == Scatter, Box, Bar, Heatmap, etc.
-
-    """
-    def __init__(self, *args, **kwargs):
-        super(PlotlyTrace, self).__init__(*args, **kwargs)
-        if self.__class__.__name__ == 'PlotlyTrace':
-            warnings.warn("\nThe PlotlyTrace class is a base class of "
-                          "dictionary-like plot types.\nIt is not meant to be "
-                          "a user interface.")
-
-    def to_string(self, level=0, indent=4, eol='\n',
-                  pretty=True, max_chars=80):
-        """Returns a formatted string showing graph_obj constructors.
-
-        Example:
-
-            print obj.to_string()
-
-        Keyword arguments:
-        level (default = 0) -- set number of indentations to start with
-        indent (default = 4) -- set indentation amount
-        eol (default = '\n') -- set end of line character(s)
-        pretty (default = True) -- curtail long list output with a '...'
-        max_chars (default = 80) -- set max characters per line
-
-        """
-        self.to_graph_objs()
-        if self.__class__.__name__ != "Trace":
-            trace_type = self.pop('type')
-            string = super(PlotlyTrace, self).to_string(level=level,
-                                                        indent=indent,
-                                                        eol=eol,
-                                                        pretty=pretty,
-                                                        max_chars=max_chars)
-            self['type'] = trace_type
-        else:
-            string = super(PlotlyTrace, self).to_string(level=level,
-                                                        indent=indent,
-                                                        eol=eol,
-                                                        pretty=pretty,
-                                                        max_chars=max_chars)
-        return string
-
-
-class Trace(PlotlyTrace):
-    """A general data class for plotly. Never validated...
-
-    This class should be used only for the right reason. This class does not
-    do much validation because plotly usually accepts more trace specifiers
-    and more value type varieties, e.g., 'x', 'y', 'r', 't', marker = [
-    array], etc.
-
-    If you are getting errors locally, you might try using this case if
-    you're sure that what you're attempting to plot is valid.
-
-    Also, when getting figures from plotly, you may get back `Trace` types if
-    the figure was constructed with data objects that don't fall into any of
-    the class categorizations that are defined in this api.
-
-    """
-    pass
-
-
-class Figure(PlotlyDict):
-    """A dictionary-like object representing a figure to be rendered in plotly.
-
-    This is the container for all things to be rendered in a figure.
-
-    For help with setting up subplots, run:
-    `help(plotly.tools.get_subplots)`
-
-    """
+def patch_Figure(Figure):
     def __init__(self, *args, **kwargs):
         if len(args):
             if ('data' not in kwargs) and ('data' not in args[0]):
@@ -885,12 +876,13 @@ def __init__(self, *args, **kwargs):
             if 'layout' not in kwargs:
                 kwargs['layout'] = Layout()
         super(Figure, self).__init__(*args, **kwargs)
+    Figure.__init__ = __init__  # override method!
+    return Figure
 
+Figure = patch_Figure(Figure)
 
-class Layout(PlotlyDict):
-    """A dictionary-like object holding plot settings for plotly figures.
 
-    """
+def patch_Layout(Layout):
     def __init__(self, *args, **kwargs):
         super(Layout, self).__init__(*args, **kwargs)
 
@@ -1055,8 +1047,16 @@ def force_clean(self, caller=True):  # TODO: can't make call to super...
                     del self[key]  # clears empty collections!
             elif self[key] is None:
                 del self[key]
+    Layout.__init__ = __init__
+    Layout.to_graph_objs = to_graph_objs
+    Layout.to_string = to_string
+    Layout.force_clean = force_clean  # override methods!
+    return Layout
 
+Layout = patch_Layout(Layout)
 
+
+# (4) Class-generating function
 def _factory(name, *args, **kwargs):
     """All class creation goes through here.
 
@@ -1073,20 +1073,3 @@ def _factory(name, *args, **kwargs):
         return globals()[name](**kwargs)
     else:
         return globals()[name]()
-
-
-# some magic... you can use `type` to create new classes:
-# type(name, bases, dict)
-# name will be the new class name
-# bases are the base classes that the new class inherits from
-# dict holds attributes for the new class, e.g., __doc__
-# why? because __doc__ isn't writeable after-the-fact!
-for obj in OBJ_MAP:
-    if obj not in globals():
-        base_name = graph_objs_tools.OBJ_MAP[obj]['base_name']
-        if base_name == 'PlotlyList':
-            doc = graph_objs_tools.make_list_doc(obj)
-        else:
-            doc = graph_objs_tools.make_dict_doc(obj)
-        base = globals()[base_name]
-        globals()[obj] = type(obj, (base,), {'__doc__': doc, '__name__': obj})