Find first PKG-INFO and update tests to abstract the contents.

Author: amjith

metadata_please/sdist.py

@@ -36,7 +36,13 @@ def basic_metadata_from_zip_sdist(zf: ZipFile) -> BasicMetadata:
     else:
         requires_data = b""
 
-    pkg_info = next(f for f in zf.namelist() if f.endswith("/PKG-INFO"))
+    # Find the PKG-INFO file with the shortest path. This is to avoid picking up
+    # a PKG-INFO file from a nested test directory.
+    pkg_info = sorted(
+        (f for f in zf.namelist() if f == "PKG-INFO" or f.endswith("/PKG-INFO")),
+        key=len,
+    )[0]
+
     pkg_info_data = zf.read(pkg_info)
     assert pkg_info_data is not None
 
@@ -74,14 +80,20 @@ def basic_metadata_from_tar_sdist(tf: TarFile) -> BasicMetadata:
     if requires:
         requires_fo = tf.extractfile(requires[0])
         assert requires_fo is not None
+        requires_data = requires_fo.read()
     else:
-        requires_fo = b""
+        requires_data = b""
 
-    pkg_info = next(f for f in tf.getnames() if f.endswith("/PKG-INFO"))
+    # Find the PKG-INFO file with the shortest path. This is to avoid picking up
+    # a PKG-INFO file from a nested test directory.
+    pkg_info = sorted(
+        (f for f in tf.getnames() if f == "PKG-INFO" or f.endswith("/PKG-INFO")),
+        key=len,
+    )[0]
 
     pkg_info_fo = tf.extractfile(pkg_info)
     assert pkg_info_fo is not None
 
     return BasicMetadata.from_sdist_pkg_info_and_requires(
-        pkg_info_fo.read(), requires_fo and requires_fo.read()
+        pkg_info_fo.read(), requires_data
     )

metadata_please/tests/metadata_contents.py

@@ -0,0 +1,15 @@
+METADATA_CONTENTS = b"""\
+Requires-Dist: foo
+Version: 1.2.58
+Summary: Some Summary
+Home-page: http://example.com
+Author: Chicken
+Author-email: [email protected]
+Keywords: farm,animals
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# Foo
+
+A very important package.
+"""

metadata_please/tests/sdist.py

@@ -8,6 +8,7 @@
 )
 from ._tar import MemoryTarFile
 from ._zip import MemoryZipFile
+from .metadata_contents import METADATA_CONTENTS
 
 
 class ZipSdistTest(unittest.TestCase):
@@ -94,10 +95,13 @@ def test_basic_metadata_absl_py_09(self) -> None:
         self.assertEqual({"test"}, bm.provides_extra)
 
     def test_basic_metadata_fields(self) -> None:
+        """
+        Modern setuptools will drop a PKG-INFO file in a sdist that is very similar to the METADATA file in a wheel.
+        """
         z = MemoryZipFile(
             {
                 "foo/__init__.py": b"",
-                "foo.egg-info/PKG-INFO": b"Requires-Dist: foo\nVersion: 1.2.58\nSummary: Some Summary\nHome-page: http://example.com\nAuthor: Chicken\nAuthor-email: [email protected]\nKeywords: farm,animals\nRequires-Python: >=3.6\nDescription-Content-Type: text/markdown",
+                "PKG-INFO": METADATA_CONTENTS,
             }
         )
         bm = basic_metadata_from_zip_sdist(z)  # type: ignore
@@ -109,7 +113,7 @@ def test_basic_metadata_fields(self) -> None:
         self.assertEqual("[email protected]", bm.author_email)
         self.assertEqual("farm,animals", bm.keywords)
         self.assertEqual("text/markdown", bm.long_description_content_type)
-        self.assertEqual(None, bm.description)
+        self.assertEqual("# Foo\n\nA very important package.\n", bm.description)
 
 
 class TarSdistTest(unittest.TestCase):
@@ -150,8 +154,8 @@ def test_basic_metadata(self) -> None:
 
     def test_metadata_fields_from_tar_sdist(self) -> None:
         t = MemoryTarFile(
-            ["foo.egg-info/PKG-INFO", "foo/__init__.py"],
-            read_value=b"""Requires-Dist: foo\nVersion: 1.2.58\nSummary: Some Summary\nHome-page: http://example.com\nAuthor: Chicken\nAuthor-email: [email protected]\nKeywords: farm,animals\nRequires-Python: >=3.6\nDescription-Content-Type: text/markdown\n""",
+            ["PKG-INFO", "foo/__init__.py"],
+            read_value=METADATA_CONTENTS,
         )
         bm = basic_metadata_from_tar_sdist(t)  # type: ignore
         self.assertEqual("1.2.58", bm.version)
@@ -161,4 +165,4 @@ def test_metadata_fields_from_tar_sdist(self) -> None:
         self.assertEqual("[email protected]", bm.author_email)
         self.assertEqual("farm,animals", bm.keywords)
         self.assertEqual("text/markdown", bm.long_description_content_type)
-        self.assertEqual(None, bm.description)
+        self.assertEqual("# Foo\n\nA very important package.\n", bm.description)

metadata_please/tests/wheel.py

@@ -1,7 +1,8 @@
 import unittest
 
-from ..wheel import basic_metadata_from_wheel, from_wheel, InvalidWheel
+from ..wheel import InvalidWheel, basic_metadata_from_wheel, from_wheel
 from ._zip import MemoryZipFile
+from .metadata_contents import METADATA_CONTENTS
 
 
 class WheelTest(unittest.TestCase):
@@ -58,7 +59,7 @@ def test_basic_metadata(self) -> None:
     def test_basic_metadata_more_fields(self) -> None:
         z = MemoryZipFile(
             {
-                "foo.dist-info/METADATA": b"Requires-Dist: foo\nVersion: 1.2.58\nSummary: Some Summary\nHome-page: http://example.com\nAuthor: Chicken\nAuthor-email: [email protected]\nKeywords: farm,animals\nRequires-Python: >=3.6\nDescription-Content-Type: text/markdown",
+                "foo.dist-info/METADATA": METADATA_CONTENTS,
                 "foo/__init__.py": b"",
             }
         )
@@ -71,4 +72,4 @@ def test_basic_metadata_more_fields(self) -> None:
         self.assertEqual("[email protected]", bm.author_email)
         self.assertEqual("farm,animals", bm.keywords)
         self.assertEqual("text/markdown", bm.long_description_content_type)
-        self.assertEqual(None, bm.description)
+        self.assertEqual("# Foo\n\nA very important package.\n", bm.description)