source: general/prog/python3.xml@ 41e68a2d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY python3-download-http
           "https://www.python.org/ftp/python/&python3-version;/Python-&python3-version;.tar.xz">
  <!ENTITY python3-download-ftp  " ">
  <!ENTITY python3-md5sum        "d33e4aae66097051c2eca45ee3604803">
  <!ENTITY python3-size          "16 MB">
  <!ENTITY python3-buildsize     "180 MB (add 22 MB for tests)">
  <!ENTITY python3-time          "1.0 SBU (add 1.1 SBU for tests)">
  <!--

  Note: Size does not reflect docs that were install in LFS.

  <!ENTITY python3htmldoc-download-http
  "https://docs.python.org/ftp/python/doc/&python3-version;/python-&python3-version;-docs-html.tar.bz2"> -->
]>

<sect1 id="python3" xreflabel="Python-&python3-version;">
  <?dbhtml filename="python3.html" ?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Python-&python3-version;</title>

  <indexterm zone="python3">
    <primary sortas="a-Python3">Python3</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Python 3</title>

    <para>
      The <application>Python 3</application> package contains the
      <application>Python</application> development environment.
      This is useful for object-oriented programming, writing scripts,
      prototyping large programs or developing entire applications.
    </para>

    <note><para><application>Python 3</application> was installed in LFS.
    The only reason to rebuild it here is if optional modules
    are needed.</para></note>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&python3-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&python3-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &python3-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &python3-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &python3-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &python3-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Python 3 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="bluez"/>,
      <xref linkend="gdb"/> (required for some tests),
      <xref linkend="valgrind"/>, and
      <ulink url="http://www.bytereef.org/mpdecimal">libmpcdec</ulink>
    </para>

    <bridgehead renderas="sect4">Optional (For Additional Modules)</bridgehead>
    <para role="optional">
      <xref linkend="db"/> and
      <xref linkend="sqlite"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/Python3"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Python 3</title>

    <para>
      Install <application>Python 3</application> by running the following
      commands:
    </para>

<screen><userinput>CXX="/usr/bin/g++"              \
./configure --prefix=/usr       \
            --enable-shared     \
            --with-system-expat \
            --with-system-ffi   \
            --with-ensurepip=yes &amp;&amp;
make</userinput></screen>

    <para>
      The test suite must be run separately, using an X terminal (see below).
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
chmod -v 755 /usr/lib/libpython&python3-majorver;m.so &amp;&amp;
chmod -v 755 /usr/lib/libpython3.so</userinput></screen>

    <para>
      The test suite must be run separately from the build, either before or
      after the package is built and installed. Do not run
      <command>make install</command> after running the test suite. To build
      and install the package, you need to start with a fresh or clean source
      tree. For the tests, you also need a clean source code, so either start by
      removing the source code directory and starting over, by uncompressing
      the source tarball or by running <command>make clean</command>. Then
      configure again, adding <quote>--with-pydebug</quote> to the
      <command>configure</command> switches above, run <command>make</command>,
      then <command>make test</command>. Remember that tests must be executed
      using an X terminal. 
      The test SBU highly depends on the speed of the internet connection.
    </para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command> CXX="/usr/bin/g++" ./configure ...</command>: Avoid an annoying
      message during configuration.
    </para>

    <para>
      <parameter>--with-system-expat</parameter>: This switch enables linking
      against the system version of <application>Expat</application>.
    </para>

    <para>
      <parameter>--with-system-ffi</parameter>: This switch enables linking
      against system version of <application>libffi</application>. 
    </para>

    <para>
      <parameter>--with-ensurepip=yes</parameter> : This switch enables building
      <command>pip</command> and <command>setuptools</command> packaging programs.
      <command>setuptools</command> is needed for building some Python modules.
    </para>

    <para>
      <option>--with-dbmliborder=bdb:gdbm:ndbm</option>: Use this switch
      if you want to build <application>Python</application> DBM Module
      against <application>Berkeley DB</application> instead of
      <application>GDBM</application>.
    </para>

    <para>
      <option>--enable-optimization</option>: Use this switch
      if you want to enable <emphasis>expensive</emphasis> optimizations (i.e.
      Profile Guided Optimizations). This adds around 20 SBU, but can
      <emphasis>slightly</emphasis> speed up some uses, such as using
      <application>Sphinx</application> for creating documentation, or use of
      <application>Python3</application> scripts.
    </para>

    <para>
      <option>--with-lto</option>: This optional switch enables thick Link
      Time Optimization. Unusually, it creates a much larger <filename
      class="libraryfile">/usr/lib/python3.7/config-3.7m-x86_64-linux-gnu/libpython3.7m.a</filename>
      with a small increase in the time to compile
      <application>Python</application>. Run-time results do not appear to show
      any benefit from doing this.
    </para>

    <para>
      <command>chmod ...</command>: Fix permissions for shared libraries to be
      consistent with other libraries.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Python 3</title>

    <para>
      In order for <command>python3</command> to find the installed
      documentation, create the following version independent symlink:
    </para>

<screen role="root"><userinput>ln -svfn python-&python3-version; /usr/share/doc/python-3</userinput></screen>

    <para>
      and add the following environment variable to the individual user's or
      system's profile:
    </para>

<screen role="root"><userinput>export PYTHONDOCS=/usr/share/doc/python-3/html</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          2to3 (symlink),
          2to3-&python3-majorver;,

          idle3 (symlink), and
          idle&python3-majorver;

          pydoc3 (symlink),
          pydoc&python3-majorver;,

          python3 (symlink);
          python&python3-majorver; and python&python3-majorver;m (hardlinked);

          python3-config (symlink),
          python&python3-majorver;-config (symlink),
          python&python3-majorver;m-config,

          pyvenv (symlink),
          pyvenv-&python3-majorver;,
        </seg>
        <seg>
          libpython&python3-majorver;m.so and libpython3.so
        </seg>
        <seg>
          /usr/include/python&python3-majorver;m,
          /usr/lib/python&python3-majorver;, and
          /usr/share/doc/python-&python3-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="idle3">
        <term><command>idle3</command></term>
        <listitem>
          <para>
            is a wrapper script that opens a <application>Python</application>
            aware GUI editor. For this script to run, you must have installed
            <application>Tk</application> before Python so that the Tkinter
            Python module is built.
          </para>
          <indexterm zone="python3 idle3">
            <primary sortas="b-idle3">idle3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pydoc3">
        <term><command>pydoc3</command></term>
        <listitem>
          <para>
            is the <application>Python</application> documentation
            tool.
          </para>
          <indexterm zone="python3 pydoc3">
            <primary sortas="b-pydoc3">pydo3c</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python3-prog">
        <term><command>python3</command></term>
        <listitem>
          <para>
            is an interpreted, interactive, object-oriented programming
            language.
          </para>
          <indexterm zone="python3 python3-prog">
            <primary sortas="b-python3">python3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="python-ver">
        <term><command>python&python3-majorver;</command></term>
        <listitem>
          <para>
            is a version-specific name for the <command>python</command>
            program.
          </para>
          <indexterm zone="python3 python-ver">
            <primary
            sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pyvenv">
        <term><command>pyvenv</command></term>
        <listitem>
          <para>
            creates virtual <application>Python</application> environments in
            one or more target directories.
          </para>
          <indexterm zone="python3 pyvenv">
            <primary
            sortas="b-python&python3-majorver;">python&python3-majorver;</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>