##// END OF EJS Templates
Merge pull request #8958 from sieben/useless_semicolon...
Merge pull request #8958 from sieben/useless_semicolon Remove useless semicolon

File last commit:

r21756:e02ea14a
r21783:b1227de0 merge
Show More
pylabtools.py
376 lines | 12.9 KiB | text/x-python | PythonLexer
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 # -*- coding: utf-8 -*-
MinRK
support `%matplotlib qt5`...
r18084 """Pylab (matplotlib) support utilities."""
Thomas Kluyver
Convert print statements to print function calls...
r13348 from __future__ import print_function
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
MinRK
support `%matplotlib qt5`...
r18084 # Copyright (c) IPython Development Team.
# Distributed under the terms of the Modified BSD License.
Brian Granger
Work to address the review comments on Fernando's branch....
r2498
Grahame Bowland
Make PNG images in the Qt console work in Python 3.
r4773 from io import BytesIO
Brian Granger
Lots of work on the display system, focused on pylab stuff....
r3280
MinRK
enable retina display of Image objects...
r10803 from IPython.core.display import _pngxy
Brian Granger
Work to address the review comments on Fernando's branch....
r2498 from IPython.utils.decorators import flag_calls
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 from IPython.utils import py3compat
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
Fernando Perez
Add support for simultaneous interactive and inline matplotlib plots....
r2987 # If user specifies a GUI, that dictates the backend, otherwise we read the
# user's mpl default from the mpl rc structure
backends = {'tk': 'TkAgg',
'gtk': 'GTKAgg',
Michael Droettboom
Support matplotlib's Gtk3 backend in --pylab mode.
r13754 'gtk3': 'GTK3Agg',
Fernando Perez
Add support for simultaneous interactive and inline matplotlib plots....
r2987 'wx': 'WXAgg',
'qt': 'Qt4Agg', # qt3 not supported
'qt4': 'Qt4Agg',
MinRK
support `%matplotlib qt5`...
r18084 'qt5': 'Qt5Agg',
MinRK
add 'osx' to known pylab backends, fix pylab mode with MacOSX backend...
r3462 'osx': 'MacOSX',
MinRK
support %matplotlib nbagg...
r18091 'nbagg': 'nbAgg',
Min RK
add `%matplotlib notebook`...
r20433 'notebook': 'nbAgg',
Min RK
ipython_kernel is now ipykernel
r21337 'inline' : 'module://ipykernel.pylab.backend_inline'}
Fernando Perez
Add support for simultaneous interactive and inline matplotlib plots....
r2987
Fernando Perez
Fix support for raw GTK and WX matplotlib backends....
r3902 # We also need a reverse backends2guis mapping that will properly choose which
# GUI support to activate based on the desired matplotlib backend. For the
# most part it's just a reverse of the above dict, but we also need to add a
# few others that map to the same GUI manually:
backend2gui = dict(zip(backends.values(), backends.keys()))
Paul Ivanov
fix #3889
r11975 # Our tests expect backend2gui to just return 'qt'
backend2gui['Qt4Agg'] = 'qt'
Fernando Perez
Fix support for raw GTK and WX matplotlib backends....
r3902 # In the reverse mapping, there are a few extra valid matplotlib backends that
# map to the same GUI support
backend2gui['GTK'] = backend2gui['GTKCairo'] = 'gtk'
Michael Droettboom
Support matplotlib's Gtk3 backend in --pylab mode.
r13754 backend2gui['GTK3Cairo'] = 'gtk3'
Fernando Perez
Fix support for raw GTK and WX matplotlib backends....
r3902 backend2gui['WX'] = 'wx'
backend2gui['CocoaAgg'] = 'osx'
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 #-----------------------------------------------------------------------------
Brian Granger
Lots of work on the display system, focused on pylab stuff....
r3280 # Matplotlib utilities
#-----------------------------------------------------------------------------
Brian Granger
Final work on display system....
r3288
def getfigs(*fig_nums):
"""Get a list of matplotlib figures by figure numbers.
If no arguments are given, all available figures are returned. If the
argument list contains references to invalid figures, a warning is printed
but the function continues pasting further figures.
Parameters
----------
figs : tuple
A tuple of ints giving the figure numbers of the figures to return.
"""
from matplotlib._pylab_helpers import Gcf
if not fig_nums:
fig_managers = Gcf.get_all_fig_managers()
return [fm.canvas.figure for fm in fig_managers]
else:
figs = []
for num in fig_nums:
f = Gcf.figs.get(num)
if f is None:
Thomas Kluyver
Clean up converted code....
r13386 print('Warning: figure %s not available.' % num)
Brian Granger
Renaming the special methods of the formatters....
r3878 else:
figs.append(f.canvas.figure)
Brian Granger
Final work on display system....
r3288 return figs
Brian Granger
Lots of work on the display system, focused on pylab stuff....
r3280 def figsize(sizex, sizey):
"""Set the default figure size to be [sizex, sizey].
This is just an easy to remember, convenience wrapper that sets::
matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
"""
import matplotlib
matplotlib.rcParams['figure.figsize'] = [sizex, sizey]
MinRK
specify default bbox_inches in print_figure explicitly...
r15394 def print_figure(fig, fmt='png', bbox_inches='tight', **kwargs):
MinRK
print_figure returns unicode for svg
r16048 """Print a figure to an image, and return the resulting file data
Returned data will be bytes unless ``fmt='svg'``,
in which case it will be unicode.
MinRK
add InlineBackend.print_figure_kwargs...
r15342
MinRK
specify default bbox_inches in print_figure explicitly...
r15394 Any keyword args are passed to fig.canvas.print_figure,
MinRK
add InlineBackend.print_figure_kwargs...
r15342 such as ``quality`` or ``bbox_inches``.
Daniel B. Vasquez
Forgot to import TraitError....
r14773 """
MinRK
enable retina matplotlib figures
r10802 from matplotlib import rcParams
Fernando Perez
Do not generate output for empty figures in Qt console....
r3731 # When there's an empty figure, we shouldn't return anything, otherwise we
# get big blank areas in the qt console.
Fernando Perez
Display figures with no axes but lines, which are also valid.
r5732 if not fig.axes and not fig.lines:
Fernando Perez
Do not generate output for empty figures in Qt console....
r3731 return
MinRK
enable retina matplotlib figures
r10802 dpi = rcParams['savefig.dpi']
if fmt == 'retina':
dpi = dpi * 2
MinRK
enable retina display of Image objects...
r10803 fmt = 'png'
MinRK
enable retina matplotlib figures
r10802
MinRK
add InlineBackend.print_figure_kwargs...
r15342 # build keyword args
kw = dict(
format=fmt,
Benjamin Schultz
fixed bug setting figure.facecolor, which resulted in rcParams[figure.facecolor] being ignored
r16496 facecolor=fig.get_facecolor(),
edgecolor=fig.get_edgecolor(),
MinRK
add InlineBackend.print_figure_kwargs...
r15342 dpi=dpi,
MinRK
specify default bbox_inches in print_figure explicitly...
r15394 bbox_inches=bbox_inches,
MinRK
add InlineBackend.print_figure_kwargs...
r15342 )
# **kwargs get higher priority
kw.update(kwargs)
bytes_io = BytesIO()
fig.canvas.print_figure(bytes_io, **kw)
MinRK
print_figure returns unicode for svg
r16048 data = bytes_io.getvalue()
if fmt == 'svg':
data = data.decode('utf-8')
return data
MinRK
add InlineBackend.print_figure_kwargs...
r15342
def retina_figure(fig, **kwargs):
MinRK
enable retina matplotlib figures
r10802 """format a figure as a pixel-doubled (retina) PNG"""
MinRK
add InlineBackend.print_figure_kwargs...
r15342 pngdata = print_figure(fig, fmt='retina', **kwargs)
MinRK
enable retina display of Image objects...
r10803 w, h = _pngxy(pngdata)
MinRK
enable retina matplotlib figures
r10802 metadata = dict(width=w//2, height=h//2)
return pngdata, metadata
Brian Granger
Lots of work on the display system, focused on pylab stuff....
r3280
# We need a little factory function here to create the closure where
# safe_execfile can live.
def mpl_runner(safe_execfile):
"""Factory to return a matplotlib-enabled runner for %run.
Parameters
----------
safe_execfile : function
This must be a function with the same interface as the
:meth:`safe_execfile` method of IPython.
Returns
-------
A function suitable for use as the ``runner`` argument of the %run magic
function.
"""
def mpl_execfile(fname,*where,**kw):
"""matplotlib-aware wrapper around safe_execfile.
Its interface is identical to that of the :func:`execfile` builtin.
This is ultimately a call to execfile(), but wrapped in safeties to
properly handle interactive rendering."""
import matplotlib
import matplotlib.pylab as pylab
#print '*** Matplotlib runner ***' # dbg
# turn off rendering until end of script
is_interactive = matplotlib.rcParams['interactive']
matplotlib.interactive(False)
safe_execfile(fname,*where,**kw)
matplotlib.interactive(is_interactive)
# make rendering call now, if the user tried to do it
if pylab.draw_if_interactive.called:
pylab.draw()
pylab.draw_if_interactive.called = False
return mpl_execfile
MinRK
add InlineBackend.print_figure_kwargs...
r15342 def select_figure_formats(shell, formats, **kwargs):
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 """Select figure formats for the inline backend.
MinRK
add InlineBackendConfig...
r3973
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 Parameters
==========
shell : InteractiveShell
Brian E. Granger
Docstring improvement.
r15125 The main IPython instance.
MinRK
add InlineBackend.print_figure_kwargs...
r15342 formats : str or set
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 One or a set of figure formats to enable: 'png', 'retina', 'jpeg', 'svg', 'pdf'.
MinRK
add InlineBackend.print_figure_kwargs...
r15342 **kwargs : any
Extra keyword arguments to be passed to fig.canvas.print_figure.
MinRK
add InlineBackendConfig...
r3973 """
from matplotlib.figure import Figure
Min RK
ipython_kernel is now ipykernel
r21337 from ipykernel.pylab import backend_inline
MinRK
add InlineBackendConfig...
r3973
svg_formatter = shell.display_formatter.formatters['image/svg+xml']
png_formatter = shell.display_formatter.formatters['image/png']
Daniel B. Vasquez
Add JPEG as an image format for inline backend if PIL/pillow is available.
r14770 jpg_formatter = shell.display_formatter.formatters['image/jpeg']
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 pdf_formatter = shell.display_formatter.formatters['application/pdf']
MinRK
add InlineBackendConfig...
r3973
Brian E. Granger
Adding support for multiple figure formats in InlineBackend.
r15122 if isinstance(formats, py3compat.string_types):
formats = {formats}
MinRK
add InlineBackend.print_figure_kwargs...
r15342 # cast in case of list / tuple
formats = set(formats)
Daniel B. Vasquez
Move testing for PIL[low] in the _figure_format_changed(...) function instead...
r14772
MinRK
add InlineBackend.print_figure_kwargs...
r15342 [ f.pop(Figure, None) for f in shell.display_formatter.formatters.values() ]
supported = {'png', 'png2x', 'retina', 'jpg', 'jpeg', 'svg', 'pdf'}
bad = formats.difference(supported)
if bad:
MinRK
generate supported formats in ValueError
r15397 bs = "%s" % ','.join([repr(f) for f in bad])
gs = "%s" % ','.join([repr(f) for f in supported])
raise ValueError("supported formats are: %s not %s" % (gs, bs))
MinRK
add InlineBackend.print_figure_kwargs...
r15342
if 'png' in formats:
png_formatter.for_type(Figure, lambda fig: print_figure(fig, 'png', **kwargs))
if 'retina' in formats or 'png2x' in formats:
png_formatter.for_type(Figure, lambda fig: retina_figure(fig, **kwargs))
if 'jpg' in formats or 'jpeg' in formats:
jpg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'jpg', **kwargs))
if 'svg' in formats:
svg_formatter.for_type(Figure, lambda fig: print_figure(fig, 'svg', **kwargs))
if 'pdf' in formats:
pdf_formatter.for_type(Figure, lambda fig: print_figure(fig, 'pdf', **kwargs))
MinRK
add InlineBackendConfig...
r3973
Brian Granger
Lots of work on the display system, focused on pylab stuff....
r3280 #-----------------------------------------------------------------------------
# Code for initializing matplotlib and importing pylab
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 #-----------------------------------------------------------------------------
Ryan May
Implement bare %pylab switching back to appropriate GUI.
r7965 def find_gui_and_backend(gui=None, gui_select=None):
Brian Granger
Initial GUI support in kernel.
r2868 """Given a gui string return the gui and mpl backend.
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
Parameters
----------
Brian Granger
Initial GUI support in kernel.
r2868 gui : str
Fernando Perez
Renamed 'payload-svg' matplotlib backend to 'inline'.
r2991 Can be one of ('tk','gtk','wx','qt','qt4','inline').
Ryan May
Implement bare %pylab switching back to appropriate GUI.
r7965 gui_select : str
Can be one of ('tk','gtk','wx','qt','qt4','inline').
This is any gui already selected by the shell.
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
Returns
-------
Brian Granger
Initial GUI support in kernel.
r2868 A tuple of (gui, backend) where backend is one of ('TkAgg','GTKAgg',
Min RK
ipython_kernel is now ipykernel
r21337 'WXAgg','Qt4Agg','module://ipykernel.pylab.backend_inline').
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 """
import matplotlib
MinRK
quiet error messages instead of tracebacks in %pylab/%gui...
r5162 if gui and gui != 'auto':
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 # select backend based on requested gui
Fernando Perez
Add support for simultaneous interactive and inline matplotlib plots....
r2987 backend = backends[gui]
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 else:
Fernando Perez
Switch correctly to the user's default matplotlib backend after inline....
r12593 # We need to read the backend from the original data structure, *not*
# from mpl.rcParams, since a prior invocation of %matplotlib may have
# overwritten that.
Fernando Perez
Add comment as per PR discussion, indicating MPL 1.1 is now required.
r12639 # WARNING: this assumes matplotlib 1.1 or newer!!
Fernando Perez
Switch correctly to the user's default matplotlib backend after inline....
r12593 backend = matplotlib.rcParamsOrig['backend']
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 # In this case, we need to find what the appropriate gui selection call
# should be for IPython, so we can activate inputhook accordingly
Fernando Perez
Fix support for raw GTK and WX matplotlib backends....
r3902 gui = backend2gui.get(backend, None)
Ryan May
Implement bare %pylab switching back to appropriate GUI.
r7965
# If we have already had a gui active, we need it and inline are the
# ones allowed.
if gui_select and gui != gui_select:
gui = gui_select
backend = backends[gui]
Brian Granger
Initial GUI support in kernel.
r2868 return gui, backend
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
Brian Granger
Initial GUI support in kernel.
r2868
def activate_matplotlib(backend):
"""Activate the given backend and set interactive to True."""
import matplotlib
matplotlib.interactive(True)
MinRK
add `%matplotlib` and `shell.enable_matplotlib`...
r11328
Ryan May
Make use of matplotlib's switch_backend()...
r7939 # Matplotlib had a bug where even switch_backend could not force
# the rcParam to update. This needs to be set *before* the module
# magic of switch_backend().
matplotlib.rcParams['backend'] = backend
import matplotlib.pyplot
matplotlib.pyplot.switch_backend(backend)
Brian Granger
GUI support for wx, qt and tk.
r2872 # This must be imported last in the matplotlib series, after
# backend/interactivity choices have been made
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 import matplotlib.pylab as pylab
Brian Granger
GUI support for wx, qt and tk.
r2872 pylab.show._needmain = False
# We need to detect at runtime whether show() is called by the user.
# For this, we wrap it into a decorator which adds a 'called' flag.
pylab.draw_if_interactive = flag_calls(pylab.draw_if_interactive)
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
Fernando Perez
Refactor gui/pylab integration to eliminate code duplication....
r5469
def import_pylab(user_ns, import_all=True):
MinRK
adjust `import_pylab`...
r11323 """Populate the namespace with pylab-related values.
Imports matplotlib, pylab, numpy, and everything from pylab and numpy.
Also imports a few names from IPython (figsize, display, getfigs)
"""
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363
# Import numpy as np/pyplot as plt are conventions we're trying to
# somewhat standardize on. Making them available to users by default
Fernando Perez
Fix name pollution of interactive namespace in pylab mode....
r3195 # will greatly help this.
s = ("import numpy\n"
Fernando Perez
First semi-complete support for -pylab and %pylab....
r2363 "import matplotlib\n"
"from matplotlib import pylab, mlab, pyplot\n"
"np = numpy\n"
"plt = pyplot\n"
Fernando Perez
Fix name pollution of interactive namespace in pylab mode....
r3195 )
Thomas Kluyver
Fix exec statements for Py 3...
r13350 exec(s, user_ns)
MinRK
adjust `import_pylab`...
r11323
MinRK
add `%matplotlib` and `shell.enable_matplotlib`...
r11328 if import_all:
s = ("from matplotlib.pylab import *\n"
"from numpy import *\n")
Thomas Kluyver
Fix exec statements for Py 3...
r13350 exec(s, user_ns)
MinRK
adjust `import_pylab`...
r11323
# IPython symbols to add
user_ns['figsize'] = figsize
from IPython.core.display import display
# Add display and getfigs to the user's namespace
user_ns['display'] = display
user_ns['getfigs'] = getfigs
Fernando Perez
Fix critical bug with pylab support inadvertently introduced in #648....
r5468
Fernando Perez
Refactor gui/pylab integration to eliminate code duplication....
r5469
MinRK
add `%matplotlib` and `shell.enable_matplotlib`...
r11328 def configure_inline_support(shell, backend):
Fernando Perez
Refactor gui/pylab integration to eliminate code duplication....
r5469 """Configure an IPython shell object for matplotlib use.
Parameters
----------
shell : InteractiveShell instance
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474 backend : matplotlib backend
Fernando Perez
Refactor gui/pylab integration to eliminate code duplication....
r5469 """
# If using our svg payload backend, register the post-execution
# function that will pick up the results for display. This can only be
# done with access to the real shell object.
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474 # Note: if we can't load the inline backend, then there's no point
# continuing (such as in terminal-only shells in environments without
# zeromq available).
try:
Min RK
ipython_kernel is now ipykernel
r21337 from ipykernel.pylab.backend_inline import InlineBackend
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474 except ImportError:
return
Ryan May
Add code to de-init the inline backend....
r7940 from matplotlib import pyplot
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474
MinRK
use `parent=self` throughout IPython...
r11064 cfg = InlineBackend.instance(parent=shell)
Fernando Perez
Refactor gui/pylab integration to eliminate code duplication....
r5469 cfg.shell = shell
if cfg not in shell.configurables:
shell.configurables.append(cfg)
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474 if backend == backends['inline']:
Min RK
ipython_kernel is now ipykernel
r21337 from ipykernel.pylab.backend_inline import flush_figures
Thomas Kluyver
Use new events API for inline backend flush_figures
r15614 shell.events.register('post_execute', flush_figures)
Ryan May
Add code to de-init the inline backend....
r7940
# Save rcParams that will be overwrittern
shell._saved_rcParams = dict()
for k in cfg.rc:
shell._saved_rcParams[k] = pyplot.rcParams[k]
Fernando Perez
Fix inline backend logic and avoid tests if mpl not available.
r5474 # load inline_rc
pyplot.rcParams.update(cfg.rc)
Jan Schulz
Prevent reset of matplotlib formatters when enabled again...
r21756 new_backend_name = "inline"
Ryan May
Add code to de-init the inline backend....
r7940 else:
Min RK
ipython_kernel is now ipykernel
r21337 from ipykernel.pylab.backend_inline import flush_figures
Thomas Kluyver
Use new events API for inline backend flush_figures
r15614 try:
shell.events.unregister('post_execute', flush_figures)
except ValueError:
pass
Ryan May
Add code to de-init the inline backend....
r7940 if hasattr(shell, '_saved_rcParams'):
pyplot.rcParams.update(shell._saved_rcParams)
del shell._saved_rcParams
Jan Schulz
Prevent reset of matplotlib formatters when enabled again...
r21756 new_backend_name = "other"
# only enable the formats once -> don't change the enabled formats (which the user may
# has changed) when getting another "%matplotlib inline" call.
# See https://github.com/ipython/ipykernel/issues/29
cur_backend = getattr(configure_inline_support, "current_backend", "unset")
if new_backend_name != cur_backend:
# Setup the default figure format
select_figure_formats(shell, cfg.figure_formats, **cfg.print_figure_kwargs)
configure_inline_support.current_backend = new_backend_name