-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathPython-module.html
481 lines (442 loc) · 20.2 KB
/
Python-module.html
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Python module</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/prism-keep-markup.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/favicon.png">
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/meson_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Modules <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="CMake-module.html">CMake</a>
</li>
<li>
<a href="Cuda-module.html">CUDA</a>
</li>
<li>
<a href="Dlang-module.html">Dlang</a>
</li>
<li>
<a href="External-Project-module.html">External Project</a>
</li>
<li>
<a href="Fs-module.html">Filesystem</a>
</li>
<li>
<a href="Gnome-module.html">GNOME</a>
</li>
<li>
<a href="Hotdoc-module.html">Hotdoc</a>
</li>
<li>
<a href="i18n-module.html">i18n</a>
</li>
<li>
<a href="Icestorm-module.html">Icestorm</a>
</li>
<li>
<a href="Java-module.html">Java</a>
</li>
<li>
<a href="Keyval-module.html">Keyval</a>
</li>
<li>
<a href="Pkgconfig-module.html">Pkgconfig</a>
</li>
<li>
<a href="Python-3-module.html">Python 3</a>
</li>
<li>
<a href="Python-module.html">Python</a>
</li>
<li>
<a href="Qt4-module.html">Qt4</a>
</li>
<li>
<a href="Qt5-module.html">Qt5</a>
</li>
<li>
<a href="Qt6-module.html">Qt6</a>
</li>
<li>
<a href="Rust-module.html">Rust</a>
</li>
<li>
<a href="Simd-module.html">Simd</a>
</li>
<li>
<a href="SourceSet-module.html">SourceSet</a>
</li>
<li>
<a href="Wayland-module.html">Wayland</a>
</li>
<li>
<a href="Windows-module.html">Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Quick References <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="quick-refs-menu">
<li>
<a href="Reference-manual.html">Functions</a>
</li>
<li>
<a href="Build-options.html">Options</a>
</li>
<li>
<a href="Configuration.html">Configuration</a>
</li>
<li>
<a href="Dependencies.html">Dependencies</a>
</li>
<li>
<a href="Unit-tests.html">Tests</a>
</li>
<li>
<a href="Syntax.html">Syntax</a>
</li>
</ul>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Meson Build System</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Meson-documentation" data-hotdoc-ref="Python-module.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="python-module">Python module</h1>
<p>This module provides support for finding and building extensions against
python installations, be they python 2 or 3.</p>
<p>If you want to build and package Python extension modules using tools
compatible with <a href="https://peps.python.org/pep-0517/">PEP-517</a>, check out
<a href="https://mesonbuild.com/meson-python/index.html">meson-python</a>.</p>
<p>If you are building Python extension modules against a Python interpreter
located in a venv or Conda environment, you probably want to set
<code>python.install_env=auto</code>;
see <a href="Builtin-options.html#python-module">Python module options</a> for details.</p>
<p><em>Added 0.46.0</em></p>
<h2 id="functions">Functions</h2>
<h3 id="find_installation"><code>find_installation()</code></h3>
<pre><code class="language-meson">pymod.find_installation(name_or_path, ...)
</code></pre>
<p>Find a python installation matching <code>name_or_path</code>.</p>
<p>That argument is optional, if not provided then the returned python
installation will be the one used to run Meson.</p>
<p>If provided, it can be:</p>
<ul>
<li>
<p>A simple name, eg <code>python-2.7</code>, Meson will look for an external program
named that way, using <a href="Reference-manual_functions.html#find_program"><ins><code>find_program()</code></ins></a></p>
</li>
<li>
<p>A path, eg <code>/usr/local/bin/python3.4m</code></p>
</li>
<li>
<p>One of <code>python2</code> or <code>python3</code>: in either case, the module will try
some alternative names: <code>py -2</code> or <code>py -3</code> on Windows, and <code>python</code>
everywhere. In the latter case, it will check whether the version
provided by the sysconfig module matches the required major version.</p>
<p><em>Since 1.2.0</em>, searching for minor version (e.g. <code>python3.11</code>) also
works on Windows.</p>
</li>
</ul>
<p>Keyword arguments are the following:</p>
<ul>
<li>
<code>required</code>: by default, <code>required</code> is set to <code>true</code> and Meson will
abort if no python installation can be found. If <code>required</code> is set to <code>false</code>,
Meson will continue even if no python installation was found. You can
then use the <code>.found()</code> method on the returned object to check
whether it was found or not. Since <em>0.48.0</em> the value of a
<a href="Build-options.html#features"><code>feature</code></a> option can also be passed to the
<code>required</code> keyword argument.</li>
<li>
<code>disabler</code>: if <code>true</code> and no python installation can be found, return a
<a href="Reference-manual_returned_disabler.html"><ins><code>disabler</code></ins></a> object instead of a not-found object.
<em>Since 0.49.0</em>
</li>
<li>
<code>modules</code>: a list of module names that this python installation must have.
<em>Since 0.51.0</em>
</li>
<li>
<code>pure</code>: On some platforms, architecture independent files are
expected to be placed in a separate directory. However, if the
python sources should be installed alongside an extension module
built with this module, this keyword argument can be used to
override the default behavior of <code>.install_sources()</code>.
<em>since 0.64.0</em>
</li>
</ul>
<p><strong>Returns</strong>: a <a href="Python-module.html#python_installation-object">python installation</a></p>
<h2 id="python_installation-object">
<code>python_installation</code> object</h2>
<p>The <code>python_installation</code> object is an <a href="Reference-manual_returned_external_program.html"><ins><code>external_program</code></ins></a>, with several
added methods.</p>
<h3 id="methods">Methods</h3>
<h4 id="path"><code>path()</code></h4>
<pre><code class="language-meson">str py_installation.path()
</code></pre>
<p><em>Added 0.50.0</em></p>
<p>Works like the path method of other <code>ExternalProgram</code> objects. Was not
provided prior to 0.50.0 due to a bug.</p>
<h4 id="extension_module"><code>extension_module()</code></h4>
<pre><code class="language-meson">shared_module py_installation.extension_module(module_name, list_of_sources, ...)
</code></pre>
<p>Create a <a href="Reference-manual_functions.html#shared_module"><ins><code>shared_module()</code></ins></a> target that is named according to the naming
conventions of the target platform.</p>
<p>All positional and keyword arguments are the same as for
<a href="Reference-manual_functions.html#shared_module"><ins><code>shared_module()</code></ins></a>, excluding <code>name_suffix</code> and <code>name_prefix</code>, and with
the addition of the following:</p>
<ul>
<li>
<code>subdir</code>: By default, Meson will install the extension module in
the relevant top-level location for the python installation, eg
<code>/usr/lib/site-packages</code>. When subdir is passed to this method,
it will be appended to that location. This keyword argument is
mutually exclusive with <code>install_dir</code>
</li>
<li>
<code>limited_api</code>: <em>since 1.3.0</em> A string containing the Python version
of the <a href="https://docs.python.org/3/c-api/stable.html">Py_LIMITED_API</a> that
the extension targets. For example, '3.7' to target Python 3.7's version of
the limited API. This behavior can be disabled by setting the value of
<code>python.allow_limited_api</code>. See <a href="Builtin-options.html#python-module">Python module options</a>.</li>
</ul>
<p>Additionally, the following diverge from <a href="Reference-manual_functions.html#shared_module"><ins><code>shared_module()</code></ins></a>'s default behavior:</p>
<ul>
<li>
<code>gnu_symbol_visibility</code>: if unset, it will default to <code>'hidden'</code> on versions
of Python that support this (the python headers define <code>PyMODINIT_FUNC</code> has
default visibility).</li>
</ul>
<p>Note that Cython support uses <code>extension_module</code>, see <a href="Cython.html">the reference for Cython</a>.</p>
<p><em>since 0.63.0</em> <code>extension_module</code> automatically adds a dependency to the library
if one is not explicitly provided. To support older versions, the user may need to
add <code>dependencies : py_installation.dependency()</code>, see <a href="Reference-manual_functions.html#dependency"><ins><code>dependency()</code></ins></a>.</p>
<p><strong>Returns</strong>: a <a href="Reference-manual_returned_build_tgt.html"><ins><code>build_tgt</code></ins></a> object</p>
<h4 id="dependency"><code>dependency()</code></h4>
<pre><code class="language-meson">python_dependency py_installation.dependency(...)
</code></pre>
<p><em>since 0.53.0</em></p>
<p>This method accepts no positional arguments, and the same keyword
arguments as the standard <a href="Reference-manual_functions.html#dependency"><ins><code>dependency()</code></ins></a> function. It also supports the
following keyword argument:</p>
<ul>
<li>
<code>embed</code>: <em>(since 0.53.0)</em> If true, Meson will try to find a python
dependency that can be used for embedding python into an
application.</li>
<li>
<code>disabler</code> <em>(since 0.60.0)</em>: if <code>true</code> and the dependency couldn't be found,
returns a <a href="Python-module.html#disabler-object">disabler object</a> instead of a not-found dependency.</li>
</ul>
<p><strong>Returns</strong>: a <a href="Python-module.html#python_dependency-object">python dependency</a></p>
<h4 id="install_sources"><code>install_sources()</code></h4>
<pre><code class="language-meson">void py_installation.install_sources(list_of_files, ...)
</code></pre>
<p>Install actual python sources (<code>.py</code>).</p>
<p>Source files to install are given as positional argument, in the same way as for
<a href="Reference-manual_functions.html#install_data"><ins><code>install_data()</code></ins></a>. Supported keyword arguments are:</p>
<ul>
<li>
<p><code>pure</code>: On some platforms, architecture independent files are
expected to be placed in a separate directory. However, if the
python sources should be installed alongside an extension module
built with this module, this keyword argument can be used to
override that behaviour. Defaults to the value specified in
<code>find_installation()</code>, or else <code>true</code></p>
</li>
<li>
<p><code>subdir</code>: See documentation for the argument of the same name to
<a href="Python-module.html#extension_module">extension_module()</a></p>
</li>
<li>
<p><code>install_tag</code> <em>(since 0.60.0)</em>: A string used by <code>meson install --tags</code> command
to install only a subset of the files. By default it has the tag <code>python-runtime</code>.</p>
</li>
<li>
<p><code>preserve_path</code>: if <code>true</code>, disable stripping child-directories from data
files when installing. Default is <code>false</code>. <em>(since 0.64.0)</em></p>
</li>
</ul>
<p><em>Since 0.60.0</em> <code>python.platlibdir</code> and <code>python.purelibdir</code> options can be used
to control the default installation path. See <a href="Builtin-options.html#python-module">Python module options</a>.</p>
<h4 id="get_install_dir"><code>get_install_dir()</code></h4>
<pre><code class="language-meson">string py_installation.get_install_dir(...)
</code></pre>
<p>Retrieve the directory <a href="Python-module.html#install_sources">install_sources()</a> will install to.</p>
<p>It can be useful in cases where <code>install_sources</code> cannot be used
directly, for example when using <a href="Reference-manual_functions.html#configure_file"><ins><code>configure_file()</code></ins></a>.</p>
<p>This function accepts no arguments, its keyword arguments are the same
as <a href="Python-module.html#install_sources">install_sources()</a>.</p>
<p><em>Since 0.60.0</em> <code>python.platlibdir</code> and <code>python.purelibdir</code> options can be used
to control the default installation path. See <a href="Builtin-options.html#python-module">Python module options</a>.</p>
<p><strong>Returns</strong>: A string</p>
<h4 id="language_version"><code>language_version()</code></h4>
<pre><code class="language-meson">string py_installation.language_version()
</code></pre>
<p>Get the major.minor python version, eg <code>2.7</code>.</p>
<p>The version is obtained through the <code>sysconfig</code> module.</p>
<p>This function expects no arguments or keyword arguments.</p>
<p><strong>Returns</strong>: A string</p>
<h4 id="get_path"><code>get_path()</code></h4>
<pre><code class="language-meson">string py_installation.get_path(path_name, fallback)
</code></pre>
<p>Get a path as defined by the <code>sysconfig</code> module.</p>
<p>For example:</p>
<pre><code class="language-meson">purelib = py_installation.get_path('purelib')
</code></pre>
<p>This function requires at least one argument, <code>path_name</code>,
which is expected to be a non-empty string.</p>
<p>If <code>fallback</code> is specified, it will be returned if no path
with the given name exists. Otherwise, attempting to read
a non-existing path will cause a fatal error.</p>
<p><strong>Returns</strong>: A string</p>
<h4 id="has_path"><code>has_path()</code></h4>
<pre><code class="language-meson"> bool py_installation.has_path(path_name)
</code></pre>
<p><strong>Returns</strong>: true if a path named <code>path_name</code> can be retrieved with
<a href="Python-module.html#get_path">get_path()</a>, false otherwise.</p>
<h4 id="get_variable"><code>get_variable()</code></h4>
<pre><code class="language-meson">string py_installation.get_variable(variable_name, fallback)
</code></pre>
<p>Get a variable as defined by the <code>sysconfig</code> module.</p>
<p>For example:</p>
<pre><code class="language-meson">py_bindir = py_installation.get_variable('BINDIR', '')
</code></pre>
<p>This function requires at least one argument, <code>variable_name</code>,
which is expected to be a non-empty string.</p>
<p>If <code>fallback</code> is specified, it will be returned if no variable
with the given name exists. Otherwise, attempting to read
a non-existing variable will cause a fatal error.</p>
<p><strong>Returns</strong>: A string</p>
<h4 id="has_variable"><code>has_variable()</code></h4>
<pre><code class="language-meson"> bool py_installation.has_variable(variable_name)
</code></pre>
<p><strong>Returns</strong>: true if a variable named <code>variable_name</code> can be retrieved
with <a href="Python-module.html#get_variable">get_variable()</a>, false otherwise.</p>
<h2 id="python_dependency-object">
<code>python_dependency</code> object</h2>
<p>This <a href="Reference-manual_returned_dep.html"><ins><code>dep</code></ins></a> object subclass will try various methods to obtain
the compiler and linker arguments, starting with pkg-config then
potentially using information obtained from python's <code>sysconfig</code>
module.</p>
<p>It exposes the same methods as its parent class.</p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
<hr>
<div class="license-description">
Website licensing information are available on the <a href="legal.html">Legal</a> page.
</div>
<div class="copyrights-description">
<p>
Authored by
Mathieu Duponchelle (<a href="mailto:[email protected]">[email protected]</a>)
</p>
</div>
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://github.com/mesonbuild/meson/edit/master/docs/markdown/Python-module.md" data-hotdoc-role="edit-button">Edit on GitHub</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>