source: general/prog/python3.xml@ 5d0e7b8

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since 5d0e7b8 was 5d0e7b8, checked in by Douglas R. Reno <renodr@…>, 3 months ago

A bunch of tags

  • Property mode set to 100644
File size: 13.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY python3-download-http
8 "https://www.python.org/ftp/python/&python3-version;/Python-&python3-version;.tar.xz">
9 <!ENTITY python3-download-ftp " ">
10 <!ENTITY python3-md5sum "e7c178b97bf8f7ccd677b94d614f7b3c">
11 <!ENTITY python3-size "20 MB">
12 <!ENTITY python3-buildsize "337 MB (add 57 MB for tests)">
13 <!ENTITY python3-time "2.5 SBU (add 0.7 SBU for tests; both using parallelism=4)">
14 <!--
15 Note: Size does not reflect docs that were installed in LFS.
16 -->
17 <!ENTITY python3htmldoc-download-http
18 "https://www.python.org/ftp/python/doc/&python3-version;/python-&python3-version;-docs-html.tar.bz2">
19 <!ENTITY python3-docs-md5sum "8a6310f6288e7f60c3565277ec3b5279" >
20]>
21
22<sect1 id="python3" xreflabel="Python-&python3-version;">
23 <?dbhtml filename="python3.html" ?>
24
25
26 <title>Python-&python3-version;</title>
27
28 <indexterm zone="python3">
29 <primary sortas="a-Python3">Python3</primary>
30 </indexterm>
31
32 <sect2 role="package">
33 <title>Introduction to Python 3</title>
34
35 <para>
36 The <application>Python 3</application> package contains the
37 <application>Python</application> development environment.
38 This is useful for object-oriented programming, writing scripts,
39 prototyping large programs or developing entire applications.
40 </para>
41
42 <note>
43 <para>
44 <application>Python 3</application> was installed in LFS.
45 The only reason to rebuild it here is if optional modules
46 are needed, or to upgrade this package.
47 </para>
48 </note>
49
50 &lfs121_checked;
51
52 <important>
53 <para>
54 If upgrading to a new Python-3 minor version (for example,
55 from Python-3.11.x to Python-3.12.0), you will need to reinstall
56 any Python3 modules you have installed. You should also
57 reinstall packages that generate Python3 modules
58 including
59 <xref linkend="gobject-introspection"/>,
60 <xref linkend="libxml2"/>,
61 <xref linkend="opencv"/>,
62 <xref linkend="graphviz"/> (if swig is installed).
63 </para>
64
65 <para>Before you upgrade, you can get a list of modules installed
66 with <command>pip3 list</command>. The list may be incomplete as
67 some Python modules are not installed with <command>pip3</command>,
68 for example the <literal>cracklib</literal> module installed by
69 <xref role='nodep' linkend='cracklib'/>. Use <command>ls
70 /usr/lib/python3.<replaceable>minor</replaceable>/site-packages</command>
71 for a comprehensive list.
72 </para>
73
74 <para>
75 The Python modules from LFS will also have to be reinstalled:
76 <ulink url="&lfs-root;/chapter08/flit-core.html">flit-core</ulink>,
77 <ulink url="&lfs-root;/chapter08/wheel.html">wheel</ulink>,
78 <ulink url="&lfs-root;/chapter08/setuptools.html">setuptools</ulink>,
79 <ulink url="&lfs-root;/chapter08/meson.html">meson</ulink>,
80 <ulink url="&lfs-root;/chapter08/markupsafe.html">MarkupSafe</ulink>,
81 and <ulink url="&lfs-root;/chapter08/jinja2.html">Jinja2</ulink>.
82 </para>
83 </important>
84
85 <bridgehead renderas="sect3">Package Information</bridgehead>
86 <itemizedlist spacing="compact">
87 <listitem>
88 <para>
89 Download (HTTP): <ulink url="&python3-download-http;"/>
90 </para>
91 </listitem>
92 <listitem>
93 <para>
94 Download (FTP): <ulink url="&python3-download-ftp;"/>
95 </para>
96 </listitem>
97 <listitem>
98 <para>
99 Download MD5 sum: &python3-md5sum;
100 </para>
101 </listitem>
102 <listitem>
103 <para>
104 Download size: &python3-size;
105 </para>
106 </listitem>
107 <listitem>
108 <para>
109 Estimated disk space required: &python3-buildsize;
110 </para>
111 </listitem>
112 <listitem>
113 <para>
114 Estimated build time: &python3-time;
115 </para>
116 </listitem>
117 </itemizedlist>
118
119 <bridgehead renderas="sect3">Additional Optional Download</bridgehead>
120 <itemizedlist spacing="compact">
121 <listitem>
122 <para>
123 Download (HTTP): <ulink url="&python3htmldoc-download-http;"/>
124 </para>
125 </listitem>
126 <listitem>
127 <para>
128 Download MD5 sum: &python3-docs-md5sum;
129 </para>
130 </listitem>
131 </itemizedlist>
132
133 <bridgehead renderas="sect3">Python 3 Dependencies</bridgehead>
134
135 <bridgehead renderas="sect4">Recommended</bridgehead>
136 <para role="recommended">
137 <xref linkend="sqlite"/> (required if building firefox or thunderbird)
138 </para>
139
140 <bridgehead renderas="sect4">Optional</bridgehead>
141 <para role="optional">
142 <xref linkend="bluez"/>,
143 <xref linkend="gdb"/> (required for some tests),
144 <xref linkend="valgrind"/>, and
145 <ulink url="https://www.bytereef.org/mpdecimal/">libmpdec</ulink>
146 </para>
147
148 <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
149 <para role="optional">
150 <xref linkend="libnsl"/>,
151 <xref linkend="tk"/>, and
152 &berkeley-db;
153 </para>
154
155 <para condition="html" role="usernotes">Editor Notes:
156 <ulink url="&blfs-wiki;/Python3"/>
157 </para>
158 </sect2>
159
160 <sect2 role="installation">
161 <title>Installation of Python 3</title>
162
163 <para>
164 Install <application>Python 3</application> by running the following
165 commands:
166 </para>
167
168<screen><userinput>CXX="/usr/bin/g++" \
169./configure --prefix=/usr \
170 --enable-shared \
171 --with-system-expat \
172 --enable-optimizations &amp;&amp;
173make</userinput></screen>
174
175 <para>
176 <!-- I'm getting a test failure with empty $LANG:
177 "test test_curses failed"
178 "_curses.error: inswstr() returned ERR"
179 not sure why, but let's just work around it with LC_ALL.
180
181 For Python-3.12.0 all tests pass with only LANG=en_US.utf8.
182 Total tests: run=41,505 skipped=1,199
183 Total test files: run=477/483 skipped=12 resource_denied=6
184
185 For Python-3.12.1 all tests pass
186 Total tests: run=40,624 skipped=1,136
187 Total test files: run=486/489 skipped=24 resource_denied=3
188
189 For Python-3.12.3 all tests pass
190 Total tests: run=41,580 skipped=1,144
191 Total test files: run=485/488 skipped=23 resource_denied=3
192 -->
193 To test the result, issue <command>LC_ALL=en_US.UTF-8
194 make test</command>.
195 Some tests may need an Internet connection.
196 </para>
197
198 <para>
199 Now, as the <systemitem class="username">root</systemitem> user:
200 </para>
201
202<screen role="root"><userinput>make install</userinput></screen>
203
204 <para>
205 If upgrading and the documentation has been downloaded, optionally install
206 it as the &root; user:
207 </para>
208
209<screen role="root"><userinput>install -v -dm755 /usr/share/doc/python-&python3-version;/html
210
211tar --strip-components=1 \
212 --no-same-owner \
213 --no-same-permissions \
214 -C /usr/share/doc/python-&python3-version;/html \
215 -xvf ../python-&python3-version;-docs-html.tar.bz2</userinput></screen>
216
217 </sect2>
218
219 <sect2 role="commands">
220 <title>Command Explanations</title>
221
222 <para>
223 <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
224 message during configuration.
225 </para>
226
227 <para>
228 <parameter>--with-system-expat</parameter>: This switch enables linking
229 against the system version of <application>Expat</application>.
230 </para>
231
232<!--
233 <para>
234 <parameter>- -with-ensurepip=yes</parameter> : This switch enables building
235 the <command>pip</command> and <command>setuptools</command> packaging
236 programs. <command>setuptools</command> is needed for building some
237 Python modules.
238 </para>
239-->
240 <para>
241 <option>--with-dbmliborder=bdb:gdbm:ndbm</option>: Use this switch
242 if you want to build the <application>Python</application> DBM Module
243 against <application>Berkeley DB</application> instead of
244 <application>GDBM</application>.
245 </para>
246
247 <para>
248 <parameter>--enable-optimizations</parameter>: This switch enables
249 stable, but expensive, optimizations.
250 </para>
251
252 <para>
253 <option>--with-lto</option>: This optional switch enables thick Link
254 Time Optimization. Unusually, it creates a much larger <filename
255 class="libraryfile">/usr/lib/python&python3-majorver;/config-&python3-majorver;-&lt;arch&gt;-linux-gnu/libpython&python3-majorver;.a</filename>
256 with a small increase in the time to compile
257 <application>Python</application>. Run-time results do not appear to show
258 any benefit from doing this.
259 </para>
260
261 </sect2>
262
263 <sect2 role="configuration">
264 <title>Configuring Python 3</title>
265
266 <para>
267 In order for <command>python3</command> to find the installed
268 documentation, create the following version independent symlink:
269 </para>
270
271<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>
272
273 <para>
274 and add the following environment variable to the individual user's or
275 system's profile:
276 </para>
277
278<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>
279
280 </sect2>
281
282 <sect2 role="content">
283 <title>Contents</title>
284
285 <segmentedlist>
286 <segtitle>Installed Programs</segtitle>
287 <segtitle>Installed Libraries</segtitle>
288 <segtitle>Installed Directories</segtitle>
289
290 <seglistitem>
291 <seg>
292 2to3 (symlink) and
293 2to3-&python3-majorver;,
294
295 <!--
296 easy_install-&python3-majorver;,
297 -->
298
299 idle3 (symlink) and
300 idle&python3-majorver;,
301
302 pip3 and
303 pip&python3-majorver;,
304
305 pydoc3 (symlink) and
306 pydoc&python3-majorver;,
307
308 python3 (symlink) and
309 python&python3-majorver;, and
310
311 python3-config (symlink) and
312 python&python3-majorver;-config
313 </seg>
314 <seg>
315 libpython&python3-majorver;.so and libpython3.so
316 </seg>
317 <seg>
318 /usr/include/python&python3-majorver;,
319 /usr/lib/python&python3-majorver;, and
320 /usr/share/doc/python-&python3-version;
321 </seg>
322 </seglistitem>
323 </segmentedlist>
324
325 <variablelist>
326 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
327 <?dbfo list-presentation="list"?>
328 <?dbhtml list-presentation="table"?>
329 <!--
330 <varlistentry id="2to3">
331 <term><command>2to3</command></term>
332 <listitem>
333 <para>
334 is designed to assist in the transition between python2 and python3
335 by automatically converting code to be Python3 compatible.
336 </para>
337 <indexterm zone="python3 2to3">
338 <primary sortas="b-2to3">2to3</primary>
339 </indexterm>
340 </listitem>
341 </varlistentry>
342 Put here for easy use when removing Python2 -->
343 <!--
344 <varlistentry id="easy_install">
345 <term><command>easy_install</command></term>
346 <listitem>
347 <para>
348 is a frontend to pip3 to make it easier to configure python modules
349 through the PIP package manager
350 </para>
351 <indexterm zone="python3 easy_install">
352 <primary sortas="python3 easy_install">easy_install</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356 -->
357 <varlistentry id="idle3">
358 <term><command>idle3</command></term>
359 <listitem>
360 <para>
361 is a wrapper script that opens a <application>Python</application>
362 aware GUI editor. For this script to run, you must have installed
363 <application>Tk</application> before Python so that the Tkinter
364 Python module is built
365 </para>
366 <indexterm zone="python3 idle3">
367 <primary sortas="b-idle3">idle3</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="pydoc3">
373 <term><command>pydoc3</command></term>
374 <listitem>
375 <para>
376 is the <application>Python</application> documentation
377 tool
378 </para>
379 <indexterm zone="python3 pydoc3">
380 <primary sortas="b-pydoc3">pydo3c</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="python3-prog">
386 <term><command>python3</command></term>
387 <listitem>
388 <para>
389 is an interpreted, interactive, object-oriented programming
390 language
391 </para>
392 <indexterm zone="python3 python3-prog">
393 <primary sortas="b-python3">python3</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="python-ver">
399 <term><command>python&python3-majorver;</command></term>
400 <listitem>
401 <para>
402 is a version-specific name for the <command>python</command>
403 program
404 </para>
405 <indexterm zone="python3 python-ver">
406 <primary sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410 <!--
411 <varlistentry id="pyvenv">
412 <term><command>pyvenv</command></term>
413 <listitem>
414 <para>
415 creates virtual <application>Python</application> environments in
416 one or more target directories.
417 </para>
418 <indexterm zone="python3 pyvenv">
419 <primary
420 sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424 -->
425 </variablelist>
426
427 </sect2>
428
429</sect1>
Note: See TracBrowser for help on using the repository browser.