matplotlib.github.com/2.2.4/users/shell.html at gh-pages · matplotlib/matplotlib.github.com

History

304 lines (274 loc) · 18.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Using matplotlib in a python shell — Matplotlib 2.2.4 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.2.4',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.2.4 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.4). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.4</span></div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="event_handling.html" title="Event handling and picking"

accesskey="N">next</a> |</li>

<a href="navigation_toolbar.html" title="Interactive navigation"

accesskey="P">previous</a> |</li>

<li><a href="../gallery/index.html">examples</a>| </li>

<li><a href="../tutorials/index.html">tutorials</a>| </li>

<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" >User's Guide</a> »</li>

<li><a href="interactive.html" accesskey="U">Interactive plots</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3><a href="../contents.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">Using matplotlib in a python shell</a><ul>

<li><a class="reference internal" href="#ipython-to-the-rescue">IPython to the rescue</a></li>

<li><a class="reference internal" href="#other-python-interpreters">Other python interpreters</a></li>

<li><a class="reference internal" href="#controlling-interactive-updating">Controlling interactive updating</a></li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">User's Guide</a><ul>

<li><a href="interactive.html">Interactive plots</a><ul>

<li>Previous: <a href="navigation_toolbar.html" title="previous chapter">Interactive navigation</a></li>

<li>Next: <a href="event_handling.html" title="next chapter">Event handling and picking</a></li>

</ul></li>

</ul>

</div>

<div id="sidebar-pagesource" role="note" aria-label="source link"

style="margin-top: 1.5em; padding-top: 0.1em; border-top: 1px solid #86989b">

<a href="../_sources/users/shell.rst.txt"

style="color: #c0c0c0" rel="nofollow">Show Page Source</a>

</div>

<span id="mpl-shell"></span><h1>Using matplotlib in a python shell<a class="headerlink" href="#using-matplotlib-in-a-python-shell" title="Permalink to this headline">¶</a></h1>

<p class="first admonition-title">Warning</p>

<p class="last">This page is significantly out of date</p>

</div>

<p>By default, matplotlib defers drawing until the end of the script

because drawing can be an expensive operation, and you may not want

to update the plot every time a single property is changed, only once

after all the properties have changed.</p>

<p>But when working from the python shell, you usually do want to update

the plot with every command, e.g., after changing the

<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.xlabel.html#matplotlib.pyplot.xlabel" title="matplotlib.pyplot.xlabel"><code class="xref py py-func docutils literal notranslate"><span class="pre">xlabel()</span></code></a>, or the marker style of a line.

While this is simple in concept, in practice it can be tricky, because

matplotlib is a graphical user interface application under the hood,

and there are some tricks to make the applications work right in a

python shell.</p>

<span id="ipython-pylab"></span><h2>IPython to the rescue<a class="headerlink" href="#ipython-to-the-rescue" title="Permalink to this headline">¶</a></h2>

<p class="last">The mode described here still exists for historical reasons, but it is

highly advised not to use. It pollutes namespaces with functions that will

shadow python built-in and can lead to hard to track bugs. To get IPython

integration without imports the use of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">%matplotlib</span></code> magic is

preferred. See

<a class="reference external" href="https://ipython.readthedocs.io/en/stable/interactive/reference.html#plotting-with-matplotlib">ipython documentation</a>

.</p>

</div>

<p>Fortunately, <a class="reference external" href="http://ipython.org/">ipython</a>, an enhanced

interactive python shell, has figured out all of these tricks, and is

matplotlib aware, so when you start ipython in the <em>pylab</em> mode.</p>

<div class="highlight-ipython notranslate"><div class="highlight"><pre><span></span><span class="go">johnh@flag:~> ipython</span>

<span class="go">Python 2.4.5 (#4, Apr 12 2008, 09:09:16)</span>

<span class="go">IPython 0.9.0 -- An enhanced Interactive Python.</span>

<span class="gp">In [1]: </span><span class="o">%</span><span class="k">pylab</span>

<span class="go"> Welcome to pylab, a matplotlib-based Python environment.</span>

<span class="go"> For more information, type 'help(pylab)'.</span>

<span class="gp">In [2]: </span><span class="n">x</span> <span class="o">=</span> <span class="n">randn</span><span class="p">(</span><span class="mi">10000</span><span class="p">)</span>

</pre></div>

</div>

<p>it sets everything up for you so interactive plotting works as you

would expect it to. Call <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.figure.html#matplotlib.pyplot.figure" title="matplotlib.pyplot.figure"><code class="xref py py-func docutils literal notranslate"><span class="pre">figure()</span></code></a> and a

figure window pops up, call <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="matplotlib.pyplot.plot"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a> and your

data appears in the figure window.</p>

<p>Note in the example above that we did not import any matplotlib names

because in pylab mode, ipython will import them automatically.

ipython also turns on <em>interactive</em> mode for you, which causes every

pyplot command to trigger a figure update, and also provides a

matplotlib aware <code class="docutils literal notranslate"><span class="pre">run</span></code> command to run matplotlib scripts

efficiently. ipython will turn off interactive mode during a <code class="docutils literal notranslate"><span class="pre">run</span></code>

command, and then restore the interactive state at the end of the

run so you can continue tweaking the figure manually.</p>

<p>There has been a lot of recent work to embed ipython, with pylab

support, into various GUI applications, so check on the ipython

mailing <a class="reference external" href="https://mail.scipy.org/mailman/listinfo/ipython-user">list</a> for the

latest status.</p>

</div>

<span id="other-shells"></span><h2>Other python interpreters<a class="headerlink" href="#other-python-interpreters" title="Permalink to this headline">¶</a></h2>

<p>If you can't use ipython, and still want to use matplotlib/pylab from

an interactive python shell, e.g., the plain-ole standard python

interactive interpreter, you

are going to need to understand what a matplotlib backend is

<a class="reference internal" href="../tutorials/introductory/usage.html#what-is-a-backend"><span class="std std-ref">What is a backend?</span></a>.</p>

<p>With the TkAgg backend, which uses the Tkinter user interface toolkit,

you can use matplotlib from an arbitrary non-gui python shell. Just set your

<code class="docutils literal notranslate"><span class="pre">backend</span> <span class="pre">:</span> <span class="pre">TkAgg</span></code> and <code class="docutils literal notranslate"><span class="pre">interactive</span> <span class="pre">:</span> <span class="pre">True</span></code> in your

<code class="file docutils literal notranslate"><span class="pre">matplotlibrc</span></code> file (see <a class="reference internal" href="../tutorials/introductory/customizing.html"><span class="doc">Customizing Matplotlib with style sheets and rcParams</span></a>) and fire

up python. Then:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pylab</span> <span class="k">import</span> <span class="o">*</span>

<span class="gp">>>> </span><span class="n">xlabel</span><span class="p">(</span><span class="s1">'hi mom'</span><span class="p">)</span>

</pre></div>

</div>

<p>should work out of the box. This is also likely to work with recent

versions of the qt4agg and gtkagg backends, and with the macosx backend

on the Macintosh. Note, in batch mode,

i.e. when making

figures from scripts, interactive mode can be slow since it redraws

the figure with each command. So you may want to think carefully

before making this the default behavior via the <code class="file docutils literal notranslate"><span class="pre">matplotlibrc</span></code>

file instead of using the functions listed in the next section.</p>

<p>Gui shells are at best problematic, because they have to run a

mainloop, but interactive plotting also involves a mainloop. Ipython

has sorted all this out for the primary matplotlib backends. There

may be other shells and IDEs that also work with matplotlib in interactive

mode, but one obvious candidate does not:

the python IDLE IDE is a Tkinter gui app that does

not support pylab interactive mode, regardless of backend.</p>

</div>

<span id="controlling-interactive"></span><h2>Controlling interactive updating<a class="headerlink" href="#controlling-interactive-updating" title="Permalink to this headline">¶</a></h2>

<p>The <em>interactive</em> property of the pyplot interface controls whether a

figure canvas is drawn on every pyplot command. If <em>interactive</em> is

<em>False</em>, then the figure state is updated on every plot command, but

will only be drawn on explicit calls to

<a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.draw.html#matplotlib.pyplot.draw" title="matplotlib.pyplot.draw"><code class="xref py py-func docutils literal notranslate"><span class="pre">draw()</span></code></a>. When <em>interactive</em> is

<em>True</em>, then every pyplot command triggers a draw.</p>

<p>The pyplot interface provides 4 commands that are useful for

interactive control.</p>

<dt><a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.isinteractive.html#matplotlib.pyplot.isinteractive" title="matplotlib.pyplot.isinteractive"><code class="xref py py-func docutils literal notranslate"><span class="pre">isinteractive()</span></code></a></dt>

<dd>returns the interactive setting <em>True|False</em></dd>

<dd>turns interactive mode on</dd>

<dd>turns interactive mode off</dd>

<dd>forces a figure redraw</dd>

</dl>

<p>When working with a big figure in which drawing is expensive, you may

want to turn matplotlib's interactive setting off temporarily to avoid

the performance hit:</p>

<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="c1">#create big-expensive-figure</span>

<span class="gp">>>> </span><span class="n">ioff</span><span class="p">()</span> <span class="c1"># turn updates off</span>

<span class="gp">>>> </span><span class="n">title</span><span class="p">(</span><span class="s1">'now how much would you pay?'</span><span class="p">)</span>

<span class="gp">>>> </span><span class="n">xticklabels</span><span class="p">(</span><span class="n">fontsize</span><span class="o">=</span><span class="mi">20</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s1">'green'</span><span class="p">)</span>

<span class="gp">>>> </span><span class="n">draw</span><span class="p">()</span> <span class="c1"># force a draw</span>

<span class="gp">>>> </span><span class="n">savefig</span><span class="p">(</span><span class="s1">'alldone'</span><span class="p">,</span> <span class="n">dpi</span><span class="o">=</span><span class="mi">300</span><span class="p">)</span>

<span class="gp">>>> </span><span class="n">close</span><span class="p">()</span>

<span class="gp">>>> </span><span class="n">ion</span><span class="p">()</span> <span class="c1"># turn updating back on</span>

</pre></div>

</div>

</div>

<br />

Last updated on Feb 28, 2019.

Created using

<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.4.

Doc version v2.2.4-2-g38a93e9a0-dirty.

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

shell.html

Latest commit

History

shell.html

File metadata and controls