Skip to content

Commit f81db94

Browse files
committed
Accommodate for invalid metadata produced by setuptools
See pypa/setuptools#4759.
1 parent e8d10a9 commit f81db94

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

tests/test_package.py

+31
Original file line numberDiff line numberDiff line change
@@ -460,3 +460,34 @@ def test_malformed_from_file(monkeypatch):
460460
def test_package_from_egg():
461461
filename = "tests/fixtures/twine-3.3.0-py3.9.egg"
462462
package_file.PackageFile.from_filename(filename, comment=None)
463+
464+
465+
@pytest.mark.parametrize(
466+
"read_data, filtered",
467+
[
468+
pytest.param(
469+
"Metadata-Version: 2.1\n"
470+
"Name: test-package\n"
471+
"Version: 1.0.0\n"
472+
"License-File: LICENSE\n",
473+
True,
474+
id="invalid License-File",
475+
),
476+
pytest.param(
477+
"Metadata-Version: 2.4\n"
478+
"Name: test-package\n"
479+
"Version: 1.0.0\n"
480+
"License-File: LICENSE\n",
481+
False,
482+
id="valid License-File",
483+
),
484+
],
485+
)
486+
def test_setuptools_license_file(read_data, filtered, monkeypatch):
487+
"""Drop License-File metadata entries if Metadata-Version is less than 2.4."""
488+
monkeypatch.setattr(package_file.wheel.Wheel, "read", lambda _: read_data)
489+
filename = "tests/fixtures/twine-1.5.0-py2.py3-none-any.whl"
490+
491+
package = package_file.PackageFile.from_filename(filename, comment=None)
492+
meta = package.metadata_dictionary()
493+
assert filtered != ("license_files" in meta)

twine/package.py

+11
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
from typing import Any, Dict, List, NamedTuple, Optional, Tuple
2222

2323
from packaging import metadata
24+
from packaging import version
2425
from rich import print
2526

2627
from twine import bdist
@@ -141,6 +142,16 @@ def from_filename(cls, filename: str, comment: Optional[str]) -> "PackageFile":
141142
for key in unparsed
142143
)
143144
)
145+
# setuptools emits License-File metadata fields while declaring
146+
# Metadata-Version 2.1. This is invalid because the metadata
147+
# specification does not allow to add arbitrary fields, and because
148+
# the semantic implemented by setuptools is different than the one
149+
# described in PEP 639. However, rejecting these packages would be
150+
# too disruptive. Drop License-File metadata entries from the data
151+
# sent to the package index if the declared metadata version is less
152+
# than 2.4.
153+
if version.Version(meta.get("metadata_version", "0")) < version.Version("2.4"):
154+
meta.pop("license_files", None)
144155
try:
145156
metadata.Metadata.from_raw(meta)
146157
except metadata.ExceptionGroup as group:

0 commit comments

Comments
 (0)