Skip to content

Commit a2d653d

Browse files
committed
Mention metadata bits in overview
Signed-off-by: Michał Górny <mgorny@quansight.com>
1 parent 5c43293 commit a2d653d

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

peps/pep-0817.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,7 @@ described in `modified wheel filename`_, and are characterizing using
737737
hierarchical structure of namespaces, features and feature values. When
738738
evaluating wheels to install, the installer determines whether variant
739739
properties of a given wheel are compatible with the system, and perform
740-
variant ordering based on the priority of the compatible variant
740+
`variant ordering`_ based on the priority of the compatible variant
741741
properties. This is done in addition to determining the compatibility.
742742
The ordering by variant properties takes precedence over ordering by
743743
tags.
@@ -751,18 +751,22 @@ embedded in the wheel; it can be either provided directly by the
751751
wheel maintainer or queried at wheel build time from an AoT plugin.
752752

753753
Both kinds of plugins are usually implemented as Python packages which
754-
implement the provider plugin API, but they may also be vendored or
754+
implement the `provider plugin API`_, but they may also be vendored or
755755
reimplemented by installers to improve security, as outlined in
756-
`Providers`_.
757-
758-
Plugin packages may be installed in isolated or non-isolated
759-
environments. In particular, all plugins may be returned by the
760-
``get_requires_for_build_wheel()`` hook of a :pep:`517` backend, and
756+
`Providers`_. Plugin packages may be installed in isolated or
757+
non-isolated environments. In particular, all plugins may be returned by
758+
the ``get_requires_for_build_wheel()`` hook of a :pep:`517` backend, and
761759
therefore installed along with other build dependencies. For this
762760
reason, it is important that plugin packages do not narrowly pin
763761
dependencies, as that could prevent different packages from being
764762
installed simultaneously in the same environment.
765763

764+
Metadata governing variant support is defined in ``pyproject.toml``
765+
file, and it is copied into ``variant.json`` file in wheels, as explored
766+
in `metadata in source tree and wheels`_. Additionally, `variant
767+
environment markers`_ can be used to define dependencies specific to a
768+
subset of variants.
769+
766770

767771
Modified wheel filename
768772
-----------------------

0 commit comments

Comments
 (0)