source: general/prog/python3.xml

trunk
Last change on this file was b03c011, checked in by Xi Ruoyao <xry111@…>, 3 days ago

python3: Remove reference to obsolete Berkeley DB

  • Property mode set to 100644
File size: 13.6 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 "8defb33f0c37aa4bdd3a38ba52abde4e">
11 <!ENTITY python3-size "20 MB">
12 <!ENTITY python3-buildsize "335 MB (add 57 MB for tests)">
13 <!ENTITY python3-time "2.2 SBU (add 1.0 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 "6025ee63c0ded34aac874f5da8f1a90c" >
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 &gobject-introspection;,
60 <xref linkend="libxml2"/>,
61 <xref linkend="opencv"/>,
62 <xref linkend="fontforge"/>,
63 <xref linkend="gnome-tweaks"/>,
64 <xref linkend="samba"/>, and
65 <xref linkend="graphviz"/> (if swig is installed).
66 </para>
67
68 <para>Before you upgrade, you can get a list of modules installed
69 with <command>pip3 list</command>. The list may be incomplete as
70 some Python modules are not installed with <command>pip3</command>,
71 for example the <literal>cracklib</literal> module installed by
72 <xref role='nodep' linkend='cracklib'/>. Use <command>ls
73 /usr/lib/python3.<replaceable>minor</replaceable>/site-packages</command>
74 for a comprehensive list.
75 </para>
76
77 <para>
78 The Python modules from LFS will also have to be reinstalled:
79 <ulink url="&lfs-root;/chapter08/flit-core.html">flit-core</ulink>,
80 <ulink url="&lfs-root;/chapter08/wheel.html">wheel</ulink>,
81 <ulink url="&lfs-root;/chapter08/setuptools.html">setuptools</ulink>,
82 <ulink url="&lfs-root;/chapter08/meson.html">meson</ulink>,
83 <ulink url="&lfs-root;/chapter08/markupsafe.html">MarkupSafe</ulink>,
84 and <ulink url="&lfs-root;/chapter08/jinja2.html">Jinja2</ulink>.
85 </para>
86 </important>
87
88 <bridgehead renderas="sect3">Package Information</bridgehead>
89 <itemizedlist spacing="compact">
90 <listitem>
91 <para>
92 Download (HTTP): <ulink url="&python3-download-http;"/>
93 </para>
94 </listitem>
95 <listitem>
96 <para>
97 Download (FTP): <ulink url="&python3-download-ftp;"/>
98 </para>
99 </listitem>
100 <listitem>
101 <para>
102 Download MD5 sum: &python3-md5sum;
103 </para>
104 </listitem>
105 <listitem>
106 <para>
107 Download size: &python3-size;
108 </para>
109 </listitem>
110 <listitem>
111 <para>
112 Estimated disk space required: &python3-buildsize;
113 </para>
114 </listitem>
115 <listitem>
116 <para>
117 Estimated build time: &python3-time;
118 </para>
119 </listitem>
120 </itemizedlist>
121
122 <bridgehead renderas="sect3">Additional Optional Download</bridgehead>
123 <itemizedlist spacing="compact">
124 <listitem>
125 <para>
126 Download (HTTP): <ulink url="&python3htmldoc-download-http;"/>
127 </para>
128 </listitem>
129 <listitem>
130 <para>
131 Download MD5 sum: &python3-docs-md5sum;
132 </para>
133 </listitem>
134 </itemizedlist>
135
136 <bridgehead renderas="sect3">Python 3 Dependencies</bridgehead>
137
138 <bridgehead renderas="sect4">Recommended</bridgehead>
139 <para role="recommended">
140 <xref linkend="sqlite"/> (required if building firefox or thunderbird)
141 </para>
142
143 <bridgehead renderas="sect4">Optional</bridgehead>
144 <para role="optional">
145 <xref linkend="bluez"/>,
146 <xref linkend="gdb"/> (required for some tests),
147 <xref linkend="valgrind"/>, and
148 <ulink url="https://www.bytereef.org/mpdecimal/">libmpdec</ulink>
149 </para>
150
151 <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
152 <para role="optional">
153 <xref linkend="libnsl"/>,
154 <xref linkend="tk"/>, and
155 &berkeley-db;
156 </para>
157
158 <para condition="html" role="usernotes">Editor Notes:
159 <ulink url="&blfs-wiki;/Python3"/>
160 </para>
161 </sect2>
162
163 <sect2 role="installation">
164 <title>Installation of Python 3</title>
165
166 <para>
167 Install <application>Python 3</application> by running the following
168 commands:
169 </para>
170
171<screen><userinput>CXX="/usr/bin/g++" \
172./configure --prefix=/usr \
173 --enable-shared \
174 --with-system-expat \
175 --enable-optimizations &amp;&amp;
176make</userinput></screen>
177
178 <para>
179 Some tests are known to occasionally hang indefinitely. So to test
180 the results, run the test suite but set a 2-minute time limit for each
181 test case:
182 </para>
183
184<screen remap='test'><userinput>make test TESTOPTS="--timeout 120"</userinput></screen>
185
186 <!-- For Python-3.12.3 all tests pass
187 Total tests: run=41,778 skipped=1,155
188 Total test files: run=485/488 skipped=24 resource_denied=3
189 -->
190
191 <para>
192 For a relatively slow system you may need to increase the time
193 limit and 1 SBU (measured when building Binutils pass 1 with one CPU
194 core) should be enough. Some tests are flaky, so the test suite will
195 automatically re-run failed tests. If a test failed but then passed
196 when re-run, it should be considered as passed.
197 </para>
198
199 <para>
200 Now, as the <systemitem class="username">root</systemitem> user:
201 </para>
202
203<screen role="root"><userinput>make install</userinput></screen>
204
205 <para>
206 If upgrading and the documentation has been downloaded, optionally install
207 it as the &root; user:
208 </para>
209
210<screen role="root"><userinput>install -v -dm755 /usr/share/doc/python-&python3-version;/html
211
212tar --strip-components=1 \
213 --no-same-owner \
214 --no-same-permissions \
215 -C /usr/share/doc/python-&python3-version;/html \
216 -xvf ../python-&python3-version;-docs-html.tar.bz2</userinput></screen>
217
218 </sect2>
219
220 <sect2 role="commands">
221 <title>Command Explanations</title>
222
223 <para>
224 <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
225 message during configuration.
226 </para>
227
228 <para>
229 <parameter>--with-system-expat</parameter>: This switch enables linking
230 against the system version of <application>Expat</application>.
231 </para>
232
233<!--
234 <para>
235 <parameter>- -with-ensurepip=yes</parameter> : This switch enables building
236 the <command>pip</command> and <command>setuptools</command> packaging
237 programs. <command>setuptools</command> is needed for building some
238 Python modules.
239 </para>
240-->
241
242 <para>
243 <parameter>--enable-optimizations</parameter>: This switch enables
244 stable, but expensive, optimizations.
245 </para>
246
247 <para>
248 <option>--with-lto</option>: This optional switch enables thick Link
249 Time Optimization. Unusually, it creates a much larger <filename
250 class="libraryfile">/usr/lib/python&python3-majorver;/config-&python3-majorver;-&lt;arch&gt;-linux-gnu/libpython&python3-majorver;.a</filename>
251 with a small increase in the time to compile
252 <application>Python</application>. Run-time results do not appear to show
253 any benefit from doing this.
254 </para>
255
256 </sect2>
257
258 <sect2 role="configuration">
259 <title>Configuring Python 3</title>
260
261 <para>
262 In order for <command>python3</command> to find the installed
263 documentation, create the following version independent symlink:
264 </para>
265
266<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>
267
268 <para>
269 and add the following environment variable to the individual user's or
270 system's profile:
271 </para>
272
273<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>
274
275 </sect2>
276
277 <sect2 role="content">
278 <title>Contents</title>
279
280 <segmentedlist>
281 <segtitle>Installed Programs</segtitle>
282 <segtitle>Installed Libraries</segtitle>
283 <segtitle>Installed Directories</segtitle>
284
285 <seglistitem>
286 <seg>
287 2to3 (symlink) and
288 2to3-&python3-majorver;,
289
290 <!--
291 easy_install-&python3-majorver;,
292 -->
293
294 idle3 (symlink) and
295 idle&python3-majorver;,
296
297 pip3 and
298 pip&python3-majorver;,
299
300 pydoc3 (symlink) and
301 pydoc&python3-majorver;,
302
303 python3 (symlink) and
304 python&python3-majorver;, and
305
306 python3-config (symlink) and
307 python&python3-majorver;-config
308 </seg>
309 <seg>
310 libpython&python3-majorver;.so and libpython3.so
311 </seg>
312 <seg>
313 /usr/include/python&python3-majorver;,
314 /usr/lib/python&python3-majorver;, and
315 /usr/share/doc/python-&python3-version;
316 </seg>
317 </seglistitem>
318 </segmentedlist>
319
320 <variablelist>
321 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
322 <?dbfo list-presentation="list"?>
323 <?dbhtml list-presentation="table"?>
324 <!--
325 <varlistentry id="2to3">
326 <term><command>2to3</command></term>
327 <listitem>
328 <para>
329 is designed to assist in the transition between python2 and python3
330 by automatically converting code to be Python3 compatible.
331 </para>
332 <indexterm zone="python3 2to3">
333 <primary sortas="b-2to3">2to3</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337 Put here for easy use when removing Python2 -->
338 <!--
339 <varlistentry id="easy_install">
340 <term><command>easy_install</command></term>
341 <listitem>
342 <para>
343 is a frontend to pip3 to make it easier to configure python modules
344 through the PIP package manager
345 </para>
346 <indexterm zone="python3 easy_install">
347 <primary sortas="python3 easy_install">easy_install</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351 -->
352 <varlistentry id="idle3">
353 <term><command>idle3</command></term>
354 <listitem>
355 <para>
356 is a wrapper script that opens a <application>Python</application>
357 aware GUI editor. For this script to run, you must have installed
358 <application>Tk</application> before Python so that the Tkinter
359 Python module is built
360 </para>
361 <indexterm zone="python3 idle3">
362 <primary sortas="b-idle3">idle3</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="pydoc3">
368 <term><command>pydoc3</command></term>
369 <listitem>
370 <para>
371 is the <application>Python</application> documentation
372 tool
373 </para>
374 <indexterm zone="python3 pydoc3">
375 <primary sortas="b-pydoc3">pydo3c</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="python3-prog">
381 <term><command>python3</command></term>
382 <listitem>
383 <para>
384 is an interpreted, interactive, object-oriented programming
385 language
386 </para>
387 <indexterm zone="python3 python3-prog">
388 <primary sortas="b-python3">python3</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="python-ver">
394 <term><command>python&python3-majorver;</command></term>
395 <listitem>
396 <para>
397 is a version-specific name for the <command>python</command>
398 program
399 </para>
400 <indexterm zone="python3 python-ver">
401 <primary sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
402 </indexterm>
403 </listitem>
404 </varlistentry>
405 <!--
406 <varlistentry id="pyvenv">
407 <term><command>pyvenv</command></term>
408 <listitem>
409 <para>
410 creates virtual <application>Python</application> environments in
411 one or more target directories.
412 </para>
413 <indexterm zone="python3 pyvenv">
414 <primary
415 sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419 -->
420 </variablelist>
421
422 </sect2>
423
424</sect1>
Note: See TracBrowser for help on using the repository browser.