Also autogenerate isinteractive and rcdefaults.

anntzer · anntzer · commit 3ff63048995f · 2018-01-15T21:20:13.000-08:00
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1394,25 +1394,25 @@ def get_backend():
 
 def interactive(b):
     """
-    Set interactive mode to boolean b.
+    Set interactive mode to boolean *b*.
 
-    If b is True, then draw after every plotting command, e.g., after xlabel
+    If *b* is True, then draw after every plotting command, e.g., after xlabel.
     """
     rcParams['interactive'] = b
 
 
 def is_interactive():
-    'Return true if plot mode is interactive'
+    """Return whether interactive mode is on."""
     return rcParams['interactive']
 
 
 def tk_window_focus():
     """Return true if focus maintenance under TkAgg on win32 is on.
-     This currently works only for python.exe and IPython.exe.
-     Both IDLE and Pythonwin.exe fail badly when tk_window_focus is on."""
-    if rcParams['backend'] != 'TkAgg':
-        return False
-    return rcParams['tk.window_focus']
+
+    This currently works only for python.exe and IPython.exe.
+    Both IDLE and Pythonwin.exe fail badly when tk_window_focus is on.
+    """
+    return rcParams['backend'] == 'TkAgg' and rcParams['tk.window_focus']
 
 
 default_test_modules = [
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1763,18 +1763,19 @@ def get_yticklines(self):
     # Adding and tracking artists
 
     def _sci(self, im):
-        """
-        helper for :func:`~matplotlib.pyplot.sci`;
-        do not use elsewhere.
+        """Set the current image.
+
+        This image will be the target of colormap functions like
+        `~matplotlib.pyplot.viridis`, and other functions such as
+        `~matplotlib.pyplot.hot` or `~matplotlib.pyplot.clim`.  The current
+        image is an attribute of the current axes.
         """
         if isinstance(im, matplotlib.contour.ContourSet):
             if im.collections[0] not in self.collections:
-                raise ValueError(
-                    "ContourSet must be in current Axes")
+                raise ValueError("ContourSet must be in current Axes")
         elif im not in self.images and im not in self.collections:
-            raise ValueError(
-                "Argument must be an image, collection, or ContourSet in "
-                "this Axes")
+            raise ValueError("Argument must be an image, collection, or "
+                             "ContourSet in this Axes")
         self._current_image = im
 
     def _gci(self):
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -247,11 +247,6 @@ def show(*args, **kw):
     return _show(*args, **kw)
 
 
-def isinteractive():
-    """Return status of interactive mode."""
-    return matplotlib.is_interactive()
-
-
 def ioff():
     """Turn interactive mode off."""
     matplotlib.interactive(False)
@@ -290,26 +285,6 @@ def pause(interval):
         time.sleep(interval)
 
 
-@docstring.copy_dedent(matplotlib.rcdefaults)
-def rcdefaults():
-    matplotlib.rcdefaults()
-    if matplotlib.is_interactive():
-        draw_all()
-
-
-# This function is not autogenerated because it is needed in when
-# autogenerating other functions, see `_post_processors`.
-def sci(im):
-    """
-    Set the current image.  This image will be the target of colormap
-    commands like :func:`~matplotlib.pyplot.jet`,
-    :func:`~matplotlib.pyplot.hot` or
-    :func:`~matplotlib.pyplot.clim`).  The current image is an
-    attribute of the current axes.
-    """
-    gca()._sci(im)
-
-
 ## Any Artist ##
 
 
@@ -1942,111 +1917,117 @@ def getname_val(identifier):
 install_repl_displayhook()
 
 
-def _make_wrapper(obj_getter, cls, command):
-    if ":" in command:
-        method_name, func_name = command.split(":")
-    else:
-        method_name = func_name = command
-    method = getattr(cls, method_name)
-    post_processor = _post_processors.get(func_name, lambda obj: None)
-
-    def func(*args, **kwargs):
-        # We actually need to refetch the method here in case it has been
-        # monkey-patched.
-        ret = getattr(obj_getter(), method_name)(*args, **kwargs)
-        post_processor(ret)
-        return ret
-
-    if six.PY2:
-        func.__name__ = func_name.encode("ascii")
-        import funcsigs
-        sig = funcsigs.signature(method)
-    else:
-        func.__name__ = func_name
-        sig = inspect.signature(method)
-
-    func.__doc__ = method.__doc__
-    func.__signature__ = sig.replace(
-        parameters=list(sig.parameters.values())[1:])
-    globals()[func.__name__] = func
-
-
-_canvas_commands = ["draw", "mpl_connect:connect", "mpl_disconnect:disconnect"]
-_fig_commands = [
-    "clf", "figimage", "gca", "ginput", "savefig", "subplots_adjust",
-    "suptitle", "tight_layout", "waitforbuttonpress",
-    # Renamed commands.
-    "_gci:gci", "legend:figlegend", "text:figtext"]
-_axes_commands = [
-    "acorr", "angle_spectrum", "annotate", "arrow", "autoscale", "axhline",
-    "axhspan", "axis", "axvline", "axvspan", "bar", "barbs", "barh", "boxplot",
-    "broken_barh", "cla", "clabel", "cohere", "contour", "contourf", "csd",
-    "errorbar", "eventplot", "fill", "fill_between", "fill_betweenx", "grid",
-    "hexbin", "hist", "hist2d", "hlines", "imshow", "legend", "locator_params",
-    "loglog", "magnitude_spectrum", "margins", "minorticks_off",
-    "minorticks_on", "pcolor", "pcolormesh", "phase_spectrum", "pie", "plot",
-    "plot_date", "psd", "quiver", "quiverkey", "scatter", "semilogx",
-    "semilogy", "specgram", "stackplot", "stem", "step", "streamplot", "table",
-    "text", "tick_params", "ticklabel_format", "tricontour", "tricontourf",
-    "tripcolor", "triplot", "violinplot", "vlines", "xcorr",
-    # Renamed commands.
-    "set_title:title", "set_xlabel:xlabel", "set_xscale:xscale",
-    "set_ylabel:ylabel", "set_yscale:yscale"]
-_post_processors = {
-    # For the following functions, an additional callable will be called with
-    # the return value as argument.
-    "hexbin": sci,
-    "imshow": sci,
-    "pcolor": sci,
-    "pcolormesh": sci,
-    "quiver": sci,
-    "scatter": sci,
-    "tripcolor": sci,
-    "contour": lambda ret: sci(ret) if ret._A is not None else None,
-    "contourf": lambda ret: sci(ret) if ret._A is not None else None,
-    "tricontour": lambda ret: sci(ret) if ret._A is not None else None,
-    "tricontourf": lambda ret: sci(ret) if ret._A is not None else None,
-    "hist2d": lambda ret: sci(ret[-1]),
-    "specgram": lambda ret: sci(ret[-1]),
-    "streamplot": lambda ret: sci(ret.lines),
-    "spy": (
-        lambda ret: sci(ret) if isinstance(ret, cm.ScalarMappable) else None)
-}
-
-for _command in _canvas_commands:
-    _make_wrapper(
-        lambda: get_current_fig_manager().canvas, FigureCanvasBase, _command)
-for _command in _fig_commands:
-    _make_wrapper(gcf, Figure, _command)
-for _command in _axes_commands:
-    _make_wrapper(gca, Axes, _command)
-
-
-def _make_cmap_wrapper(name):
-
-    def func():
-        rc("image", cmap=name)
-        im = gci()
-        if im is not None:
-            im.set_cmap(name)
-
-    func.__name__ = name.encode("ascii") if six.PY2 else name
-    func.__doc__ = """
-    Set the default colormap to "{}" and apply it to the current image, if any.
-
-    See ``help(colormaps)`` for more information.
-    """.format(name)
-    globals()[func.__name__] = func
-
-
-_cmaps = [
-    "autumn", "bone", "cool", "copper", "flag", "gray", "hot", "hsv",
-    "inferno", "jet", "magma", "nipy_spectral", "pink", "plasma", "prism",
-    "spectral", "spring", "summer", "viridis", "winter"]
-
-
-for _cmap in _cmaps:
-    _make_cmap_wrapper(_cmap)
+def _make_wrappers(obj_getter, base, commands, post_processors):
+    def make_closure(func_name, wrapper_name, post_processor):
+        def wrapper(*args, **kwargs):
+            # We actually need to refetch the func here in case it has been
+            # monkey-patched.
+            ret = getattr(obj_getter(), func_name)(*args, **kwargs)
+            post_processor(ret)
+            return ret
+
+        func = getattr(base, func_name)
+        if six.PY2:
+            wrapper.__name__ = wrapper_name.encode("ascii")
+            import funcsigs
+            sig = funcsigs.signature(func)
+        else:
+            wrapper.__name__ = wrapper_name
+            sig = inspect.signature(func)
+        wrapper.__doc__ = func.__doc__
+        # If, and only if, the base object is a class, we are dealing with
+        # methods, and the first argument gets bound.
+        wrapper.__signature__ = (
+            sig.replace(parameters=list(sig.parameters.values())[1:])
+            if isinstance(base, type) else sig)
+        globals()[wrapper.__name__] = wrapper
+
+    for command in commands:
+        if ":" in command:
+            func_name, wrapper_name = command.split(":")
+        else:
+            func_name = wrapper_name = command
+        post_processor = post_processors.get(wrapper_name, lambda obj: None)
+        make_closure(func_name, wrapper_name, post_processor)
+
+
+_make_wrappers(
+    lambda: matplotlib, matplotlib,
+    ["is_interactive:isinteractive", "rcdefaults"],
+    {"rcdefaults":
+     lambda _: draw_all() if matplotlib.is_interactive() else None})
+_make_wrappers(
+    lambda: get_current_fig_manager().canvas, FigureCanvasBase,
+    ["draw", "mpl_connect:connect", "mpl_disconnect:disconnect"],
+    {})
+_make_wrappers(
+    gcf, Figure,
+    ["clf", "figimage", "gca", "ginput", "savefig", "subplots_adjust",
+     "suptitle", "tight_layout", "waitforbuttonpress",
+     # Renamed commands.
+     "_gci:gci", "legend:figlegend", "text:figtext"],
+    {})
+_make_wrappers(
+    gca, Axes,
+    ["acorr", "angle_spectrum", "annotate", "arrow", "autoscale", "axhline",
+     "axhspan", "axis", "axvline", "axvspan", "bar", "barbs", "barh",
+     "boxplot", "broken_barh", "cla", "clabel", "cohere", "contour",
+     "contourf", "csd", "errorbar", "eventplot", "fill", "fill_between",
+     "fill_betweenx", "grid", "hexbin", "hist", "hist2d", "hlines", "imshow",
+     "legend", "locator_params", "loglog", "magnitude_spectrum", "margins",
+     "minorticks_off", "minorticks_on", "pcolor", "pcolormesh",
+     "phase_spectrum", "pie", "plot", "plot_date", "psd", "quiver",
+     "quiverkey", "scatter", "semilogx", "semilogy", "specgram", "stackplot",
+     "stem", "step", "streamplot", "table", "text", "tick_params",
+     "ticklabel_format", "tricontour", "tricontourf", "tripcolor", "triplot",
+     "violinplot", "vlines", "xcorr",
+     # Renamed commands.
+     "_sci:sci", "set_title:title", "set_xlabel:xlabel", "set_xscale:xscale",
+     "set_ylabel:ylabel", "set_yscale:yscale"],
+    {  # For the following functions, an additional callable will be called
+       # with the return value as argument.
+     "hexbin": lambda ret: sci(ret),
+     "imshow": lambda ret: sci(ret),
+     "pcolor": lambda ret: sci(ret),
+     "pcolormesh": lambda ret: sci(ret),
+     "quiver": lambda ret: sci(ret),
+     "scatter": lambda ret: sci(ret),
+     "tripcolor": lambda ret: sci(ret),
+     "contour": lambda ret: sci(ret) if ret._A is not None else None,
+     "contourf": lambda ret: sci(ret) if ret._A is not None else None,
+     "tricontour": lambda ret: sci(ret) if ret._A is not None else None,
+     "tricontourf": lambda ret: sci(ret) if ret._A is not None else None,
+     "hist2d": lambda ret: sci(ret[-1]),
+     "specgram": lambda ret: sci(ret[-1]),
+     "streamplot": lambda ret: sci(ret.lines),
+     "spy": lambda ret: (sci(ret) if isinstance(ret, cm.ScalarMappable)
+                         else None)})
+
+
+def _make_cmap_wrappers(names):
+    def make_closure(name):
+        def func():
+            rc("image", cmap=name)
+            im = gci()
+            if im is not None:
+                im.set_cmap(name)
+
+        func.__name__ = name.encode("ascii") if six.PY2 else name
+        func.__doc__ = """
+        Set the default and current image's colormap to "{}".
+
+        See ``help(colormaps)`` for more information.
+        """.format(name)
+        globals()[func.__name__] = func
+
+    for name in names:
+        make_closure(name)
+
+
+_make_cmap_wrappers(
+    ["autumn", "bone", "cool", "copper", "flag", "gray", "hot", "hsv",
+     "inferno", "jet", "magma", "nipy_spectral", "pink", "plasma", "prism",
+     "spectral", "spring", "summer", "viridis", "winter"])
 
 
 __all__ = sorted([name for name, obj in globals().items()
