doc and minor code organization

matplotlib · WeatherGod · Apr 9, 2015 · Jan 23, 2014 · Jan 23, 2014 · Jan 24, 2014
commit 8dafe09e035fff4341e27fff940c88e9a5cf8ccb
diff --git a/doc/api/backend_managers_api.rst b/doc/api/backend_managers_api.rst
@@ -0,0 +1,8 @@
+
+:mod:`matplotlib.backend_managers`
+===================================
+
+.. automodule:: matplotlib.backend_managers
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/index_backend_api.rst b/doc/api/index_backend_api.rst
@@ -5,6 +5,7 @@ backends
 .. toctree::
 
    backend_bases_api.rst
+   backend_managers_api.rst
    backend_tools_api.rst
    backend_gtkagg_api.rst
    backend_qt4agg_api.rst

diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -24,6 +24,12 @@
     The base class for the Show class of each interactive backend;
     the 'show' callable is then set to Show.__call__, inherited from
     ShowBase.
+
+:class:`ToolContainerBase`
+     The base class for the Toolbar class of each interactive backend.
+
+:class:`StatusbarBase`
+    The base class for the messaging area.
 """
 
 from __future__ import (absolute_import, division, print_function,

diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -1,35 +1,19 @@
 """
-:class:`NavigationBase`
-    The base class for the Navigation class that makes the bridge between
-    user interaction (key press, toolbar clicks, ..) and the actions in
-    response to the user inputs.
-
-:class:`ToolContainerBase`
-     The base class for the Toolbar class of each interactive backend.
-
-:class:`StatusbarBase`
-    The base class for the messaging area.
+`ToolManager`
+    Class that makes the bridge between user interaction (key press,
+    toolbar clicks, ..) and the actions in response to the user inputs.
 """
 
 from __future__ import (absolute_import, division, print_function,
                         unicode_literals)
 import six
 import warnings
-import sys
 
 import matplotlib.cbook as cbook
 import matplotlib.widgets as widgets
 from matplotlib.rcsetup import validate_stringlist
 import matplotlib.backend_tools as tools
 
-try:
-    from importlib import import_module
-except:
-    # simple python 2.6 implementation (no relative imports)
-    def import_module(name):
-        __import__(name)
-        return sys.modules[name]
-
 
 class ToolEvent(object):
     """Event for tool manipulation (add/remove)"""

diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -1,13 +1,14 @@
 """
 Abstract base classes define the primitives for Tools.
-These tools are used by `ToolManager`
+These tools are used by `matplotlib.backend_managers.ToolManager`
 
 :class:`ToolBase`
     Simple stateless tool
 
 :class:`ToolToggleBase`
     Tool that has two states, only one Toggle tool can be
-    active at any given time for the same `ToolManager`
+    active at any given time for the same
+    `matplotlib.backend_managers.ToolManager`
 """
 
 

diff --git a/lib/matplotlib/backends/backend_gtk3.py b/lib/matplotlib/backends/backend_gtk3.py
@@ -758,8 +758,6 @@ def draw_rubberband(self, x0, y0, x1, y1):
         self.ctx.set_source_rgb(0, 0, 0)
         self.ctx.stroke()
 
-tools.ToolRubberband = RubberbandGTK3
-
 
 class ToolbarGTK3(ToolContainerBase, Gtk.Box):
     def __init__(self, toolmanager):
@@ -879,15 +877,11 @@ def trigger(self, *args, **kwargs):
             except Exception as e:
                 error_msg_gtk(str(e), parent=self)
 
-tools.ToolSaveFigure = SaveFigureGTK3
-
 
 class SetCursorGTK3(tools.SetCursorBase):
     def set_cursor(self, cursor):
         self.figure.canvas.get_property("window").set_cursor(cursord[cursor])
 
-tools.ToolSetCursor = SetCursorGTK3
-
 
 class ConfigureSubplotsGTK3(tools.ConfigureSubplotsBase, Gtk.Window):
     def __init__(self, *args, **kwargs):
@@ -942,9 +936,6 @@ def trigger(self, sender, event, data=None):
         self.window.present()
 
 
-tools.ToolConfigureSubplots = ConfigureSubplotsGTK3
-
-
 class DialogLineprops:
     """
     A GUI dialog for controlling lineprops
@@ -1130,6 +1121,12 @@ def error_msg_gtk(msg, parent=None):
     dialog.run()
     dialog.destroy()
 
+
+tools.ToolSaveFigure = SaveFigureGTK3
+tools.ToolConfigureSubplots = ConfigureSubplotsGTK3
+tools.ToolSetCursor = SetCursorGTK3
+tools.ToolRubberband = RubberbandGTK3
+
 Toolbar = ToolbarGTK3
 FigureCanvas = FigureCanvasGTK3
 FigureManager = FigureManagerGTK3