User:Bkabrda/Py2to3GuidelineChanges

Prelude

This page summarizes a proposal of changes to Python packaging guidelines, that should occur with switch to Python 3 as a default, as proposed in [1] (will be referred to as Change).

Changes in Package Naming and SRPM <-> RPM Relations

Current State

python-* packages (built with Python 2) are installed by default (from LiveCD, as dependencies of applications that require some Python packages) and by yum install python-foo. Python 3 packages are named python3-* and are installed as yum install python3-foo.

From the packaging point of view, this is achieved by either

• Having one SRPM python-foo that produces python-foo and python3-foo binary RPMs.

or

• Having two SRPMs, python-foo (produces python-foo binary RPM) and python3-foo SRPM (produces python3-foo binary RPM).

Future State Implied by the Change

After the switch, python3-* packages are going to be installed by default (from LiveCD, as dependencies of applications that require some Python packages).

Proposal for Further Changes

• A brief discussion already happened at [2].
• The SRPMs that produce binary RPMs for more Python runtimes should keep current names python-foo, the SRPMs that produce binary RPM for just one runtime should be named pythonX-foo.
• All the binary RPMs must be named pythonX-foo, where X is the major version of the Python runtime that they use.
• For the time being (and maybe forever), every python2-foo package must have Provides: python-foo.
• This means that from user's perspective only one thing will change, and that is python-* packages will be renamed to python2-*, but will still keep the provide of python-*.

Why?

• This concept will easily scale to more Python runtimes (PyPy, Jython), as already proposed previously by Tom Spur. Please note, that scaling to other runtimes is not part of this proposal and should be discussed further in another proposal/ML thread.
• Currently, upstream recommendation [3] is to point /usr/bin/python to Python 2, but as the PEP notes, it will be reviewed and it is anticipated that in time it will be updated to recommend pointing /usr/bin/python to /usr/bin/python3. When this time comes, we should also move the provides suggested above (Provides: python-foo) from python2-* packages to python3-* packages to keep things like yum install /usr/bin/python python-foo consistent.
• Having python2-* vs. python3-* packages is a good way of explicitly distinguishing packages from the two stacks. This is connected with the reason above - we should recommend explicit usage of /usr/bin/python{2,3} and yum install python{2,3}-foo, and we should discourage use of implicit /usr/bin/python and python-* so that nothing breaks for users when these are changed in any way. (We already started to advertise usage of versioned /usr/bin/python{2,3} binary by deprecating %__python in current guidelines and recommending %__python{2,3}.)

Alternatives

• Just keep what we have - doesn't seem to scale to other Python runtimes;
• Only allow split SRPMs - too much maintenance work.

Example Specfile

%global with_python2 1
%global with_python3 1

# this macro is defined here only for testing purposes, it would
# be defined in macros.python2 provided by python2-devel
%global py2dir %{_builddir}/python2-%{name}-%{version}-%{release}

Name:           python-six
Version:        1.4.1
Release:        1%{?dist}
Summary:        Python 2 and 3 compatibility utilities

Group:          Development/Languages
License:        MIT
URL:            http://pypi.python.org/pypi/six/
Source0:        http://pypi.python.org/packages/source/s/six/six-%{version}.tar.gz

BuildArch:      noarch
%if 0%{?with_python2}
BuildRequires:  python-devel
# For use by selftests:
BuildRequires:  pytest
BuildRequires:  tkinter
%endif

%if 0%{?with_python3}
BuildRequires:  python3-devel
# For use by selftests:
BuildRequires:  python3-pytest
BuildRequires:  python3-tkinter
%endif

%description
python-six provides simple utilities for wrapping over differences between
Python 2 and Python 3.

This is the Python 2 build of the module.

%if 0%{?with_python2}
%package -n python2-six
Summary:        Python 2 and 3 compatibility utilities
Group:          Development/Languages

%description -n python2-six
python-six provides simple utilities for wrapping over differences between
Python 2 and Python 3.
%endif

%if 0%{?with_python3}
%package -n python3-six
Summary:        Python 2 and 3 compatibility utilities
Group:          Development/Languages

%description -n python3-six
python-six provides simple utilities for wrapping over differences between
Python 2 and Python 3.

This is the Python 3 build of the module.
%endif

%prep
%setup -q -n six-%{version}
# possibly apply patches here

%if 0%{?with_python2}
rm -rf %{py2dir}
cp -a . %{py2dir}
%endif

%if 0%{?with_python3}
rm -rf %{py3dir}
cp -a . %{py3dir}
%endif


%build
%if 0%{?with_python2}
pushd %{py2dir}
%{__python2} setup.py build
popd
%endif

%if 0%{?with_python3}
pushd %{py3dir}
%{__python3} setup.py build
popd
%endif


%install
%if 0%{?with_python3}
pushd %{py3dir}
%{__python3} setup.py install -O1 --skip-build --root $RPM_BUILD_ROOT
popd
%endif

%if 0%{?with_python2}
pushd %{py3dir}
%{__python2} setup.py install -O1 --skip-build --root $RPM_BUILD_ROOT
popd
%endif


%if 0%{?with_python2}
%files -n python2-six
%doc LICENSE README documentation/index.rst
%{python2_sitelib}/*
%endif

%if 0%{?with_python3}
%files -n python3-six
%doc LICENSE README documentation/index.rst
%{python3_sitelib}/*
%endif

[1] https://fedoraproject.org/wiki/Changes/Python_3_as_Default

[2] https://lists.fedoraproject.org/pipermail/devel/2013-July/186822.html

[3] http://www.python.org/dev/peps/pep-0394/

[4] http://www.python.org/dev/peps/pep-0394/#future-changes-to-this-recommendation