1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
# ----------------------------------------------------------------------------
# Copyright (c) 2013--, scikit-bio development team.
#
# Distributed under the terms of the Modified BSD License.
#
# The full license is in the file LICENSE.txt, distributed with this software.
# ----------------------------------------------------------------------------
import importlib
from io import StringIO, BytesIO
class PlottableMixin:
"""A plottable object."""
def _get_mpl_plt(self):
"""Import Matplotlib and its plotting interface."""
msg = "Plotting requires Matplotlib installed in the system."
if hasattr(self, "mpl"):
if self.mpl is None:
raise ImportError(msg)
return
try:
self.mpl = importlib.import_module("matplotlib")
except ImportError:
self.mpl = None
raise ImportError(msg)
else:
self.plt = importlib.import_module("matplotlib.pyplot")
def _figure_data(self, format="png"):
"""Get figure data of a plottable object.
Parameters
----------
format : str, optional
Image format supported by the plotting backend. Examples include
'png' (default), 'svg', 'pdf', and 'eps'.
Returns
-------
str or bytes or None
Figure data, or None if the plotting backend is not available.
"""
try:
self._get_mpl_plt()
except ImportError:
return
# call default plotting method
fig = self.plot()
fig.tight_layout()
# get figure data
# formats such as SVG are string
try:
fig.savefig(f := StringIO(), format=format)
# formats such as PNG are bytes
except TypeError:
fig.savefig(f := BytesIO(), format=format)
# close figure to avoid double display in IPython
self.plt.close(fig)
return f.getvalue()
def _repr_png_(self):
"""Generate a PNG format figure for display in IPython."""
return self._figure_data("png")
def _repr_svg_(self):
"""Generate an SVG format figure for display in IPython."""
return self._figure_data("svg")
@property
def png(self):
"""Get figure data in PNG format.
Returns
-------
bytes
Figure data in PNG format.
"""
return self._repr_png_()
@property
def svg(self):
"""Get figure data in SVG format.
Returns
-------
str
Figure data in SVG format.
"""
return self._repr_svg_()
|
