source: general/prog/python3.xml@ 0e60ff70

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 0e60ff70 was 8748122, checked in by Xi Ruoyao <xry111@…>, 7 months ago

python3: Add libxml2 into the list of packages requiring an reinstallation when upgrading Python 3 to a new minor version

  • Property mode set to 100644
File size: 13.5 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 "f6f4616584b23254d165f4db90c247d6">
11 <!ENTITY python3-size "20 MB">
12 <!ENTITY python3-buildsize "334 MB (add 60 MB for tests)">
13 <!ENTITY python3-time "1.7 SBU (add 2.3 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 "ae9d19bb613ae8ef2457496bd2893915" >
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 &lfs120_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="db"/>,
151 <xref linkend="libnsl"/>, and
152 <xref linkend="tk"/>
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 To test the result, issue <command>LC_ALL=en_US.UTF-8
186 make test</command>.
187 Some tests may need an Internet connection.
188 </para>
189
190 <para>
191 Now, as the <systemitem class="username">root</systemitem> user:
192 </para>
193
194<screen role="root"><userinput>make install</userinput></screen>
195
196 <para>
197 If upgrading and the documentation has been downloaded, optionally install
198 it as the &root; user:
199 </para>
200
201<screen role="root"><userinput>install -v -dm755 /usr/share/doc/python-&python3-version;/html
202
203tar --strip-components=1 \
204 --no-same-owner \
205 --no-same-permissions \
206 -C /usr/share/doc/python-&python3-version;/html \
207 -xvf ../python-&python3-version;-docs-html.tar.bz2</userinput></screen>
208
209 </sect2>
210
211 <sect2 role="commands">
212 <title>Command Explanations</title>
213
214 <para>
215 <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
216 message during configuration.
217 </para>
218
219 <para>
220 <parameter>--with-system-expat</parameter>: This switch enables linking
221 against the system version of <application>Expat</application>.
222 </para>
223
224<!--
225 <para>
226 <parameter>- -with-ensurepip=yes</parameter> : This switch enables building
227 the <command>pip</command> and <command>setuptools</command> packaging
228 programs. <command>setuptools</command> is needed for building some
229 Python modules.
230 </para>
231-->
232 <para>
233 <option>--with-dbmliborder=bdb:gdbm:ndbm</option>: Use this switch
234 if you want to build the <application>Python</application> DBM Module
235 against <application>Berkeley DB</application> instead of
236 <application>GDBM</application>.
237 </para>
238
239 <para>
240 <parameter>--enable-optimizations</parameter>: This switch enables
241 stable, but expensive, optimizations.
242 </para>
243
244 <para>
245 <option>--with-lto</option>: This optional switch enables thick Link
246 Time Optimization. Unusually, it creates a much larger <filename
247 class="libraryfile">/usr/lib/python&python3-majorver;/config-&python3-majorver;-&lt;arch&gt;-linux-gnu/libpython&python3-majorver;.a</filename>
248 with a small increase in the time to compile
249 <application>Python</application>. Run-time results do not appear to show
250 any benefit from doing this.
251 </para>
252
253 </sect2>
254
255 <sect2 role="configuration">
256 <title>Configuring Python 3</title>
257
258 <para>
259 In order for <command>python3</command> to find the installed
260 documentation, create the following version independent symlink:
261 </para>
262
263<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>
264
265 <para>
266 and add the following environment variable to the individual user's or
267 system's profile:
268 </para>
269
270<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>
271
272 </sect2>
273
274 <sect2 role="content">
275 <title>Contents</title>
276
277 <segmentedlist>
278 <segtitle>Installed Programs</segtitle>
279 <segtitle>Installed Libraries</segtitle>
280 <segtitle>Installed Directories</segtitle>
281
282 <seglistitem>
283 <seg>
284 2to3 (symlink) and
285 2to3-&python3-majorver;,
286
287 <!--
288 easy_install-&python3-majorver;,
289 -->
290
291 idle3 (symlink) and
292 idle&python3-majorver;,
293
294 pip3 and
295 pip&python3-majorver;,
296
297 pydoc3 (symlink) and
298 pydoc&python3-majorver;,
299
300 python3 (symlink) and
301 python&python3-majorver;, and
302
303 python3-config (symlink) and
304 python&python3-majorver;-config
305 </seg>
306 <seg>
307 libpython&python3-majorver;.so and libpython3.so
308 </seg>
309 <seg>
310 /usr/include/python&python3-majorver;,
311 /usr/lib/python&python3-majorver;, and
312 /usr/share/doc/python-&python3-version;
313 </seg>
314 </seglistitem>
315 </segmentedlist>
316
317 <variablelist>
318 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
319 <?dbfo list-presentation="list"?>
320 <?dbhtml list-presentation="table"?>
321 <!--
322 <varlistentry id="2to3">
323 <term><command>2to3</command></term>
324 <listitem>
325 <para>
326 is designed to assist in the transition between python2 and python3
327 by automatically converting code to be Python3 compatible.
328 </para>
329 <indexterm zone="python3 2to3">
330 <primary sortas="b-2to3">2to3</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334 Put here for easy use when removing Python2 -->
335 <!--
336 <varlistentry id="easy_install">
337 <term><command>easy_install</command></term>
338 <listitem>
339 <para>
340 is a frontend to pip3 to make it easier to configure python modules
341 through the PIP package manager
342 </para>
343 <indexterm zone="python3 easy_install">
344 <primary sortas="python3 easy_install">easy_install</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348 -->
349 <varlistentry id="idle3">
350 <term><command>idle3</command></term>
351 <listitem>
352 <para>
353 is a wrapper script that opens a <application>Python</application>
354 aware GUI editor. For this script to run, you must have installed
355 <application>Tk</application> before Python so that the Tkinter
356 Python module is built
357 </para>
358 <indexterm zone="python3 idle3">
359 <primary sortas="b-idle3">idle3</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="pydoc3">
365 <term><command>pydoc3</command></term>
366 <listitem>
367 <para>
368 is the <application>Python</application> documentation
369 tool
370 </para>
371 <indexterm zone="python3 pydoc3">
372 <primary sortas="b-pydoc3">pydo3c</primary>
373 </indexterm>
374 </listitem>
375 </varlistentry>
376
377 <varlistentry id="python3-prog">
378 <term><command>python3</command></term>
379 <listitem>
380 <para>
381 is an interpreted, interactive, object-oriented programming
382 language
383 </para>
384 <indexterm zone="python3 python3-prog">
385 <primary sortas="b-python3">python3</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="python-ver">
391 <term><command>python&python3-majorver;</command></term>
392 <listitem>
393 <para>
394 is a version-specific name for the <command>python</command>
395 program
396 </para>
397 <indexterm zone="python3 python-ver">
398 <primary sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
399 </indexterm>
400 </listitem>
401 </varlistentry>
402 <!--
403 <varlistentry id="pyvenv">
404 <term><command>pyvenv</command></term>
405 <listitem>
406 <para>
407 creates virtual <application>Python</application> environments in
408 one or more target directories.
409 </para>
410 <indexterm zone="python3 pyvenv">
411 <primary
412 sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416 -->
417 </variablelist>
418
419 </sect2>
420
421</sect1>
Note: See TracBrowser for help on using the repository browser.