Merge pull request #120 from wimglenn/no-pkginfo

remove dependency on pkginfo

Author: wimglenn

.github/workflows/ci.yml

@@ -15,7 +15,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["2.7", "3.11"]
+        python-version:
+        - "2.7"
+        - "3.7"
+        - "3.8"
+        - "3.9"
+        - "3.10"
+        - "3.11"
 
     steps:
       - uses: "actions/checkout@v3"

johnnydep/__init__.py

@@ -1,5 +1,5 @@
 """Display dependency tree of Python distribution"""
 
-__version__ = "1.19.0"
+__version__ = "1.20.0"
 
 from johnnydep.lib import *

johnnydep/compat.py

@@ -70,4 +70,7 @@ def urlretrieve(url, filename, data=None, auth=None):
 try:
     from zipfile import Path as zipfile_path
 except ImportError:
-    from zipfile39 import Path as zipfile_path
+    try:
+        from zipfile38 import Path as zipfile_path
+    except (ImportError, SyntaxError):
+        from zipfile39 import Path as zipfile_path

johnnydep/lib.py

@@ -11,7 +11,6 @@
 from zipfile import ZipFile
 
 import anytree
-import pkginfo
 import toml
 import tabulate
 import wimpy
@@ -158,18 +157,14 @@ def children(self):
 
     @property
     def homepage(self):
-        for project_url in self.metadata.get("project_urls", []):
+        for project_url in self.metadata.get("project_url", []):
             if project_url.lower().startswith("homepage, "):
                 _, url = project_url.split(", ", 1)
                 return url
         try:
             return self.metadata["home_page"]
         except KeyError:
-            for k in "python.details", "python.project":
-                try:
-                    return self.metadata["extensions"][k]["project_urls"]["Home"]
-                except KeyError:
-                    pass
+            pass
         self.log.info("unknown homepage")
 
     @property
@@ -185,7 +180,7 @@ def license(self):
         # for a list of valid classifiers:
         #   requests.get('https://pypi.python.org/pypi', params={':action': 'list_classifiers'}).text.splitlines()
         self.log.debug("metadata license is not set, checking trove classifiers")
-        for classifier in self.metadata.get("classifiers", []):
+        for classifier in self.metadata.get("classifier", []):
             if classifier.startswith("License :: "):
                 crap, result = classifier.rsplit(" :: ", 1)
                 break
@@ -243,10 +238,10 @@ def version_latest_in_spec(self):
 
     @property
     def extras_available(self):
-        extras = {x for x in self.metadata.get("provides_extras", []) if x}
+        extras = {x for x in self.metadata.get("provides_extra", []) if x}
         for req_str in self.metadata.get("requires_dist", []):
             req = requirements.Requirement(req_str)
-            extras |= set(re.findall(r'extra == "(.*?)"', str(req.marker)))
+            extras |= set(re.findall(r"""extra == ['"](.*?)['"]""", str(req.marker)))
         return sorted(extras)
 
     @property
@@ -256,7 +251,7 @@ def project_name(self):
     @property
     def console_scripts(self):
         eps = [ep for ep in self.entry_points or [] if ep.group == "console_scripts"]
-        return ", ".join(["{} = {}".format(ep.name, ep.value) for ep in eps])
+        return ["{} = {}".format(ep.name, ep.value) for ep in eps]
 
     @property
     def pinned(self):
@@ -435,52 +430,78 @@ def _discover_import_names(whl_file):
     try:
         [top_level_fname] = [x for x in namelist if x.endswith("top_level.txt")]
     except ValueError:
-        log.debug("top_level absent, trying metadata")
-        metadata = _extract_metadata(whl_file)
-        try:
-            public_names = metadata["python.exports"]["modules"] or []
-        except KeyError:
-            # this dist was packaged by a dinosaur, exports is not in metadata.
-            # we gotta do it the hard way ...
-            public_names = []
-            for name in namelist:
-                if ".dist-info/" not in name and ".egg-info/" not in name:
-                    parts = name.split("/")
-                    if len(parts) == 2 and parts[1] == "__init__.py":
-                        # found a top-level package
-                        public_names.append(parts[0])
-                    elif len(parts) == 1:
-                        # TODO: find or make an exhaustive list of file extensions importable
-                        name, ext = os.path.splitext(parts[0])
-                        if ext == ".py" or ext == ".so":
-                            # found a top level module
-                            public_names.append(name)
+        log.debug("top_level.txt absent, iterating contents")
+        # we gotta do it the hard way ...
+        public_names = []
+        for name in namelist:
+            if ".dist-info/" not in name and ".egg-info/" not in name:
+                parts = name.split("/")
+                if len(parts) == 2 and parts[1] == "__init__.py":
+                    # found a top-level package
+                    public_names.append(parts[0])
+                elif len(parts) == 1:
+                    # TODO: find or make an exhaustive list of file extensions importable
+                    name, ext = os.path.splitext(parts[0])
+                    if ext == ".py" or ext == ".so":
+                        # found a top level module
+                        public_names.append(name)
     else:
         all_names = zf.read(top_level_fname).decode("utf-8").strip().splitlines()
         public_names = [n for n in all_names if not n.startswith("_")]
     result = [n.replace("/", ".") for n in public_names]
     return result
 
 
-def _discover_entry_points(whl_file):
-    log = logger.bind(whl_file=whl_file)
-    log.debug("finding entry points")
+def _path_dist(whl_file):
     parts = os.path.basename(whl_file).split("-")
     metadata_path = "-".join(parts[:2]) + ".dist-info/"
     zf_path = zipfile_path(whl_file, metadata_path)
-    path_dist = PathDistribution(zf_path)
+    return PathDistribution(zf_path)
+
+
+def _discover_entry_points(whl_file):
+    log = logger.bind(whl_file=whl_file)
+    log.debug("finding entry points")
+    path_dist = _path_dist(whl_file)
     return path_dist.entry_points
 
 
 def _extract_metadata(whl_file):
     log = logger.bind(whl_file=whl_file)
-    log.debug("searching metadata", whl_file=whl_file)
-    info = pkginfo.get_metadata(whl_file)
-    if info is None:
-        raise JohnnyError("failed to get metadata")
-    data = {k.lower(): v for k,v in vars(info).items()}
-    data.pop("filename", None)
-    return data
+    log.debug("finding metadata", whl_file=whl_file)
+    path_dist = _path_dist(whl_file)
+    message = path_dist.metadata
+    try:
+        result = message.json
+    except AttributeError:
+        # older python
+        multiple_use_keys = {
+            "Classifier",
+            "Platform",
+            "Requires-External",
+            "Obsoletes-Dist",
+            "Supported-Platform",
+            "Provides-Dist",
+            "Requires-Dist",
+            "Project-URL",
+            "Provides-Extra",
+            "Dynamic",
+        }
+        result = {}
+        # https://peps.python.org/pep-0566/#json-compatible-metadata
+        for orig_key in message.keys():
+            k = orig_key.lower().replace("-", "_")
+            if k in result:
+                continue
+            if orig_key in multiple_use_keys:
+                result[k] = message.get_all(orig_key)
+            else:
+                result[k] = message[orig_key]
+        if "description" not in result:
+            payload = message.get_payload()
+            if payload:
+                result["description"] = payload
+    return result
 
 
 def has_error(dist):

setup.py

@@ -22,16 +22,16 @@
         "structlog",
         "tabulate",
         "wimpy",
-        "colorama ; python_version<'3.7' or platform_system=='Windows'",  # structlog
+        "colorama ; python_version < '3.7' or platform_system == 'Windows'",  # structlog
         "cachetools",
         "oyaml",
         "toml",
         "pip",
         "packaging >= 17",
         "wheel >= 0.32.0",
-        "pkginfo >= 1.4.2",
-        "importlib_metadata ; python_version < '3.7'",
-        "zipfile39 ; python_version < '3.9'",
+        "importlib_metadata ; python_version < '3.10'",
+        "zipfile38 ; python_version < '3.8' and python_version != '2.7'",
+        "zipfile39 ; python_version == '2.7'",
     ],
     entry_points={
         "console_scripts": [

tests/test_cli.py

@@ -148,7 +148,7 @@ def test_all_fields_toml_out(mocker, capsys, make_dist):
         requires = []
         required_by = []
         import_names = [ "that",]
-        console_scripts = ""
+        console_scripts = []
         homepage = "https://www.example.org/default"
         extras_available = []
         extras_requested = []

tests/test_gen.py

@@ -23,7 +23,7 @@ def test_generated_metadata_from_dist_name(make_dist):
         "license": "MIT",
         "metadata_version": "2.1",
         "name": "jdtest",
-        "platforms": ["default platform"],
+        "platform": ["default platform"],
         "summary": "default text for metadata summary",
         "version": "0.1.2",
     }
@@ -44,7 +44,7 @@ def test_generated_metadata_from_dist_path(make_dist):
         "license": "MIT",
         "metadata_version": "2.1",
         "name": "jdtest",
-        "platforms": ["default platform"],
+        "platform": ["default platform"],
         "summary": "default text for metadata summary",
         "version": "0.1.2",
     }
@@ -100,7 +100,7 @@ def test_old_metadata_20(add_to_index):
         "license": "MIT",
         "metadata_version": "2.0",
         "name": "m20dist",
-        "platforms": ["default platform"],
+        "platform": ["default platform"],
         "summary": "default text for metadata summary",
         "version": "0.1.2",
     }

tests/test_lib.py

@@ -490,13 +490,6 @@ def test_license_parsing_unknown(make_dist):
     assert JohnnyDist("jdtest").license == ""
 
 
-def test_metadata_cant_be_extracted(make_dist, mocker):
-    make_dist()
-    mocker.patch("pkginfo.get_metadata", return_value=None)
-    with pytest.raises(JohnnyError("failed to get metadata")):
-        JohnnyDist("jdtest")
-
-
 def test_ignore_errors(make_dist):
     make_dist(name="distA", install_requires=["distB1>=1.0"], version="0.1")
     dist = JohnnyDist("distA", ignore_errors=True)
@@ -548,4 +541,4 @@ def test_entry_points(make_dist):
     assert ep.name == "my-script"
     assert ep.group == "console_scripts"
     assert ep.value == "mypkg.mymod:foo"
-    assert dist.console_scripts == "my-script = mypkg.mymod:foo"
+    assert dist.console_scripts == ["my-script = mypkg.mymod:foo"]