Skip to content

Commit

Permalink
Changed WheelFile to normalize the .dist-info directory name as per s…
Browse files Browse the repository at this point in the history
…pec.

Fixes #411.
  • Loading branch information
agronholm committed Aug 18, 2021
1 parent 7ab18e4 commit 28b6ced
Show file tree
Hide file tree
Showing 9 changed files with 812 additions and 24 deletions.
1 change: 1 addition & 0 deletions docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Release Notes
**UNRELEASED**

- Fixed ``wheel pack`` duplicating the ``WHEEL`` contents when the build number has changed (#415)
- Fixed normalization of the ``.dist-info`` directory in wheels to conform to the PyPA spec (#441)

**0.37.0 (2021-08-09)**

Expand Down
5 changes: 3 additions & 2 deletions src/wheel/cli/unpack.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ def unpack(path, dest='.'):
:param dest: Destination directory (default to current directory).
"""
with WheelFile(path) as wf:
namever = wf.parsed_filename.group('namever')
destination = os.path.join(dest, namever)
name, version = os.path.basename(path).split('-', 2)[:2]
dirname = name + '-' + version
destination = os.path.join(dest, dirname)
print("Unpacking to: {}...".format(destination), end='')
sys.stdout.flush()
wf.extractall(destination)
Expand Down
86 changes: 86 additions & 0 deletions src/wheel/vendored/packaging/_structures.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
from __future__ import absolute_import, division, print_function


class InfinityType(object):
def __repr__(self):
# type: () -> str
return "Infinity"

def __hash__(self):
# type: () -> int
return hash(repr(self))

def __lt__(self, other):
# type: (object) -> bool
return False

def __le__(self, other):
# type: (object) -> bool
return False

def __eq__(self, other):
# type: (object) -> bool
return isinstance(other, self.__class__)

def __ne__(self, other):
# type: (object) -> bool
return not isinstance(other, self.__class__)

def __gt__(self, other):
# type: (object) -> bool
return True

def __ge__(self, other):
# type: (object) -> bool
return True

def __neg__(self):
# type: (object) -> NegativeInfinityType
return NegativeInfinity


Infinity = InfinityType()


class NegativeInfinityType(object):
def __repr__(self):
# type: () -> str
return "-Infinity"

def __hash__(self):
# type: () -> int
return hash(repr(self))

def __lt__(self, other):
# type: (object) -> bool
return True

def __le__(self, other):
# type: (object) -> bool
return True

def __eq__(self, other):
# type: (object) -> bool
return isinstance(other, self.__class__)

def __ne__(self, other):
# type: (object) -> bool
return not isinstance(other, self.__class__)

def __gt__(self, other):
# type: (object) -> bool
return False

def __ge__(self, other):
# type: (object) -> bool
return False

def __neg__(self):
# type: (object) -> InfinityType
return Infinity


NegativeInfinity = NegativeInfinityType()
138 changes: 138 additions & 0 deletions src/wheel/vendored/packaging/utils.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
# This file is dual licensed under the terms of the Apache License, Version
# 2.0, and the BSD License. See the LICENSE file in the root of this repository
# for complete details.
from __future__ import absolute_import, division, print_function

import re

from ._typing import TYPE_CHECKING, cast
from .tags import Tag, parse_tag
from .version import InvalidVersion, Version

if TYPE_CHECKING: # pragma: no cover
from typing import FrozenSet, NewType, Tuple, Union

BuildTag = Union[Tuple[()], Tuple[int, str]]
NormalizedName = NewType("NormalizedName", str)
else:
BuildTag = tuple
NormalizedName = str


class InvalidWheelFilename(ValueError):
"""
An invalid wheel filename was found, users should refer to PEP 427.
"""


class InvalidSdistFilename(ValueError):
"""
An invalid sdist filename was found, users should refer to the packaging user guide.
"""


_canonicalize_regex = re.compile(r"[-_.]+")
# PEP 427: The build number must start with a digit.
_build_tag_regex = re.compile(r"(\d+)(.*)")


def canonicalize_name(name):
# type: (str) -> NormalizedName
# This is taken from PEP 503.
value = _canonicalize_regex.sub("-", name).lower()
return cast(NormalizedName, value)


def canonicalize_version(version):
# type: (Union[Version, str]) -> Union[Version, str]
"""
This is very similar to Version.__str__, but has one subtle difference
with the way it handles the release segment.
"""
if not isinstance(version, Version):
try:
version = Version(version)
except InvalidVersion:
# Legacy versions cannot be normalized
return version

parts = []

# Epoch
if version.epoch != 0:
parts.append("{0}!".format(version.epoch))

# Release segment
# NB: This strips trailing '.0's to normalize
parts.append(re.sub(r"(\.0)+$", "", ".".join(str(x) for x in version.release)))

# Pre-release
if version.pre is not None:
parts.append("".join(str(x) for x in version.pre))

# Post-release
if version.post is not None:
parts.append(".post{0}".format(version.post))

# Development release
if version.dev is not None:
parts.append(".dev{0}".format(version.dev))

# Local version segment
if version.local is not None:
parts.append("+{0}".format(version.local))

return "".join(parts)


def parse_wheel_filename(filename):
# type: (str) -> Tuple[NormalizedName, Version, BuildTag, FrozenSet[Tag]]
if not filename.endswith(".whl"):
raise InvalidWheelFilename(
"Invalid wheel filename (extension must be '.whl'): {0}".format(filename)
)

filename = filename[:-4]
dashes = filename.count("-")
if dashes not in (4, 5):
raise InvalidWheelFilename(
"Invalid wheel filename (wrong number of parts): {0}".format(filename)
)

parts = filename.split("-", dashes - 2)
name_part = parts[0]
# See PEP 427 for the rules on escaping the project name
if "__" in name_part or re.match(r"^[\w\d._]*$", name_part, re.UNICODE) is None:
raise InvalidWheelFilename("Invalid project name: {0}".format(filename))
name = canonicalize_name(name_part)
version = Version(parts[1])
if dashes == 5:
build_part = parts[2]
build_match = _build_tag_regex.match(build_part)
if build_match is None:
raise InvalidWheelFilename(
"Invalid build number: {0} in '{1}'".format(build_part, filename)
)
build = cast(BuildTag, (int(build_match.group(1)), build_match.group(2)))
else:
build = ()
tags = parse_tag(parts[-1])
return (name, version, build, tags)


def parse_sdist_filename(filename):
# type: (str) -> Tuple[NormalizedName, Version]
if not filename.endswith(".tar.gz"):
raise InvalidSdistFilename(
"Invalid sdist filename (extension must be '.tar.gz'): {0}".format(filename)
)

# We are requiring a PEP 440 version, which cannot contain dashes,
# so we split on the last dash.
name_part, sep, version_part = filename[:-7].rpartition("-")
if not sep:
raise InvalidSdistFilename("Invalid sdist filename: {0}".format(filename))

name = canonicalize_name(name_part)
version = Version(version_part)
return (name, version)
Loading

0 comments on commit 28b6ced

Please sign in to comment.