source: general/prog/python3.xml@ 5156197

11.0 ken/refactor-virt lazarus qt5new trunk upgradedb
Last change on this file since 5156197 was 5156197, checked in by Xi Ruoyao <xry111@…>, 9 months ago

Revert "Fix a header file in python for certain use cases;"

This reverts commit 7b66ed21ded4cdc68b8147266864d4d647151b54.

Python maintainers rejected the proposed fix in
https://bugs.python.org/issue39026. We'll need to make a correct fix,
or patch the downstream packages (cracklib) instead.

  • Property mode set to 100644
File size: 11.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 "f0dc9000312abeb16de4eccce9a870ab">
11 <!ENTITY python3-size "18 MB">
12 <!ENTITY python3-buildsize "379 MB (add 36 MB for tests)">
13 <!ENTITY python3-time "0.5 SBU (using parallelism=4; add 1.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 &amp;&amp;
128make</userinput></screen>
129
130 <para>
131 To test the result, issue <command>make test</command>.
132 Some tests may need Internet connection.
133 </para>
134
135 <para>
136 Now, as the <systemitem class="username">root</systemitem> user:
137 </para>
138
139<screen role="root"><userinput>make install</userinput></screen>
140
141 </sect2>
142
143 <sect2 role="commands">
144 <title>Command Explanations</title>
145
146 <para>
147 <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
148 message during configuration.
149 </para>
150
151 <para>
152 <parameter>--with-system-expat</parameter>: This switch enables linking
153 against the system version of <application>Expat</application>.
154 </para>
155
156 <para>
157 <parameter>--with-system-ffi</parameter>: This switch enables linking
158 against system version of <application>libffi</application>.
159 </para>
160
161 <para>
162 <parameter>--with-ensurepip=yes</parameter> : This switch enables building
163 <command>pip</command> and <command>setuptools</command> packaging programs.
164 <command>setuptools</command> is needed for building some Python modules.
165 </para>
166
167 <para>
168 <option>--with-dbmliborder=bdb:gdbm:ndbm</option>: Use this switch
169 if you want to build <application>Python</application> DBM Module
170 against <application>Berkeley DB</application> instead of
171 <application>GDBM</application>.
172 </para>
173
174 <para>
175 <option>--enable-optimization</option>: Use this switch
176 if you want to enable <emphasis>expensive</emphasis> optimizations (i.e.
177 Profile Guided Optimizations). This adds around 20 SBU, but can
178 <emphasis>slightly</emphasis> speed up some uses, such as using
179 <application>Sphinx</application> for creating documentation, or use of
180 <application>Python3</application> scripts.
181 </para>
182
183 <para>
184 <option>--with-lto</option>: This optional switch enables thick Link
185 Time Optimization. Unusually, it creates a much larger <filename
186 class="libraryfile">/usr/lib/python&python3-majorver;/config-&python3-majorver;-&lt;arch&gt;-linux-gnu/libpython&python3-majorver;.a</filename>
187 with a small increase in the time to compile
188 <application>Python</application>. Run-time results do not appear to show
189 any benefit from doing this.
190 </para>
191 <!--
192 <para>
193 <command>ln -sfv ...</command>: When upgrading to Python-3.8, it was
194 discovered that the symlink to pip3 is sometimes not created. Create
195 the symlink so that pip3 can be used as described in the book.
196 </para>
197 -->
198
199 </sect2>
200
201 <sect2 role="configuration">
202 <title>Configuring Python 3</title>
203
204 <para>
205 In order for <command>python3</command> to find the installed
206 documentation, create the following version independent symlink:
207 </para>
208
209<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>
210
211 <para>
212 and add the following environment variable to the individual user's or
213 system's profile:
214 </para>
215
216<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>
217
218 </sect2>
219
220 <sect2 role="content">
221 <title>Contents</title>
222
223 <segmentedlist>
224 <segtitle>Installed Programs</segtitle>
225 <segtitle>Installed Libraries</segtitle>
226 <segtitle>Installed Directories</segtitle>
227
228 <seglistitem>
229 <seg>
230 2to3 (symlink) and
231 2to3-&python3-majorver;,
232
233 easy_install-&python3-majorver;,
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 (symlink), and
248 python&python3-majorver;
249
250 python3-config (symlink) and
251 python&python3-majorver;-config
252 </seg>
253 <seg>
254 libpython&python3-majorver;.so and libpython3.so
255 </seg>
256 <seg>
257 /usr/include/python&python3-majorver;,
258 /usr/lib/python&python3-majorver;, and
259 /usr/share/doc/python-&python3-version;
260 </seg>
261 </seglistitem>
262 </segmentedlist>
263
264 <variablelist>
265 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
266 <?dbfo list-presentation="list"?>
267 <?dbhtml list-presentation="table"?>
268 <!--
269 <varlistentry id="2to3">
270 <term><command>2to3</command></term>
271 <listitem>
272 <para>
273 is designed to assist in the transition between python2 and python3
274 by automatically converting code to be Python3 compatible.
275 </para>
276 <indexterm zone="python3 2to3">
277 <primary sortas="b-2to3">2to3</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281 Put here for easy use when removing Python2 -->
282 <varlistentry id="easy_install">
283 <term><command>easy_install</command></term>
284 <listitem>
285 <para>
286 is a frontend to pip3 to make it easier to configure python modules
287 through the PIP package manager
288 </para>
289 <indexterm zone="python3 easy_install">
290 <primary sortas="python3 easy_install">easy_install</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="idle3">
296 <term><command>idle3</command></term>
297 <listitem>
298 <para>
299 is a wrapper script that opens a <application>Python</application>
300 aware GUI editor. For this script to run, you must have installed
301 <application>Tk</application> before Python so that the Tkinter
302 Python module is built
303 </para>
304 <indexterm zone="python3 idle3">
305 <primary sortas="b-idle3">idle3</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="pydoc3">
311 <term><command>pydoc3</command></term>
312 <listitem>
313 <para>
314 is the <application>Python</application> documentation
315 tool
316 </para>
317 <indexterm zone="python3 pydoc3">
318 <primary sortas="b-pydoc3">pydo3c</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="python3-prog">
324 <term><command>python3</command></term>
325 <listitem>
326 <para>
327 is an interpreted, interactive, object-oriented programming
328 language
329 </para>
330 <indexterm zone="python3 python3-prog">
331 <primary sortas="b-python3">python3</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="python-ver">
337 <term><command>python&python3-majorver;</command></term>
338 <listitem>
339 <para>
340 is a version-specific name for the <command>python</command>
341 program
342 </para>
343 <indexterm zone="python3 python-ver">
344 <primary sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348 <!--
349 <varlistentry id="pyvenv">
350 <term><command>pyvenv</command></term>
351 <listitem>
352 <para>
353 creates virtual <application>Python</application> environments in
354 one or more target directories.
355 </para>
356 <indexterm zone="python3 pyvenv">
357 <primary
358 sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362 -->
363 </variablelist>
364
365 </sect2>
366
367</sect1>
Note: See TracBrowser for help on using the repository browser.