source: general/prog/python3.xml@ d0892b4

lazarus trunk
Last change on this file since d0892b4 was c0bc0a9, checked in by Xi Ruoyao <xry111@…>, 2 months ago

Update to glib-2.80.0 and gobject-introspection-1.80.0

Merge gobject-introspection into glib page to better handle a circular
dependency between these two packages.

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