source: general/prog/python3.xml@ a87fb41

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since a87fb41 was a87fb41, checked in by Xi Ruoyao <xry111@…>, 16 months ago

python3: sync with LFS

  • Property mode set to 100644
File size: 11.1 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 "ecc29a7688f86e550d29dba2ee66cf80">
11 <!ENTITY python3-size "18 MB">
12 <!ENTITY python3-buildsize "356 MB (add 56 MB for tests)">
13 <!ENTITY python3-time "0.6 SBU (using parallelism=4; add 2.7 SBU for tests)">
14 <!--
15 Note: Size does not reflect docs that were install in LFS.
16
17 <!ENTITY python3htmldoc-download-http
18 "https://docs.python.org/ftp/python/doc/&python3-version;/python-&python3-version;-docs-html.tar.bz2"> -->
19]>
20
21<sect1 id="python3" xreflabel="Python-&python3-version;">
22 <?dbhtml filename="python3.html" ?>
23
24 <sect1info>
25 <date>$Date$</date>
26 </sect1info>
27
28 <title>Python-&python3-version;</title>
29
30 <indexterm zone="python3">
31 <primary sortas="a-Python3">Python3</primary>
32 </indexterm>
33
34 <sect2 role="package">
35 <title>Introduction to Python 3</title>
36
37 <para>
38 The <application>Python 3</application> package contains the
39 <application>Python</application> development environment.
40 This is useful for object-oriented programming, writing scripts,
41 prototyping large programs or developing entire applications.
42 </para>
43
44 <note>
45 <para>
46 <application>Python 3</application> was installed in LFS.
47 The only reason to rebuild it here is if optional modules
48 are needed.
49 </para>
50 </note>
51
52 &lfs101_checked;
53
54 <bridgehead renderas="sect3">Package Information</bridgehead>
55 <itemizedlist spacing="compact">
56 <listitem>
57 <para>
58 Download (HTTP): <ulink url="&python3-download-http;"/>
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download (FTP): <ulink url="&python3-download-ftp;"/>
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Download MD5 sum: &python3-md5sum;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Download size: &python3-size;
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Estimated disk space required: &python3-buildsize;
79 </para>
80 </listitem>
81 <listitem>
82 <para>
83 Estimated build time: &python3-time;
84 </para>
85 </listitem>
86 </itemizedlist>
87
88 <bridgehead renderas="sect3">Python 3 Dependencies</bridgehead>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="sqlite"/> (required if building firefox or thunderbird)
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="bluez"/>,
98 <xref linkend="gdb"/> (required for some tests),
99 <xref linkend="valgrind"/>, and
100 <ulink url="http://www.bytereef.org/mpdecimal">libmpdec</ulink>
101 </para>
102
103 <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
104 <para role="optional">
105 <xref linkend="db"/> and
106 <xref linkend="tk"/>
107 </para>
108
109 <para condition="html" role="usernotes">User Notes:
110 <ulink url="&blfs-wiki;/Python3"/>
111 </para>
112 </sect2>
113
114 <sect2 role="installation">
115 <title>Installation of Python 3</title>
116
117 <para>
118 Install <application>Python 3</application> by running the following
119 commands:
120 </para>
121
122<screen><userinput>CXX="/usr/bin/g++" \
123./configure --prefix=/usr \
124 --enable-shared \
125 --with-system-expat \
126 --with-system-ffi \
127 --with-ensurepip=yes \
128 --enable-optimizations &amp;&amp;
129make</userinput></screen>
130
131 <para>
132 To test the result, issue <command>make test</command>.
133 Some tests may need an Internet connection.
134 </para>
135
136 <para>
137 Now, as the <systemitem class="username">root</systemitem> user:
138 </para>
139
140<screen role="root"><userinput>make install</userinput></screen>
141
142 </sect2>
143
144 <sect2 role="commands">
145 <title>Command Explanations</title>
146
147 <para>
148 <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
149 message during configuration.
150 </para>
151
152 <para>
153 <parameter>--with-system-expat</parameter>: This switch enables linking
154 against the system version of <application>Expat</application>.
155 </para>
156
157 <para>
158 <parameter>--with-system-ffi</parameter>: This switch enables linking
159 against the system version of <application>libffi</application>.
160 </para>
161
162 <para>
163 <parameter>--with-ensurepip=yes</parameter> : This switch enables building
164 the <command>pip</command> and <command>setuptools</command> packaging
165 programs. <command>setuptools</command> is needed for building some
166 Python modules.
167 </para>
168
169 <para>
170 <option>--with-dbmliborder=bdb:gdbm:ndbm</option>: Use this switch
171 if you want to build the <application>Python</application> DBM Module
172 against <application>Berkeley DB</application> instead of
173 <application>GDBM</application>.
174 </para>
175
176 <para>
177 <parameter>--enable-optimization</parameter>: This switch enables
178 stable, but expensive, optimizations.
179 </para>
180
181 <para>
182 <option>--with-lto</option>: This optional switch enables thick Link
183 Time Optimization. Unusually, it creates a much larger <filename
184 class="libraryfile">/usr/lib/python&python3-majorver;/config-&python3-majorver;-&lt;arch&gt;-linux-gnu/libpython&python3-majorver;.a</filename>
185 with a small increase in the time to compile
186 <application>Python</application>. Run-time results do not appear to show
187 any benefit from doing this.
188 </para>
189 <!--
190 <para>
191 <command>ln -sfv ...</command>: When upgrading to Python-3.8, it was
192 discovered that the symlink to pip3 is sometimes not created. Create
193 the symlink so that pip3 can be used as described in the book.
194 </para>
195 -->
196
197 </sect2>
198
199 <sect2 role="configuration">
200 <title>Configuring Python 3</title>
201
202 <para>
203 In order for <command>python3</command> to find the installed
204 documentation, create the following version independent symlink:
205 </para>
206
207<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>
208
209 <para>
210 and add the following environment variable to the individual user's or
211 system's profile:
212 </para>
213
214<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>
215
216 </sect2>
217
218 <sect2 role="content">
219 <title>Contents</title>
220
221 <segmentedlist>
222 <segtitle>Installed Programs</segtitle>
223 <segtitle>Installed Libraries</segtitle>
224 <segtitle>Installed Directories</segtitle>
225
226 <seglistitem>
227 <seg>
228 2to3 (symlink) and
229 2to3-&python3-majorver;,
230
231 <!--
232 easy_install-&python3-majorver;,
233 -->
234
235 idle3 (symlink) and
236 idle&python3-majorver;,
237
238 pip3 (symlink) and
239 pip&python3-majorver;,
240
241 pydoc3 and
242 pydoc&python3-majorver;,
243
244 python3 (symlink);
245 python&python3-majorver;, and
246
247 python3-config (symlink) and
248 python&python3-majorver;-config
249 </seg>
250 <seg>
251 libpython&python3-majorver;.so and libpython3.so
252 </seg>
253 <seg>
254 /usr/include/python&python3-majorver;,
255 /usr/lib/python&python3-majorver;, and
256 /usr/share/doc/python-&python3-version;
257 </seg>
258 </seglistitem>
259 </segmentedlist>
260
261 <variablelist>
262 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
263 <?dbfo list-presentation="list"?>
264 <?dbhtml list-presentation="table"?>
265 <!--
266 <varlistentry id="2to3">
267 <term><command>2to3</command></term>
268 <listitem>
269 <para>
270 is designed to assist in the transition between python2 and python3
271 by automatically converting code to be Python3 compatible.
272 </para>
273 <indexterm zone="python3 2to3">
274 <primary sortas="b-2to3">2to3</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278 Put here for easy use when removing Python2 -->
279 <!--
280 <varlistentry id="easy_install">
281 <term><command>easy_install</command></term>
282 <listitem>
283 <para>
284 is a frontend to pip3 to make it easier to configure python modules
285 through the PIP package manager
286 </para>
287 <indexterm zone="python3 easy_install">
288 <primary sortas="python3 easy_install">easy_install</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292 -->
293 <varlistentry id="idle3">
294 <term><command>idle3</command></term>
295 <listitem>
296 <para>
297 is a wrapper script that opens a <application>Python</application>
298 aware GUI editor. For this script to run, you must have installed
299 <application>Tk</application> before Python so that the Tkinter
300 Python module is built
301 </para>
302 <indexterm zone="python3 idle3">
303 <primary sortas="b-idle3">idle3</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="pydoc3">
309 <term><command>pydoc3</command></term>
310 <listitem>
311 <para>
312 is the <application>Python</application> documentation
313 tool
314 </para>
315 <indexterm zone="python3 pydoc3">
316 <primary sortas="b-pydoc3">pydo3c</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="python3-prog">
322 <term><command>python3</command></term>
323 <listitem>
324 <para>
325 is an interpreted, interactive, object-oriented programming
326 language
327 </para>
328 <indexterm zone="python3 python3-prog">
329 <primary sortas="b-python3">python3</primary>
330 </indexterm>
331 </listitem>
332 </varlistentry>
333
334 <varlistentry id="python-ver">
335 <term><command>python&python3-majorver;</command></term>
336 <listitem>
337 <para>
338 is a version-specific name for the <command>python</command>
339 program
340 </para>
341 <indexterm zone="python3 python-ver">
342 <primary sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346 <!--
347 <varlistentry id="pyvenv">
348 <term><command>pyvenv</command></term>
349 <listitem>
350 <para>
351 creates virtual <application>Python</application> environments in
352 one or more target directories.
353 </para>
354 <indexterm zone="python3 pyvenv">
355 <primary
356 sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360 -->
361 </variablelist>
362
363 </sect2>
364
365</sect1>
Note: See TracBrowser for help on using the repository browser.