config.py
108 lines
| 4.4 KiB
| text/x-python
|
PythonLexer
|
r13167 | """Configurable for configuring the IPython inline backend | ||
This module does not import anything from matplotlib. | ||||
""" | ||||
#----------------------------------------------------------------------------- | ||||
# Copyright (C) 2011 The IPython Development Team | ||||
# | ||||
# Distributed under the terms of the BSD License. The full license is in | ||||
# the file COPYING, distributed as part of this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
from IPython.config.configurable import SingletonConfigurable | ||||
|
r14773 | from IPython.utils.traitlets import Dict, Instance, CaselessStrEnum, Bool, Int, TraitError | ||
|
r13167 | from IPython.utils.warn import warn | ||
#----------------------------------------------------------------------------- | ||||
# Configurable for inline backend options | ||||
#----------------------------------------------------------------------------- | ||||
|
r14772 | def pil_available(): | ||
"""Test if PIL/Pillow is available""" | ||||
out = False | ||||
try: | ||||
from PIL import Image | ||||
out = True | ||||
except: | ||||
pass | ||||
return out | ||||
|
r14770 | |||
|
r13167 | # inherit from InlineBackendConfig for deprecation purposes | ||
class InlineBackendConfig(SingletonConfigurable): | ||||
pass | ||||
class InlineBackend(InlineBackendConfig): | ||||
"""An object to store configuration of the inline backend.""" | ||||
def _config_changed(self, name, old, new): | ||||
# warn on change of renamed config section | ||||
if new.InlineBackendConfig != old.InlineBackendConfig: | ||||
warn("InlineBackendConfig has been renamed to InlineBackend") | ||||
super(InlineBackend, self)._config_changed(name, old, new) | ||||
# The typical default figure size is too large for inline use, | ||||
# so we shrink the figure size to 6x4, and tweak fonts to | ||||
# make that fit. | ||||
rc = Dict({'figure.figsize': (6.0,4.0), | ||||
# play nicely with white background in the Qt and notebook frontend | ||||
|
r13718 | 'figure.facecolor': (1,1,1,0), | ||
'figure.edgecolor': (1,1,1,0), | ||||
|
r13167 | # 12pt labels get cutoff on 6x4 logplots, so use 10pt. | ||
'font.size': 10, | ||||
# 72 dpi matches SVG/qtconsole | ||||
# this only affects PNG export, as SVG has no dpi setting | ||||
'savefig.dpi': 72, | ||||
# 10pt still needs a little more room on the xlabel: | ||||
'figure.subplot.bottom' : .125 | ||||
}, config=True, | ||||
help="""Subset of matplotlib rcParams that should be different for the | ||||
inline backend.""" | ||||
) | ||||
|
r14770 | |||
|
r14772 | figure_format = CaselessStrEnum(['svg', 'png', 'retina', 'jpg'], | ||
default_value='png', config=True, | ||||
|
r14773 | help="""The image format for figures with the inline | ||
backend. JPEG requires the PIL/Pillow library.""") | ||||
|
r13167 | |||
def _figure_format_changed(self, name, old, new): | ||||
from IPython.core.pylabtools import select_figure_format | ||||
|
r14772 | if new in {"jpg", "jpeg"}: | ||
if not pil_available(): | ||||
raise TraitError("Requires PIL/Pillow for JPG figures") | ||||
|
r13167 | if self.shell is None: | ||
return | ||||
else: | ||||
select_figure_format(self.shell, new) | ||||
|
r14772 | |||
quality = Int(default_value=90, config=True, | ||||
|
r14773 | help="Quality of compression [10-100], currently for lossy JPEG only.") | ||
|
r14772 | |||
def _quality_changed(self, name, old, new): | ||||
|
r14773 | if new < 10 or new > 100: | ||
raise TraitError("figure JPEG quality must be in [10-100] range.") | ||||
|
r13167 | |||
close_figures = Bool(True, config=True, | ||||
help="""Close all figures at the end of each cell. | ||||
When True, ensures that each cell starts with no active figures, but it | ||||
also means that one must keep track of references in order to edit or | ||||
redraw figures in subsequent cells. This mode is ideal for the notebook, | ||||
where residual plots from other cells might be surprising. | ||||
When False, one must call figure() to create new figures. This means | ||||
that gcf() and getfigs() can reference figures created in other cells, | ||||
and the active figure can continue to be edited with pylab/pyplot | ||||
methods that reference the current active figure. This mode facilitates | ||||
iterative editing of figures, and behaves most consistently with | ||||
other matplotlib backends, but figure barriers between cells must | ||||
be explicit. | ||||
""") | ||||
shell = Instance('IPython.core.interactiveshell.InteractiveShellABC') | ||||