From Fedora Project Wiki


Summary

Important.png
Obsoleted
This change was obsoleted by Move /usr/bin/python into a separate package

Deprecate, and later disable, running /usr/bin/python (as opposed to /usr/bin/python3 or /usr/bin/python2) during RPM build.

Changes will be driven by Python SIG, but a few packages may fail to build (with the failure message providing an easy workaround).

Owner

Current status

Detailed Description

Motivation

Currently in Fedora (package names, executable names, etc.), python means Python 2. We would like to change it to mean Python 3, but to do that, we need to free it of the current meaning. This means explicitly using either "python2" or "python3" throughout Fedora. This is a multi-release effort tracked in Python SIG's "Finalizing Fedora Switch to Python3" document. This page describes a very focused subset of it.

Renaming packages (and associated changes to, for example, Requires: directives) is relatively straightforward, but making all Fedora-provided code avoid /usr/bin/python (as opposed to /usr/bin/python2) is both harder to achieve and harder to keep track of.

We would like to start deprecating /usr/bin/python (as opposed to /usr/bin/python2) at RPM build time. RPM build is a controlled environment: changes to it will not be felt by end users, breakages are almost immediately visible, and output of Koji builds can be nicely tracked and analyzed.

Specification

Python 2, when called as python or /usr/bin/python will check an environment variable PYTHON_DISALLOW_AMBIGUOUS_VERSION. According to it's value, it will:

  • do nothing special (value 0, empty or unset)
  • print a deprecation warning to stderr (value warn)
  • print error and exit with positive exit code (value 1)

(Any program that invokes /usr/bin/python transitively will cause the above to happen as well.)

We'll set PYTHON_DISALLOW_AMBIGUOUS_VERSION=warn for Fedora's build environment.

A new Taskotron check will be implemented to look for the warning and fail if it's found. We will look at the Taskotron results and work with packagers to switch to update the affected packages. (We'll look at the results to determine if we'll use automated pull requests, mass bug filing, or something else.)

The warning itself may cause some packages to fail to build, for example if a test relies on exact stderr contents. For these cases, it will be possible to turn the warning off by changing the environment variable, but we ask packagers that use of this workaround is tracked in Bugzilla. See #Quick Opt-Out below.

After all packages that BuildRequire python2 are re-built with this check passing, python will be switched to fail after printing the message, i.e. we'll set PYTHON_DISALLOW_AMBIGUOUS_VERSION=1 .

The warning will not be effective if stderr output is hidden. So, after switching /usr/bin/python to fail, some packages may start failing to build. We will work with the packagers to fix these. (We'll look at results from the "warnings phase" to see how proactive we'll need to be here.)

The warning text will be:

DEPRECATION WARNING: python2 invoked with /usr/bin/python.
    Use /usr/bin/python3 or /usr/bin/python2
    /usr/bin/python will be removed or switched to Python 3 in the future.
    If you cannot make the switch now, please follow instructions at https://fedoraproject.org/wiki/Changes/Avoid_usr_bin_python_in_RPM_Build#Quick_Opt-Out

(Using the Wiki link allows us to easily revise the instructions.)

Quick Opt-Out

In case switching to /usr/bin/python2 or /usr/bin/python3 is non-trivial, do these two things:

  • Set the environment variable PYTHON_DISALLOW_AMBIGUOUS_VERSION=0 when calling /usr/bin/python.
    • The variable is reset at the beginning of every RPM section (%prep, %build, %install, %check, etc.). Change it, therefore, in every relevant section—ideally right before the invocation of /usr/bin/python.
  • File a Bugzilla, and make it block our tracking bug #1537244

All such bugs will need to be fixed before we make /usr/bin/python fail hard.

Python bytecompilation

In case the deprecation warning somehow breaks the automatic bytecompilation outside of /usr/lib(64)?/pythonX.Y, use the following to switch to /usr/bin/python2 or /usr/bin/python3 (where X is either 2 or 3):

%global __python %{__pythonX}

Benefit to Fedora

This change brings us one step closer to a seamless transition to Python 3.

Also, we hope to gain experience with changing packages to avoid /usr/bin/python, to prepare us for making user-visible changes later.


Scope

  • Proposal owners: Patch python2commit, set a value for PYTHON_DISALLOW_AMBIGUOUS_VERSIONcommit, write the Taskotron checkpull request, deal with warnings and failures.
  • Other developers: Switch to using /usr/bin/python3 or /usr/bin/python2 explicitly at RPM build time (with help from Proposal owners if needed). Also tools that are invoked during build time of other packages that themselves use /usr/bin/python will need to be fixed.
  • Release engineering: #7257 (Note: Depending on the timing, separate targeted rebuilds may be needed, but we can do these as Proven Packagers, no side-tags are required)
  • Policies and guidelines: Already existing "packages in Fedora ... MUST call the proper executable for the needed python major version directly, either /usr/bin/python2 or /usr/bin/python3 as appropriate" from Packaging:Python#Multiple_Python_Runtimes
  • Trademark approval: N/A (not needed for this Change)

Upgrade/compatibility impact

N/A (the effect is at RPM build time only)


How To Test

  • Build a package that invokes /usr/bin/python, python or %{__python} in any section of the specfile that is executed during the build.
  • Observe a warning in the build logs
  • If already enabled system-wide: observe that the build fails
  • Look at XXX to see a failed Taskotron check

User Experience

N/A – does not affect end users

Dependencies

May affect packages that use Python 2 to build (including in tests). Any breakage should be minimal, with an easy workaround if things go wrong.

Contingency Plan

  • Contingency mechanism: If something goes unexpectedly wrong, and the workaround above doesn't work, the patch to python2 will be reverted. Any packages already changed due to the warning will remain changed. If everything goes smoothly, but there is still a significant number of packages failing the check, the switch that would render all of them FTBFS will happen in the next release.
  • Contingency deadline: Beta Freeze (or any time this causes a FTBFS that can't be solved promptly)
  • Blocks release? No
  • Blocks product? None

Documentation

This page is the documentation.

Release Notes

N/A (Not an end-user visible change)