source: general/prog/python3.xml@ 382d0115

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 382d0115 was 382d0115, checked in by Xi Ruoyao <xry111@…>, 8 months ago

Python: Set LC_ALL=en_US.UTF-8 for testing

See added comment for details.

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