Merge pull request #84 from nexB/metadata_issues

Adapt python-inspector output according to SCTK output

Author: TG1999

CHANGELOG.rst

@@ -2,6 +2,11 @@ Changelog
 =========
 
 
+v0.8.5
+------
+- Adapt python-inspector output according to SCTK output.
+
+
 v0.8.4
 ------
 

src/python_inspector/package_data.py

@@ -13,74 +13,26 @@
 
 from packageurl import PackageURL
 
-from _packagedcode import models
 from _packagedcode.models import PackageData
+from _packagedcode.pypi import get_declared_license
+from _packagedcode.pypi import get_description
+from _packagedcode.pypi import get_keywords
+from _packagedcode.pypi import get_parties
 from python_inspector import utils_pypi
 from python_inspector.resolution import get_python_version_from_env_tag
 from python_inspector.utils_pypi import Environment
 from python_inspector.utils_pypi import PypiSimpleRepository
 
 
-def get_pypi_bugtracker_url(project_urls):
-    bug_tracking_url = project_urls.get("Tracker")
-    if not (bug_tracking_url):
-        bug_tracking_url = project_urls.get("Issue Tracker")
-    if not (bug_tracking_url):
-        bug_tracking_url = project_urls.get("Bug Tracker")
-    return bug_tracking_url
-
-
-def get_pypi_codeview_url(project_urls):
-    code_view_url = project_urls.get("Source")
-    if not (code_view_url):
-        code_view_url = project_urls.get("Code")
-    if not (code_view_url):
-        code_view_url = project_urls.get("Source Code")
-    return code_view_url
-
-
-def get_wheel_download_urls(
-    purl: PackageURL,
-    repos: List[PypiSimpleRepository],
-    environment: Environment,
-    python_version: str,
-) -> List[str]:
-    """
-    Return a list of download urls for the given purl.
-    """
-    for repo in repos:
-        for wheel in utils_pypi.get_supported_and_valid_wheels(
-            repo=repo,
-            name=purl.name,
-            version=purl.version,
-            environment=environment,
-            python_version=python_version,
-        ):
-            yield wheel.download_url
-
-
-def get_sdist_download_url(
-    purl: PackageURL, repos: List[PypiSimpleRepository], python_version: str
-) -> str:
-    """
-    Return a list of download urls for the given purl.
-    """
-    for repo in repos:
-        sdist = utils_pypi.get_valid_sdist(
-            repo=repo,
-            name=purl.name,
-            version=purl.version,
-            python_version=python_version,
-        )
-        if sdist:
-            return sdist.download_url
-
-
 def get_pypi_data_from_purl(
     purl: str, environment: Environment, repos: List[PypiSimpleRepository]
 ) -> PackageData:
     """
-    Generate `Package` object from the `purl` string of npm type
+    Generate `Package` object from the `purl` string of pypi type
+
+    ``purl`` is a package-url of pypi type
+    ``environment`` is a `Environment` object defaulting Python version 3.8 and linux OS
+    ``repos`` is a list of `PypiSimpleRepository` objects
     """
     purl = PackageURL.from_string(purl)
     name = purl.name
@@ -96,7 +48,6 @@ def get_pypi_data_from_purl(
         return []
     info = response.get("info") or {}
     homepage_url = info.get("home_page")
-    license = info.get("license")
     project_urls = info.get("project_urls") or {}
     code_view_url = get_pypi_codeview_url(project_urls)
     bug_tracking_url = get_pypi_bugtracker_url(project_urls)
@@ -125,33 +76,82 @@ def get_pypi_data_from_purl(
         if dist_url not in valid_distribution_urls:
             continue
         digests = url.get("digests") or {}
+
         yield PackageData(
             primary_language="Python",
-            description=info.get("description"),
+            description=get_description(info),
             homepage_url=homepage_url,
             api_data_url=api_url,
             bug_tracking_url=bug_tracking_url,
             code_view_url=code_view_url,
-            declared_license=license,
+            declared_license=get_declared_license(info),
             download_url=dist_url,
             size=url.get("size"),
             md5=digests.get("md5") or url.get("md5_digest"),
             sha256=digests.get("sha256"),
             release_date=url.get("upload_time"),
-            keywords=info.get("keywords") or [],
-            parties=[
-                models.Party(
-                    type=models.party_person,
-                    name=info.get("author"),
-                    role="author",
-                    email=info.get("author_email"),
-                ),
-                models.Party(
-                    type=models.party_person,
-                    name=info.get("maintainer"),
-                    role="maintainer",
-                    email=info.get("maintainer_email"),
-                ),
-            ],
+            keywords=get_keywords(info),
+            parties=get_parties(
+                info,
+                author_key="author",
+                author_email_key="author_email",
+                maintainer_key="maintainer",
+                maintainer_email_key="maintainer_email",
+            ),
             **purl.to_dict(),
-        ).to_dict()
+        )
+
+
+def get_pypi_bugtracker_url(project_urls):
+    bug_tracking_url = project_urls.get("Tracker")
+    if not (bug_tracking_url):
+        bug_tracking_url = project_urls.get("Issue Tracker")
+    if not (bug_tracking_url):
+        bug_tracking_url = project_urls.get("Bug Tracker")
+    return bug_tracking_url
+
+
+def get_pypi_codeview_url(project_urls):
+    code_view_url = project_urls.get("Source")
+    if not (code_view_url):
+        code_view_url = project_urls.get("Code")
+    if not (code_view_url):
+        code_view_url = project_urls.get("Source Code")
+    return code_view_url
+
+
+def get_wheel_download_urls(
+    purl: PackageURL,
+    repos: List[PypiSimpleRepository],
+    environment: Environment,
+    python_version: str,
+) -> List[str]:
+    """
+    Return a list of download urls for the given purl.
+    """
+    for repo in repos:
+        for wheel in utils_pypi.get_supported_and_valid_wheels(
+            repo=repo,
+            name=purl.name,
+            version=purl.version,
+            environment=environment,
+            python_version=python_version,
+        ):
+            yield wheel.download_url
+
+
+def get_sdist_download_url(
+    purl: PackageURL, repos: List[PypiSimpleRepository], python_version: str
+) -> str:
+    """
+    Return a list of download urls for the given purl.
+    """
+    for repo in repos:
+        sdist = utils_pypi.get_valid_sdist(
+            repo=repo,
+            name=purl.name,
+            version=purl.version,
+            python_version=python_version,
+        )
+        if sdist:
+            return sdist.download_url

src/python_inspector/resolve_cli.py

@@ -36,7 +36,7 @@
 
 TRACE = False
 
-__version__ = "0.8.4"
+__version__ = "0.8.5"
 
 DEFAULT_PYTHON_VERSION = "38"
 PYPI_SIMPLE_URL = "https://pypi.org/simple"
@@ -424,7 +424,12 @@ def resolve_dependencies(
 
     for package in purls:
         packages.extend(
-            list(get_pypi_data_from_purl(package, repos=repos, environment=environment)),
+            [
+                pkg.to_dict()
+                for pkg in list(
+                    get_pypi_data_from_purl(package, repos=repos, environment=environment)
+                )
+            ],
         )
 
     output = dict(

tests/data/azure-devops.req-310-expected.json

@@ -2,7 +2,7 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/nexB/python-inspector",
-    "tool_version": "0.8.4",
+    "tool_version": "0.8.5",
     "options": [
       "--specifier zipp==3.8.0",
       "--index-url https://pypi.org/simple",