-
Notifications
You must be signed in to change notification settings - Fork 59
Expand file tree
/
Copy pathosx_framework.html
More file actions
312 lines (285 loc) · 18 KB
/
osx_framework.html
File metadata and controls
312 lines (285 loc) · 18 KB
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
99
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
305
306
307
308
309
310
311
312
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Working with Matplotlib on OSX — Matplotlib 2.2.5 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.2.5',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.2.5 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.2.5 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib FAQ" href="index.html" />
<link rel="next" title="Toolkits" href="../api/toolkits/index.html" />
<link rel="prev" title="Working with Matplotlib in Virtual environments" href="virtualenv_faq.html" />
<link rel="canonical" href="https://matplotlib.org/3.1.0/faq/osx_framework.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.2.5). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html">
<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px"><span style="float: right; color: #789; background: white">Version 2.2.5</span></div>
<img src="../_static/logo2.png" height="125px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../api/toolkits/index.html" title="Toolkits"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="virtualenv_faq.html" title="Working with Matplotlib in Virtual environments"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</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="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib FAQ</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<h3><a href="../contents.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Working with Matplotlib on OSX</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#short-version">Short version</a><ul>
<li><a class="reference internal" href="#virtualenv">VirtualEnv</a></li>
<li><a class="reference internal" href="#pyenv">Pyenv</a></li>
<li><a class="reference internal" href="#conda">Conda</a></li>
</ul>
</li>
<li><a class="reference internal" href="#long-version">Long version</a><ul>
<li><a class="reference internal" href="#pythonhome-function"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Function</a><ul>
<li><a class="reference internal" href="#pythonhome-and-jupyter"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> and Jupyter</a></li>
<li><a class="reference internal" href="#pythonhome-script"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Script</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pythonw-compiler">PythonW Compiler</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib FAQ</a><ul>
<li>Previous: <a href="virtualenv_faq.html" title="previous chapter">Working with Matplotlib in Virtual environments</a></li>
<li>Next: <a href="../api/toolkits/index.html" title="next chapter">Toolkits</a></li>
</ul></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/faq/osx_framework.rst.txt"
style="color: #c0c0c0" rel="nofollow">Show Page Source</a>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="working-with-matplotlib-on-osx">
<span id="osxframework-faq"></span><h1>Working with Matplotlib on OSX<a class="headerlink" href="#working-with-matplotlib-on-osx" title="Permalink to this headline">¶</a></h1>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#working-with-matplotlib-on-osx" id="id2">Working with Matplotlib on OSX</a><ul>
<li><a class="reference internal" href="#introduction" id="id3">Introduction</a></li>
<li><a class="reference internal" href="#short-version" id="id4">Short version</a><ul>
<li><a class="reference internal" href="#virtualenv" id="id5">VirtualEnv</a></li>
<li><a class="reference internal" href="#pyenv" id="id6">Pyenv</a></li>
<li><a class="reference internal" href="#conda" id="id7">Conda</a></li>
</ul>
</li>
<li><a class="reference internal" href="#long-version" id="id8">Long version</a><ul>
<li><a class="reference internal" href="#pythonhome-function" id="id9"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Function</a><ul>
<li><a class="reference internal" href="#pythonhome-and-jupyter" id="id10"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> and Jupyter</a></li>
<li><a class="reference internal" href="#pythonhome-script" id="id11"><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Script</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pythonw-compiler" id="id12">PythonW Compiler</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction">
<span id="osxframework-introduction"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>On OSX, two different types of Python builds exist: a regular build and a
framework build. In order to interact correctly with OSX through the native
GUI frameworks you need a framework build of Python. At the time of writing
the <code class="docutils literal notranslate"><span class="pre">macosx</span></code> and <code class="docutils literal notranslate"><span class="pre">WXAgg</span></code> backends require a framework build to function
correctly. This can result in issues for a Python installation not build as a
framework and may also happen in virtual envs and when using (Ana)Conda. From
Matplotlib 1.5 onwards, both backends check that a framework build is available
and fail if a non framework build is found.</p>
<p>Without this check a partially functional figure is created.
Among the issues with it is that it is produced in the background and
cannot be put in front of any other window. Several solutions and work
arounds exist see below.</p>
</div>
<div class="section" id="short-version">
<h2>Short version<a class="headerlink" href="#short-version" title="Permalink to this headline">¶</a></h2>
<div class="section" id="virtualenv">
<h3>VirtualEnv<a class="headerlink" href="#virtualenv" title="Permalink to this headline">¶</a></h3>
<p>If you are on Python 3, use
<a class="reference external" href="https://docs.python.org/3/library/venv.html">venv</a>
instead of <a class="reference external" href="https://virtualenv.pypa.io/en/latest/">virtualenv</a>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python -m venv my-virtualenv
<span class="nb">source</span> my-virtualenv/bin/activate
</pre></div>
</div>
<p>Otherwise you will need one of the workarounds below.</p>
</div>
<div class="section" id="pyenv">
<h3>Pyenv<a class="headerlink" href="#pyenv" title="Permalink to this headline">¶</a></h3>
<p>If you are using pyenv and virtualenv you can enable your python version to be installed as a framework:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">PYTHON_CONFIGURE_OPTS</span><span class="o">=</span><span class="s2">"--enable-framework"</span> pyenv install x.x.x
</pre></div>
</div>
</div>
<div class="section" id="conda">
<h3>Conda<a class="headerlink" href="#conda" title="Permalink to this headline">¶</a></h3>
<p>The default python provided in (Ana)Conda is not a framework
build. However, the Conda developers have made it easy to install
a framework build in both the main environment and in Conda envs.
To use this install python.app <code class="docutils literal notranslate"><span class="pre">conda</span> <span class="pre">install</span> <span class="pre">python.app</span></code> and
use <code class="docutils literal notranslate"><span class="pre">pythonw</span></code> rather than <code class="docutils literal notranslate"><span class="pre">python</span></code></p>
</div>
</div>
<div class="section" id="long-version">
<h2>Long version<a class="headerlink" href="#long-version" title="Permalink to this headline">¶</a></h2>
<p>Unfortunately virtualenv creates a non
framework build even if created from a framework build of Python.
As documented above you can use venv as an alternative on Python 3.</p>
<p>The issue has been reported on the virtualenv bug tracker <a class="reference external" href="https://github.com/pypa/virtualenv/issues/54">here</a> and <a class="reference external" href="https://github.com/pypa/virtualenv/issues/609">here</a></p>
<p>Until this is fixed, one of the following workarounds can be used:</p>
<div class="section" id="pythonhome-function">
<h3><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Function<a class="headerlink" href="#pythonhome-function" title="Permalink to this headline">¶</a></h3>
<p>The best known work around is to use the non
virtualenv python along with the PYTHONHOME environment variable.
This can be done by defining a function in your <code class="docutils literal notranslate"><span class="pre">.bashrc</span></code> using</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="k">function</span> frameworkpython <span class="o">{</span>
<span class="k">if</span> <span class="o">[[</span> ! -z <span class="s2">"</span><span class="nv">$VIRTUAL_ENV</span><span class="s2">"</span> <span class="o">]]</span><span class="p">;</span> <span class="k">then</span>
<span class="nv">PYTHONHOME</span><span class="o">=</span><span class="nv">$VIRTUAL_ENV</span> /usr/local/bin/python <span class="s2">"</span><span class="nv">$@</span><span class="s2">"</span>
<span class="k">else</span>
/usr/local/bin/python <span class="s2">"</span><span class="nv">$@</span><span class="s2">"</span>
<span class="k">fi</span>
<span class="o">}</span>
</pre></div>
</div>
<p>This function can then be used in all of your virtualenvs without having to
fix every single one of them.</p>
<p>With this in place you can run <code class="docutils literal notranslate"><span class="pre">frameworkpython</span></code> to get an interactive
framework build within the virtualenv. To run a script you can do
<code class="docutils literal notranslate"><span class="pre">frameworkpython</span> <span class="pre">test.py</span></code> where <code class="docutils literal notranslate"><span class="pre">test.py</span></code> is a script that requires a
framework build. To run an interactive <code class="docutils literal notranslate"><span class="pre">IPython</span></code> session with the framework
build within the virtual environment you can do <code class="docutils literal notranslate"><span class="pre">frameworkpython</span> <span class="pre">-m</span> <span class="pre">IPython</span></code></p>
<div class="section" id="pythonhome-and-jupyter">
<h4><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> and Jupyter<a class="headerlink" href="#pythonhome-and-jupyter" title="Permalink to this headline">¶</a></h4>
<p>This approach can be followed even if using <a class="reference external" href="https://jupyter.org/">Jupyter</a>
notebooks: you just need to setup a kernel with the suitable <code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code>
definition. The <a class="reference external" href="https://github.com/mapio/jupyter-virtualenv-osx">jupyter-virtualenv-osx</a>
script automates the creation of such a kernel.</p>
</div>
<div class="section" id="pythonhome-script">
<h4><code class="docutils literal notranslate"><span class="pre">PYTHONHOME</span></code> Script<a class="headerlink" href="#pythonhome-script" title="Permalink to this headline">¶</a></h4>
<p>An alternative work around borrowed from the <a class="reference external" href="https://wiki.wxpython.org/wxPythonVirtualenvOnMac">WX wiki</a>, is to use the non
virtualenv python along with the PYTHONHOME environment variable. This can be
implemented in a script as below. To use this modify <code class="docutils literal notranslate"><span class="pre">PYVER</span></code> and
<code class="docutils literal notranslate"><span class="pre">PATHTOPYTHON</span></code> and put the script in the virtualenv bin directory i.e.
<code class="docutils literal notranslate"><span class="pre">PATHTOVENV/bin/frameworkpython</span></code></p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
<span class="c1"># what real Python executable to use</span>
<span class="nv">PYVER</span><span class="o">=</span><span class="m">2</span>.7
<span class="nv">PATHTOPYTHON</span><span class="o">=</span>/usr/local/bin/
<span class="nv">PYTHON</span><span class="o">=</span><span class="si">${</span><span class="nv">PATHTOPYTHON</span><span class="si">}</span>python<span class="si">${</span><span class="nv">PYVER</span><span class="si">}</span>
<span class="c1"># find the root of the virtualenv, it should be the parent of the dir this script is in</span>
<span class="nv">ENV</span><span class="o">=</span><span class="sb">`</span><span class="nv">$PYTHON</span> -c <span class="s2">"import os; print(os.path.abspath(os.path.join(os.path.dirname(\"</span><span class="nv">$0</span><span class="s2">\"), '..')))"</span><span class="sb">`</span>
<span class="c1"># now run Python with the virtualenv set as Python's HOME</span>
<span class="nb">export</span> <span class="nv">PYTHONHOME</span><span class="o">=</span><span class="nv">$ENV</span>
<span class="nb">exec</span> <span class="nv">$PYTHON</span> <span class="s2">"</span><span class="nv">$@</span><span class="s2">"</span>
</pre></div>
</div>
<p>With this in place you can run <code class="docutils literal notranslate"><span class="pre">frameworkpython</span></code> as above but will need to add this script
to every virtualenv</p>
</div>
</div>
<div class="section" id="pythonw-compiler">
<h3>PythonW Compiler<a class="headerlink" href="#pythonw-compiler" title="Permalink to this headline">¶</a></h3>
<p>In addition
<a class="reference external" href="https://github.com/gldnspud/virtualenv-pythonw-osx">virtualenv-pythonw-osx</a>
provides an alternative workaround which may be used to solve the issue.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2018 The Matplotlib development team.
<br />
Last updated on Feb 09, 2020.
Created using
<ahref="http://sphinx-doc.org/">Sphinx</a> 1.8.5.
Doc version v2.2.5-2-ga847ffac5.
</div>
</body>
<footer>
</footer>
</html>