PEP 600: Update text to align with discussion (#1137)
Major rewrite pass over PEP 600 This has minimal substantive changes, though it does fill in some details. Mostly it's just aligning the text with all the discussion on Discourse.
This commit is contained in:
parent
db4039518f
commit
efa49a74d1
566
pep-0600.rst
566
pep-0600.rst
|
@ -16,202 +16,470 @@ Post-History: 3-May-2019
|
||||||
Abstract
|
Abstract
|
||||||
========
|
========
|
||||||
|
|
||||||
This PEP proposes a scheme for new 'manylinux' distribution tags to be defined
|
This PEP proposes a scheme for new 'manylinux' wheel tags to be
|
||||||
without requiring a PEP for every specific tag. The naming scheme is based on
|
defined without requiring a PEP for every specific tag, similar to how
|
||||||
glibc versions, with profiles in the auditwheel tool defining what other
|
Windows and macOS tags already work. This will allow package
|
||||||
external libraries and symbols a compatible wheel may link against.
|
maintainers to take advantage of new tags more quickly, while making
|
||||||
|
better use of limited volunteer time.
|
||||||
|
|
||||||
|
Non-goals include: handling non-glibc-based platforms; integrating
|
||||||
|
with external package managers or handling external dependencies such
|
||||||
|
as CUDA; making manylinux tags more sophisticated than their
|
||||||
|
Windows/macOS equivalents; doing anything besides taking our existing
|
||||||
|
tried-and-tested approach and streamlining it. These are important
|
||||||
|
issues and other PEPs may address them in the future, but for this PEP
|
||||||
|
they're out of scope.
|
||||||
|
|
||||||
While there is interest in defining tags for non-glibc Linux platforms,
|
|
||||||
this PEP does not attempt to address that.
|
|
||||||
|
|
||||||
Rationale
|
Rationale
|
||||||
=========
|
=========
|
||||||
|
|
||||||
Distributing compiled code for Linux is more complicated than for other popular
|
Python users appreciate it when PyPI has pre-compiled packages for
|
||||||
operating systems, because the Linux kernel and the libraries which typically
|
their platform, because it makes installation fast and simple. But
|
||||||
accompany it are built in different configurations and combinations for different
|
distributing pre-compiled binaries on Linux is challenging because of
|
||||||
distributions. However, there are certain core libraries which can be expected in
|
the diversity of Linux-based platforms. For example, Debian, Android,
|
||||||
many common distributions and are reliably backwards compatible, so binaries
|
and Alpine all use the Linux kernel, but with radically different
|
||||||
built with older versions of these libraries will work with newer versions.
|
userspace libraries, which makes it difficult or impossible to create
|
||||||
:pep:`513` describes these ideas in much more detail.
|
a single wheel that works on all three. This complexity has caused
|
||||||
|
many previous discussions of Linux wheels to stall out.
|
||||||
|
|
||||||
The ``manylinux1`` (:pep:`513`) and ``manylinux2010`` (:pep:`571`) tags make
|
The "manylinux" project succeeded by adopting a strategy of ruthless
|
||||||
use of these features. They define a set of core libraries and symbol versions
|
pragmatism. We chose a large but tractable set of Linux platforms –
|
||||||
which wheels may expect on the system, based on CentOS 5 and 6 respectively.
|
specifically, mainstream glibc-based distributions like Debian,
|
||||||
Typically, packages are built in Docker containers based on these old CentOS
|
OpenSuSE, Ubuntu, RHEL, etc. – and then we did whatever it takes to
|
||||||
versions, and then the ``auditwheel`` tool is used to check them and bundle any
|
make wheels that work across all these platforms.
|
||||||
other linked libraries into the wheel.
|
|
||||||
|
|
||||||
If we were to define a ``manylinux2014`` tag based on CentOS 7, there would be
|
This approach requires many compromises. Manylinux wheels can only
|
||||||
five steps involved to make it practically useful:
|
rely on a external libraries that maintain a consistent ABI and are
|
||||||
|
universally available across all these distributions, which in
|
||||||
|
practice restricts them to a small set of core libraries like glibc
|
||||||
|
and a few others. Wheels have to be built on carefully-chosen
|
||||||
|
platforms of the oldest possible vintage, using a Python that is
|
||||||
|
itself built in a carefully-chosen configuration. Other shared library
|
||||||
|
dependencies have to be bundled into the wheel, which requires a
|
||||||
|
complex process to avoid collisions between unrelated wheels. And
|
||||||
|
finally, the details of these requirements change over time, as new
|
||||||
|
distro versions are released, and old ones fall out of use.
|
||||||
|
|
||||||
1. Write a PEP
|
It turns out that these requirements are not too onerous: they're
|
||||||
2. Prepare docker images based on CentOS 7.
|
essentially equivalent to what you have to do to ship Windows or macOS
|
||||||
3. Add the definition to auditwheel
|
wheels, and the manylinux approach has achieved substantial uptake
|
||||||
4. Allow uploads with the new tag on PyPI
|
among both package maintainers and end-users. But any manylinux PEP
|
||||||
5. Add code to pip to recognise the new tag and check if the platform is
|
needs some way to address these complexities.
|
||||||
compatible
|
|
||||||
|
|
||||||
Although preparing the docker images and updating auditwheel take more work,
|
In previous manylinux PEPs (:pep:`513`, :pep:`571`), we've done this
|
||||||
these parts can be used as soon as that work is complete. The changes to pip
|
by attempting to write down in the PEP the exact set of libraries,
|
||||||
are more straightforward, but not all users will promptly install a new version
|
symbol versions, Python configuration, etc. that we believed would
|
||||||
of pip, so distributors are concerned about moving to a new tag too quickly.
|
lead to wheels that work on all mainstream glibc-based Linux systems.
|
||||||
|
But this created several problems:
|
||||||
|
|
||||||
This PEP aims to remove the need for steps 1 and 5 above, so new manylinux tags
|
First, PEPs are generally supposed to be normative references: if
|
||||||
can be adopted more easily.
|
software doesn't match the PEP, then we fix the software. But in this
|
||||||
|
case, the PEPs are attempting to describe Linux distributions, which
|
||||||
|
are a moving target, and do not consider our PEPs to constrain their
|
||||||
|
behavior. This means that we've been taking on an unbounded commitment
|
||||||
|
to keep updating every manylinux PEP whenever the Linux distro
|
||||||
|
landscape changes. This is a substantial commitment for unfunded
|
||||||
|
volunteers to take on, and it's not clear that this work produces
|
||||||
|
value for our users.
|
||||||
|
|
||||||
Naming
|
And second, every time we move manylinux forward to a newer range of
|
||||||
======
|
supported platforms, or add support for a new architecture, we have to
|
||||||
|
go through a fairly elaborate process: writing a new PEP, updating the
|
||||||
|
PyPI and pip codebases to recognize the new tag, waiting for the new
|
||||||
|
pip to percolate to users, etc. None of this happens on Windows/macOS;
|
||||||
|
it's only a tax on Linux maintainers. This slows deployment of new
|
||||||
|
manylinux versions, and consumes part of our community's limited PEP
|
||||||
|
review bandwidth, thus slowing progress of the Python packaging
|
||||||
|
ecosystem as a whole. This is especially problematic for less-popular
|
||||||
|
architectures, who have less volunteer resources to overcome these
|
||||||
|
barriers.
|
||||||
|
|
||||||
|
How can we fix it?
|
||||||
|
|
||||||
|
A manylinux PEP has to address three main audiences:
|
||||||
|
|
||||||
|
- **Package installers**, like pip, need to be able to determine which
|
||||||
|
wheel tags are compatible with the system they find themselves
|
||||||
|
running on. This requires some automated process to introspect the
|
||||||
|
system and match it up with wheel tags.
|
||||||
|
|
||||||
|
- **Package indexes**, like PyPI, need to be able to validate which
|
||||||
|
wheel tags are valid. Generally, this just requires something like a
|
||||||
|
list of valid tags, or regex they match, with no need to know
|
||||||
|
anything about the actual semantics for individual tags. (But see
|
||||||
|
the discussion of upload verification below.)
|
||||||
|
|
||||||
|
- **Package maintainers** need to be able to build wheels that meet
|
||||||
|
the requirements for a given wheel tag.
|
||||||
|
|
||||||
|
Here's the key insight behind this new PEP: it's crucial that
|
||||||
|
different **package installers** and **package indexes** all agree on
|
||||||
|
which manylinux tags are valid and which systems they install on, so
|
||||||
|
we need a PEP to specify these – but, these are straightforward, and
|
||||||
|
don't really change between manylinux versions. The complicated part
|
||||||
|
that keeps changing is the process of actually **building the wheels**
|
||||||
|
– but, if there are multiple competing build environments, it *doesn't
|
||||||
|
matter* whether they use exactly the same rules as each other, as long
|
||||||
|
as they all produce wheels that work on end-user systems. Therefore,
|
||||||
|
we don't need an interoperability standard for building wheels, so we
|
||||||
|
don't need to write the details into a PEP.
|
||||||
|
|
||||||
|
To further convince ourselves that this approach will work, let's look
|
||||||
|
again at how we handle wheels on Windows and macOS: the PEPs describe
|
||||||
|
which tags are valid, and which systems they're supposed to work on,
|
||||||
|
but not how to actually build wheels for those platforms. And in
|
||||||
|
practice, if you want to distribute Windows or macOS wheels, you might
|
||||||
|
have to jump through some complicated and poorly documented hoops in
|
||||||
|
order to bundle dependencies, target the right range of OS versions,
|
||||||
|
etc. But the system works, and the way to improve it is to write
|
||||||
|
better docs and build better tooling; no-one thinks that the way to
|
||||||
|
make Windows wheels work better is to publish a PEP describing
|
||||||
|
which symbols we think Microsoft should be including in their
|
||||||
|
libraries and how their linker ought to work. This PEP extends that
|
||||||
|
philosophy to manylinux as well.
|
||||||
|
|
||||||
|
|
||||||
|
Specification
|
||||||
|
=============
|
||||||
|
|
||||||
|
Core definition
|
||||||
|
---------------
|
||||||
|
|
||||||
Tags using the new scheme will look like::
|
Tags using the new scheme will look like::
|
||||||
|
|
||||||
manylinux_glibc_2_17_x86_64
|
manylinux_2_17_x86_64
|
||||||
|
|
||||||
Where ``2_17`` is the major and minor version of glibc. I.e. for this example,
|
Or more generally::
|
||||||
the platform must have glibc 2.17 or newer. Installer tools should be prepared
|
|
||||||
to handle any numeric values here, but building and publishing wheels to PyPI
|
|
||||||
will probably be constrained to specific profiles defined by auditwheel.
|
|
||||||
|
|
||||||
The existing manylinux tags can also be represented in the new scheme,
|
manylinux_${GLIBCMAJOR}_${GLIBCMINOR}_${ARCH}
|
||||||
for instance:
|
|
||||||
|
|
||||||
- ``manylinux1_x86_64`` becomes ``manylinux_glibc_2_5_x86_64``
|
This tag is a promise: the wheel's creator promises that the wheel
|
||||||
- ``manylinux2010_x86_64`` becomes ``manylinux_glibc_2_12_x86_64``
|
will work on any mainstream Linux distro that uses glibc version
|
||||||
|
``${GLIBCMAJOR}.${GLIBCMINOR}`` or later, and where the ``${ARCH}``
|
||||||
|
matches the return value from ``distutils.util.get_platform()``. (For
|
||||||
|
more detail about architecture tags, see :pep:`425`.)
|
||||||
|
|
||||||
``x86_64`` refers to the CPU architecture, as in previous tags.
|
If a user installs this wheel into an environment that matches these
|
||||||
|
requirements and it doesn't work, then that wheel does not comply with
|
||||||
|
this specification. This should be considered a bug in the wheel, and
|
||||||
|
it's the wheel creator's responsibility to look for a fix (possibly
|
||||||
|
with the help of the broader community).
|
||||||
|
|
||||||
While this PEP does not attempt to define tags for non-glibc Linux, the name
|
The word "mainstream" is intentionally somewhat vague, and should be
|
||||||
glibc is included to leave room for future efforts in that direction.
|
interpreted expansively. The goal is to rule out weird homebrew Linux
|
||||||
|
systems; generally any distro you've actually heard of should be
|
||||||
|
considered "mainstream". We also provide a way for maintainers of
|
||||||
|
"weird" distros to manually override this check, though based on
|
||||||
|
experience with previous manylinux PEPs, we don't expect this feature
|
||||||
|
to see much use.
|
||||||
|
|
||||||
Wheel compatibility
|
And finally, compliant wheels are required to "play well with others",
|
||||||
===================
|
i.e., installing a manylinux wheel must not cause other unrelated
|
||||||
|
packages to break.
|
||||||
|
|
||||||
There are two components to a tag definition: a specification of what makes a
|
Any method of producing wheels which meets these criteria is
|
||||||
compatible wheel, and of what makes a compatible platform.
|
acceptable. However, in practice we expect that the auditwheel project
|
||||||
|
will maintain an up-to-date set of tools and build images for
|
||||||
|
producing manylinux wheels, and that most maintainers will want to use
|
||||||
|
those. For the latest information on building manylinux wheels,
|
||||||
|
including recommendations about which build images to use, see
|
||||||
|
https://packaging.python.org.
|
||||||
|
|
||||||
A wheel may never use symbols from a newer version of glibc than that indicated
|
Since these requirements are fairly high-level, here are some examples
|
||||||
by its tag. Likewise, a wheel with a glibc tag under this scheme may not be
|
of how they play out in specific situations:
|
||||||
linked against another libc implementation.
|
|
||||||
|
|
||||||
As with the previous manylinux tags, wheels will be allowed to link against
|
Example: if a wheel is tagged as ``manylinux_2_17_x86_64``, but it
|
||||||
a limited set of external libraries and symbols. These will be defined by
|
uses symbols that were only added in glibc 2.18, then that wheel won't
|
||||||
profiles documented on https://packaging.python.org/ and implemented in
|
work on systems with glibc 2.17. Therefore, we can conclude that this
|
||||||
auditwheel. At least initially, they will likely be similar to
|
wheel is in violation of this specification.
|
||||||
the list for manylinux2010 (:pep:`571`), and based on library versions in
|
|
||||||
newer versions of CentOS.
|
|
||||||
|
|
||||||
The overall goal is to ensure that if a wheel is tagged as
|
Example: Until ~2017, all major Linux distros included
|
||||||
``manylinux_glibc_2_Y``, then users can be reasonably confident that this wheel
|
``libncursesw.so.5`` as part of their default install. Until that
|
||||||
will work in any real-world linux-based python environment that uses
|
date, a wheel that linked to ``libncursesw.so.5`` was compliant with
|
||||||
``glibc 2.Y`` or later and matches the other wheel compatibility tags.
|
this specification. Then, distros started switching to ncurses 6,
|
||||||
For example, this includes making sure that the wheel only uses symbols that
|
which has a different name and incompatible ABI, and stopped
|
||||||
are available in the oldest supported glibc, and doesn't rely on the system to
|
installing ``libncursesw.so.5`` by default. So after that date, a
|
||||||
provide any libraries that aren't universally available.
|
wheel that links to ``libncursesw.so.5`` was no longer compliant with
|
||||||
|
this specification.
|
||||||
|
|
||||||
One of the central points of this PEP is to move away from defining each
|
Example: The Linux ELF linker places all shared library SONAMEs into a
|
||||||
compatibility profile in its own PEP.
|
single process-global namespace. If independent wheels used the same
|
||||||
In part, this is to acknowledge that the details of compatibility profiles
|
SONAME for their bundled libraries, they might end up colliding and
|
||||||
evolve over time as the Linux distribution landscape changes and as we learn
|
using the wrong library version, which would violate the "play well
|
||||||
more about real-world compatibility pitfalls.
|
with others" rule. Therefore, this specification requires that wheels
|
||||||
For instance, Fedora 30 `removed <https://github.com/pypa/manylinux/issues/305>`__
|
use globally-unique names for all bundled libraries. (Auditwheel
|
||||||
``libcrypt.so.1``, which both ``manylinux1`` and ``manylinux2010`` previously
|
currently accomplishes this by renaming all bundled libraries to
|
||||||
allowed wheels to externally link.
|
include a globally-unique hash.)
|
||||||
Auditwheel and the manylinux build images will be updated to avoid new wheels
|
|
||||||
relying on this as an external library.
|
|
||||||
|
|
||||||
As with the previous manylinux tags, required libraries which are not on
|
Example: we've observed certain wheels using C++ in ways that
|
||||||
the whitelist will need to be bundled into the wheel.
|
`interfere with other packages
|
||||||
|
<https://github.com/apache/arrow/pull/2210>`__ via an unclear
|
||||||
|
mechanism. This is also a violation of the "play well with others"
|
||||||
|
rule, so those wheels aren't compliant with this specification.
|
||||||
|
|
||||||
Building compatible wheels
|
Example: The imaginary architecture LEG v7 has both big-endian and
|
||||||
--------------------------
|
little-endian variants. Big-endian binaries require a big-endian
|
||||||
|
system, and little-endian binaries require a little-endian system. But
|
||||||
|
unfortunately, it's discovered that due to a bug in :pep:`425`, both
|
||||||
|
variants use the same architecture tag, ``legv7``. This makes it
|
||||||
|
impossible to create a compliant ``manylinux_2_17_legv7`` wheel: no
|
||||||
|
matter what we do, it will crash on some user's systems. So, we write
|
||||||
|
a new PEP defining architecture tags ``legv7le`` and ``legv7be``; now
|
||||||
|
we can ship manylinux LEG v7 wheels.
|
||||||
|
|
||||||
For each profile defined on https://packaging.python.org/, we plan to provide
|
Example: There's also a LEG v8. It also has big-endian and
|
||||||
a canonical build environment, such as a Docker image, available for people to
|
little-endian variants. But fortunately, it turns out that :pep:`425`
|
||||||
build wheels for that profile.
|
already does the right thing LEG v8, so LEG v8 enthusiasts can start
|
||||||
People can build in other environments, so long as the
|
shipping ``manylinux_2_17_legv8le`` and ``manylinux_2_17_legv8be``
|
||||||
resulting wheels can be verified by auditwheel, but the canonical environments
|
wheels immediately once this PEP is implemented, even though the
|
||||||
hopefully provide an easy answer for most packages.
|
authors of this PEP don't know anything at all about LEG v8.
|
||||||
|
|
||||||
The definition of a new profile may well precede the construction of its
|
|
||||||
build environment; it's not expected that the definition in auditwheel
|
|
||||||
is held up until a corresponding environment is ready to use.
|
|
||||||
|
|
||||||
Verification on upload
|
Legacy manylinux tags
|
||||||
----------------------
|
---------------------
|
||||||
|
|
||||||
In the future, PyPI may begin using auditwheel to automatically validate
|
The existing manylinux tags are redefined as aliases for new-style
|
||||||
uploaded manylinux wheels, and reject wheels that it can't determine are
|
tags:
|
||||||
compliant. If PyPI does this, then it will mean that only wheels that have a
|
|
||||||
corresponding auditwheel profile can be distributed publicly.
|
|
||||||
|
|
||||||
If you need manylinux support for a platform that currently has no profile
|
- ``manylinux1_x86_64`` is now an alias for ``manylinux_2_5_x86_64``
|
||||||
in auditwheel, then you're encouraged to contribute a profile to auditwheel.
|
- ``manylinux1_i686`` is now an alias for ``manylinux_2_5_i686``
|
||||||
If that's not possible for some reason, then other tools can be used,
|
- ``manylinux2010_x86_64`` is now an alias for ``manylinux_2_12_x86_64``
|
||||||
as long as you try to meet the same goal as auditwheel (i.e., the wheel should
|
- ``manylinux2010_i686`` is now an alias for ``manylinux_2_12_i686``
|
||||||
work in all environments with the given glibc version and architecture) –
|
|
||||||
though you may not be able to upload these wheels to PyPI.
|
|
||||||
|
|
||||||
Platform compatibility
|
This redefinition is largely a no-op, but does affect a few things:
|
||||||
======================
|
|
||||||
|
|
||||||
The checks for a compatible platform on installation consist of a heuristic
|
- Previously, we had an open-ended and growing commitment to keep
|
||||||
and an optional override. The heuristic is that the platform is compatible if
|
updating every manylinux PEP whenever a new Linux distro was
|
||||||
and only if it has a version of glibc equal to or greater than that indicated
|
released, for the rest of time. By making this PEP normative for the
|
||||||
in the tag name.
|
older tags, that obligation goes away.
|
||||||
|
|
||||||
The override is defined in an importable ``_manylinux`` module,
|
- The "play well with others" rule was always intended, but previous
|
||||||
the same as already used for manylinux1 and manylinux2010 overrides.
|
PEPs didn't state it explicitly; now it's explicit.
|
||||||
For the new scheme, this module must define a function rather than an
|
|
||||||
attribute. ``manylinux_glibc_compatible(major, minor)`` takes two integers
|
|
||||||
for the glibc version number in the tag, and returns True, False or None.
|
|
||||||
If it is not defined or it returns None, the default heuristic is used.
|
|
||||||
|
|
||||||
The compatibility check could be implemented like this::
|
- Previous PEPs assumed that glibc 3.x might be incompatible with
|
||||||
|
glibc 2.x, so we checked for compatibility between a system and a
|
||||||
|
tag using logic like::
|
||||||
|
|
||||||
def is_manylinux_glibc_compatible(major, minor):
|
sys_major == tag_major and sys_minor >= tag_minor
|
||||||
# Check for presence of _manylinux module
|
|
||||||
|
Recently the glibc maintainers `advised us
|
||||||
|
<https://sourceware.org/bugzilla/show_bug.cgi?id=24636>`__ that we
|
||||||
|
should assume that glibc will maintain backwards-compatibility
|
||||||
|
indefinitely, even if they bump the major version number. So the new
|
||||||
|
check for compatibility is::
|
||||||
|
|
||||||
|
(sys_major, sys_minor) >= (tag_major, tag_minor)
|
||||||
|
|
||||||
|
|
||||||
|
Package installers
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Generally, package installers should install manylinux wheels on
|
||||||
|
systems that have an appropriate glibc and architecture, and not
|
||||||
|
otherwise. If there are multiple compatible manylinux wheels
|
||||||
|
available, then the wheel with the highest glibc version should be
|
||||||
|
preferred, in order to take advantage of newer compilers and glibc
|
||||||
|
features.
|
||||||
|
|
||||||
|
In addition, we follow previous specifications, and allow for Python
|
||||||
|
distributors to manually override this check by adding a
|
||||||
|
``_manylinux`` module to their standard library. If this package is
|
||||||
|
importable, and if it defines a function called
|
||||||
|
``manylinux_compatible``, then package installers should call this
|
||||||
|
function, passing in the major version, minor version, and
|
||||||
|
architecture from the manylinux tag, and it will either return a
|
||||||
|
boolean saying whether wheels with the given tag should be considered
|
||||||
|
compatible with the current system, or else ``None`` to indicate that
|
||||||
|
the default logic should be used.
|
||||||
|
|
||||||
|
For compatibility with previous specifications, if the tag is
|
||||||
|
``manylinux1`` or ``manylinux_2_5`` exactly, then we also check the
|
||||||
|
module for a boolean attribute ``manylinux1_compatible``, and if the
|
||||||
|
tag version is ``manylinux2010`` or ``manylinux_2_12`` exactly, then
|
||||||
|
we also check the module for a boolean attribute
|
||||||
|
``manylinux2010_compatible``. If both the new and old attributes are
|
||||||
|
defined, then ``manylinux_compatible`` takes precedence.
|
||||||
|
|
||||||
|
Here's some example code. You don't have to actually use this code,
|
||||||
|
but you can use it for reference if you have questions about the exact
|
||||||
|
semantics::
|
||||||
|
|
||||||
|
LEGACY_ALIASES = {
|
||||||
|
"manylinux1_x86_64": "manylinux_2_5_x86_64",
|
||||||
|
"manylinux1_i686": "manylinux_2_5_i686",
|
||||||
|
"manylinux2010_x86_64": "manylinux_2_12_x86_64",
|
||||||
|
"manylinux2010_i686": "manylinux_2_12_i686",
|
||||||
|
}
|
||||||
|
|
||||||
|
def manylinux_tag_is_compatible_with_this_system(tag):
|
||||||
|
# Normalize and parse the tag
|
||||||
|
tag = LEGACY_ALIASES.get(tag, tag)
|
||||||
|
m = re.match("manylinux_([0-9]+)_([0-9]+)_(.*)", tag)
|
||||||
|
if not m:
|
||||||
|
return False
|
||||||
|
tag_major_str, tag_minor_str, tag_arch = m.groups()
|
||||||
|
tag_major = int(tag_major_str)
|
||||||
|
tag_minor = int(tag_minor_str)
|
||||||
|
|
||||||
|
# Check for manual override
|
||||||
try:
|
try:
|
||||||
import _manylinux
|
import _manylinux
|
||||||
f = _manylinux.manylinux_glibc_compatible
|
except ImportError:
|
||||||
except (ImportError, AttributeError):
|
|
||||||
# Fall through to heuristic check below
|
|
||||||
pass
|
pass
|
||||||
else:
|
else:
|
||||||
compat = f(major, minor)
|
if hasattr(_manylinux, "manylinux_compatible"):
|
||||||
if compat is not None:
|
result = _manylinux.manylinux_compatible(
|
||||||
return bool(compat)
|
tag_major, tag_minor, tag_arch,
|
||||||
|
)
|
||||||
|
if result is not None:
|
||||||
|
return bool(result)
|
||||||
|
else:
|
||||||
|
if (tag_major, tag_minor) == (2, 5):
|
||||||
|
if hasattr(_manylinux, "manylinux1_compatible"):
|
||||||
|
return bool(_manylinux.manylinux1_compatible)
|
||||||
|
if (tag_major, tag_minor) == (2, 12):
|
||||||
|
if hasattr(_manylinux, "manylinux2010_compatible"):
|
||||||
|
return bool(_manylinux.manylinux2010_compatible)
|
||||||
|
|
||||||
# Check glibc version.
|
# Fall back on autodetection. See the pip source code for
|
||||||
# PEP 513 contains an implementation of this function.
|
# ideas on how to implement the helper functions.
|
||||||
return have_compatible_glibc(major, minor)
|
if not system_uses_glibc():
|
||||||
|
return False
|
||||||
|
sys_major, sys_minor = get_system_glibc_version()
|
||||||
|
sys_arch = get_system_arch()
|
||||||
|
return (sys_major, sys_minor) >= (tag_major, tag_minor) and sys_arch == tag_arch
|
||||||
|
|
||||||
The installer should also check that the platform is Linux and that the
|
|
||||||
architecture in the tag matches that of the running interpreter.
|
|
||||||
These checks are not illustrated here.
|
|
||||||
|
|
||||||
Next steps
|
Package indexes
|
||||||
==========
|
---------------
|
||||||
|
|
||||||
There is pressure to create a new manylinux tag to supersede manylinux2010.
|
The exact set of wheel tags accepted by PyPI, or any package index, is
|
||||||
If this PEP is accepted, a priority would be to define and support a
|
a policy question, and up to the maintainers of that index. But, we
|
||||||
``manylinux_glibc_2_17`` profile, based on CentOS 7, equivalent to manylinux2014
|
recommend that package indexes accept any wheels whose platform tag
|
||||||
in the previous numbering system.
|
matches the following regexes:
|
||||||
This would be essentially the same process as defining manylinux2014, and
|
|
||||||
could build upon the research already started for this.
|
- ``manylinux1_(x86_64|i686)``
|
||||||
|
- ``manylinux2010_(x86_64|i686)``
|
||||||
|
- ``manylinux_[0-9]+_[0-9]+_(.*)``
|
||||||
|
|
||||||
|
Package indexes may impose additional requirements; for example, they
|
||||||
|
might audit uploaded wheels and reject those that contain known
|
||||||
|
problems, such as a ``manylinux_2_17`` wheel that references symbols
|
||||||
|
from later glibc versions, or dependencies on external libraries that
|
||||||
|
are known not to exist on all systems. Or a package index might decide
|
||||||
|
to be conservative and reject wheels tagged ``manylinux_2_999``, on
|
||||||
|
the grounds that no-one knows what the Linux distro landscape will
|
||||||
|
look like when glibc 2.999 is released. We leave the details of any
|
||||||
|
such checks to the discretion of the package index maintainers.
|
||||||
|
|
||||||
Beyond that, pip would need changes to allow it to recognise any
|
|
||||||
``manylinux_glibc_2_*`` tag and check platform compatibility, rather than
|
|
||||||
handling only a whitelist of specific tags.
|
|
||||||
|
|
||||||
Rejected alternatives
|
Rejected alternatives
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
Early versions of this proposed specifying only that wheels using a given tag
|
**Continuing the manylinux20XX series**: As discussed above, this
|
||||||
must work on all mainstream platforms with glibc at or above the version
|
leads to much more effort-intensive, slower, and more complex rollouts
|
||||||
which the tag referred to. This would have left the library and symbol
|
of new versions. And while there are two places where it seems at
|
||||||
whitelists as implementation details of auditwheel. This was felt to be
|
first to have some compensating benefits, if you look more closely
|
||||||
insufficient, so the proposal now includes an intent to document specific
|
this turns out not to be the case.
|
||||||
compatibility profiles as well as defining them in auditwheel.
|
|
||||||
In keeping with the goal of reducing the work involved in defining a new tag,
|
First, this forces us to produce human-readable descriptions of how
|
||||||
it does not attempt to prescribe exactly how to create and update profiles:
|
Linux distros work, in the text of the PEP. But this is less valuable
|
||||||
the ways to do this should evolve with experience.
|
than it might seem at first, and can actually be handled better by the
|
||||||
|
new "perennial" approach anyway.
|
||||||
|
|
||||||
|
If you're trying to build wheels, the main thing you need is a
|
||||||
|
tutorial on how to use the build images and tooling around them. If
|
||||||
|
you're trying to add support for a new build profile or create a
|
||||||
|
competitor to auditwheel, then your best resources will be the
|
||||||
|
auditwheel source code and issue tracker, which are always going to be
|
||||||
|
more detailed, precise, and reliable than a summary spec written in
|
||||||
|
English and without tests. Documentation like the old manylinux20XX
|
||||||
|
PEPs does add value! But in both cases, it's primarily as a secondary
|
||||||
|
reference to provide overview and context.
|
||||||
|
|
||||||
|
And furthermore, the PEP process is poorly suited to maintaining this
|
||||||
|
kind of reference documentation – there's a reason we don't keep the
|
||||||
|
pip user manual in the PEPs repository! The auditwheel maintainers are
|
||||||
|
the best situated to understand what kinds of documentation are useful
|
||||||
|
to their users, and to maintain that documentation over time. For
|
||||||
|
example, there's substantial overlap between the different manylinux
|
||||||
|
versions, and the PEP process currently forces us to handle this by
|
||||||
|
copy-pasting everything between a growing list of documents; instead,
|
||||||
|
the auditwheel maintainers might choose to factor out the common parts
|
||||||
|
into a single piece of shared documentation.
|
||||||
|
|
||||||
|
A related concern was that with the perennial approach, it may become
|
||||||
|
harder for package maintainers to decide which build profile to
|
||||||
|
target: instead of having to pick between ``manylinux1``,
|
||||||
|
``manylinux2010``, ``manylinux2014``, ..., they now have a wider array
|
||||||
|
of options like ``manylinux_2_5``, ``manylinux_2_6``, ...,
|
||||||
|
``manylinux_2_20``, ... But again, we don't believe this will be a
|
||||||
|
problem in practice. In either system, most package maintainers won't
|
||||||
|
be starting by reading PEPs and trying to implement them from scratch.
|
||||||
|
If you're a particularly expert and ambitious package maintainer who
|
||||||
|
needs to target a new version or new architecture, the perennial
|
||||||
|
approach gives you additional flexibility. But for regular everyday
|
||||||
|
maintainers, we expect they'll start from a tutorial like
|
||||||
|
packaging.python.org, and by choosing from existing build images. A
|
||||||
|
tutorial can just as easily recommend ``manylinux_2_17`` as it can
|
||||||
|
recommend ``manylinux2014``, and we expect the actual set of
|
||||||
|
pre-provided build images to be identical in both cases. And again, by
|
||||||
|
maintaining this documentation in the right place, instead of trying
|
||||||
|
to do it PEPs repository, we expect that we'll end up with
|
||||||
|
documentation that's higher-quality and more fitted to purpose.
|
||||||
|
|
||||||
|
Finally, some participants have pointed out that it's very nice to be
|
||||||
|
able to look at a wheel and tell definitively whether it meets the
|
||||||
|
requirements of the spec. With the new "perennial" approach, we can
|
||||||
|
never say with 100% certainty that a wheel does meet the spec, because
|
||||||
|
that depends on the Linux distros. As engineers we have a
|
||||||
|
well-justified dislike for that kind of uncertainty.
|
||||||
|
|
||||||
|
However: as demonstrated by the examples above, we can still tell
|
||||||
|
definitively when a wheel *doesn't* meet the spec, which turns out to
|
||||||
|
be what's important in practice. And, in practice, with the
|
||||||
|
manylinux20XX approach, whenever distros change, we actually change
|
||||||
|
the spec; it takes a bit longer. So even if a wheel was compliant
|
||||||
|
today, it might be become non-compliant tomorrow. This is frustrating,
|
||||||
|
but unfortunately this uncertainty is unavoidable if what you care
|
||||||
|
about is distributing working wheels to users.
|
||||||
|
|
||||||
|
So even on these points where the old approach initially seems to have
|
||||||
|
advantages, we expect the new approach to actually do as well or
|
||||||
|
better.
|
||||||
|
|
||||||
|
**Switching to perennial tags, but continuing to write a PEP for each
|
||||||
|
version**: This was proposed as a kind of hybrid, to try to get some
|
||||||
|
of the advantages of the perennial tagging system – like easier
|
||||||
|
rollouts of new versions – while keeping the advantages of the
|
||||||
|
manylinux20XX scheme, like forcing us to write documentation about
|
||||||
|
Linux distros, simplifying options for package maintainers, and being
|
||||||
|
able to definitively tell when a wheel meets the spec. But as
|
||||||
|
discussed above, on a closer look, it turns out that these advantages
|
||||||
|
are largely illusory. And this also inherits significant
|
||||||
|
*dis*\advantages from the manylinux20XX scheme, like creating
|
||||||
|
indefinite obligations to update a growing list of copy-pasted PEPs.
|
||||||
|
|
||||||
|
**Making auditwheel normative**: Another possibility that was
|
||||||
|
considered was to make auditwheel the normative reference on the
|
||||||
|
definition of manylinux, i.e., a wheel would be compliant if and only
|
||||||
|
if ``auditwheel check`` completed without errors. This was rejected
|
||||||
|
because the point of packaging PEPs is to define interoperability
|
||||||
|
between tools, not to bless specific tools.
|
||||||
|
|
||||||
|
**Adding extra words to the tag string**: Another proposal we
|
||||||
|
considered was to add extra words to the wheel tag, e.g.
|
||||||
|
``manylinux_glibc_2_17`` instead of ``manylinux_2_17``. The motivation
|
||||||
|
would be to leave the door open to other kinds of versioning
|
||||||
|
heuristics in the future – for example, we could have
|
||||||
|
``manylinux_glibc_$VERSION`` and ``manylinux_alpine_$VERSION``.
|
||||||
|
|
||||||
|
But "manylinux" has always been a synonym for "broad compatibility
|
||||||
|
with mainstream glibc-based distros"; reusing it for unrelated build
|
||||||
|
profiles like alpine is more confusing than helpful. Also, some early
|
||||||
|
reviewers who aren't steeped in the details of packaging found the
|
||||||
|
word ``glibc`` actively misleading, jumping to the conclusion that it
|
||||||
|
meant they needed a system with *exactly* that glibc version. And tags
|
||||||
|
like ``manylinux_$VERSION`` and ``alpine_$VERSION`` also have the
|
||||||
|
advantages of parsimony and directness. So we'll go with that.
|
||||||
|
|
Loading…
Reference in New Issue