Skip to content

Clearly specify that the name and version should be normalized for .dist-info and .data directories in wheels #1789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 21, 2025
Merged

Clearly specify that the name and version should be normalized for .dist-info and .data directories in wheels #1789

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f14dab6
Clearly specify that the name and version should be normalized for `.…
brettcannon Jan 15, 2025
5b0cb92
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 15, 2025
f132c2f
Update source/specifications/binary-distribution-format.rst
brettcannon Jan 15, 2025
dbbc9b1
Add an entry to the History section
brettcannon Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions source/specifications/binary-distribution-format.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,10 +150,10 @@ this character cannot appear within any component. This is handled as follows:
- In distribution names, any run of ``-_.`` characters (HYPHEN-MINUS, LOW LINE
and FULL STOP) should be replaced with ``_`` (LOW LINE), and uppercase
characters should be replaced with corresponding lowercase ones. This is
equivalent to regular :ref:`name normalization <name-normalization>` followed by replacing ``-`` with ``_``.
Tools consuming wheels must be prepared to accept ``.`` (FULL STOP) and
uppercase letters, however, as these were allowed by an earlier version of
this specification.
equivalent to regular :ref:`name normalization <name-normalization>` followed
by replacing ``-`` with ``_``. Tools consuming wheels must be prepared to accept
``.`` (FULL STOP) and uppercase letters, however, as these were allowed by an earlier
version of this specification.
- Version numbers should be normalised according to the :ref:`Version specifier
specification <version-specifiers>`. Normalised version numbers cannot contain ``-``.
- The remaining components may not contain ``-`` characters, so no escaping
Expand All @@ -175,8 +175,11 @@ File contents
'''''''''''''

The contents of a wheel file, where {distribution} is replaced with the
name of the package, e.g. ``beaglevote`` and {version} is replaced with
its version, e.g. ``1.0.0``, consist of:
:ref:`normalized name <name-normalization>` of the package, e.g.
``beaglevote`` and {version} is replaced
with its :ref:`normalized version <version-specifiers-normalization>`,
e.g. ``1.0.0``, (with dash/``-`` characters replaced with underscore/``_`` characters
in both fields) consist of:

#. ``/``, the root of the archive, contains all files to be installed in
``purelib`` or ``platlib`` as specified in ``WHEEL``. ``purelib`` and
Expand Down Expand Up @@ -440,6 +443,8 @@ History
may vary between tools).
- December 2024: The :file:`.dist-info/licenses/` directory was specified through
:pep:`639`.
- January 2025: Clarified that name and version needs to be normalized for
``.dist-info`` and ``.data`` directories.


Appendix
Expand Down
Loading