Skip to content
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

Require normalized versions in wheel filenames #874

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Require normalized versions in wheel filenames #874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3641c01
Ensure version in wheel filename is normalized
di Feb 13, 2025
c62a6f3
Homogenize error messages
di Feb 13, 2025
e086a8c
Assert on error message in test
di Feb 13, 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
12 changes: 10 additions & 2 deletions src/packaging/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,9 @@ def parse_wheel_filename(
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(f"Invalid project name: {filename!r}")
raise InvalidWheelFilename(
f"Invalid wheel filename (invalid project name {name_part!r}): {filename!r}"
)
name = canonicalize_name(name_part)

try:
Expand All @@ -120,12 +122,18 @@ def parse_wheel_filename(
f"Invalid wheel filename (invalid version): {filename!r}"
) from e

if str(version) != parts[1]:
raise InvalidWheelFilename(
f"Invalid wheel filename (non-normalized version): {filename!r}"
)

if dashes == 5:
build_part = parts[2]
build_match = _build_tag_regex.match(build_part)
if build_match is None:
raise InvalidWheelFilename(
f"Invalid build number: {build_part} in {filename!r}"
f"Invalid wheel filename (invalid build number {build_part!r}): "
f"{filename!r}"
)
build = cast(BuildTag, (int(build_match.group(1)), build_match.group(2)))
else:
Expand Down
41 changes: 30 additions & 11 deletions tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,22 +144,41 @@ def test_parse_wheel_filename(filename, name, version, build, tags):


@pytest.mark.parametrize(
("filename"),
("filename", "expected"),
[
("foo-1.0.whl"), # Missing tags
("foo-1.0-py3-none-any.wheel"), # Incorrect file extension (`.wheel`)
("foo__bar-1.0-py3-none-any.whl"), # Invalid name (`__`)
("foo#bar-1.0-py3-none-any.whl"), # Invalid name (`#`)
("foobar-1.x-py3-none-any.whl"), # Invalid version (`1.x`)
# Build number doesn't start with a digit (`abc`)
("foo-1.0-abc-py3-none-any.whl"),
("foo-1.0-200-py3-none-any-junk.whl"), # Too many dashes (`-junk`)
("foo-1.0.whl", "wrong number of parts"),
("foo-1.0-py3-none-any.wheel", "extension must be '.whl'"),
("foo__bar-1.0-py3-none-any.whl", "invalid project name"),
("foo#bar-1.0-py3-none-any.whl", "invalid project name"),
("foobar-1.x-py3-none-any.whl", "invalid version"),
("foo-1.0-abc-py3-none-any.whl", "invalid build number"),
("foo-1.0-200-py3-none-any-junk.whl", "wrong number of parts"),
("foo-01.0.0-py3-none-any.whl", "non-normalized version"),
("foo-1.1RC1-py3-none-any.whl", "non-normalized version"),
("foo-1.1.a1-py3-none-any.whl", "non-normalized version"),
("foo-1.1_a1-py3-none-any.whl", "non-normalized version"),
("foo-1.0a.1-py3-none-any.whl", "non-normalized version"),
("foo-1.1alpha1-py3-none-any.whl", "non-normalized version"),
("foo-1.1beta2-py3-none-any.whl", "non-normalized version"),
("foo-1.1c2-py3-none-any.whl", "non-normalized version"),
("foo-1.2a-py3-none-any.whl", "non-normalized version"),
("foo-1.2_post2-py3-none-any.whl", "non-normalized version"),
("foo-1.2post2-py3-none-any.whl", "non-normalized version"),
("foo-1.2.post.2-py3-none-any.whl", "non-normalized version"),
("foo-1.0.r4-py3-none-any.whl", "non-normalized version"),
("foo-1.2.post-py3-none-any.whl", "non-normalized version"),
("foo-1.2dev2-py3-none-any.whl", "non-normalized version"),
("foo-1.2.dev-py3-none-any.whl", "non-normalized version"),
("foo-1.0+ubuntu_1-py3-none-any.whl", "non-normalized version"),
("foo-v1.0-py3-none-any.whl", "non-normalized version"),
],
)
def test_parse_wheel_invalid_filename(filename):
with pytest.raises(InvalidWheelFilename):
def test_parse_wheel_invalid_filename(filename, expected):
with pytest.raises(InvalidWheelFilename) as e:
parse_wheel_filename(filename)

assert expected in str(e.value)


@pytest.mark.parametrize(
("filename", "name", "version"),
Expand Down
Loading