More cleanups.

Signed-off-by: Thomas Neidhart <thomas.neidhart@gmail.com>

Author: netomi

src/python_inspector/api.py

@@ -11,7 +11,7 @@
 import asyncio
 import os
 from netrc import netrc
-from typing import Dict
+from typing import Dict, Tuple
 from typing import List
 from typing import NamedTuple
 from typing import Sequence
@@ -365,14 +365,14 @@ def get_resolved_dependencies(
     pdt_output: bool = False,
     analyze_setup_py_insecurely: bool = False,
     ignore_errors: bool = False,
-):
+) -> Tuple[List[Dict], List[str]]:
     """
     Return resolved dependencies of a ``requirements`` list of Requirement for
-    an ``enviroment`` Environment. The resolved dependencies are formatted as
+    an ``environment`` Environment. The resolved dependencies are formatted as
     parent/children or a nested tree if ``as_tree`` is True.
 
     Used the provided ``repos`` list of PypiSimpleRepository.
-    If empty, use instead the PyPI.org JSON API exclusively instead
+    If empty, use instead the PyPI.org JSON API exclusively instead.
     """
     resolver = Resolver(
         provider=PythonInputProvider(
@@ -386,11 +386,8 @@ def get_resolved_dependencies(
     resolver_results = resolver.resolve(requirements=requirements, max_rounds=max_rounds)
     package_list = get_package_list(results=resolver_results)
     if pdt_output:
-        return (format_pdt_tree(resolver_results), package_list)
-    return (
-        format_resolution(resolver_results, as_tree=as_tree),
-        package_list,
-    )
+        return format_pdt_tree(resolver_results), package_list
+    return format_resolution(resolver_results, as_tree=as_tree), package_list
 
 
 def get_requirements_from_direct_dependencies(

src/python_inspector/dependencies.py

@@ -8,26 +8,26 @@
 # See https://github.com/nexB/skeleton for support or download.
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
+from typing import Iterable, Mapping
 
 from packageurl import PackageURL
 from packvers.requirements import Requirement
-from pip_requirements_parser import InstallRequirement
 
 from _packagedcode import models
+from _packagedcode.models import DependentPackage
 from _packagedcode.pypi import PipRequirementsFileHandler
 from _packagedcode.pypi import get_requirements_txt_dependencies
 
 """
-Utilities to resolve dependencies .
+Utilities to resolve dependencies.
 """
 
 TRACE = False
 
 
-def get_dependencies_from_requirements(requirements_file="requirements.txt"):
+def get_dependencies_from_requirements(requirements_file="requirements.txt") -> Iterable[DependentPackage]:
     """
-    Yield DependentPackage for each requirement in a `requirement`
-    file.
+    Yield DependentPackage for each requirement in a `requirement` file.
     """
     dependent_packages, _ = get_requirements_txt_dependencies(
         location=requirements_file, include_nested=True
@@ -41,21 +41,20 @@ def get_dependencies_from_requirements(requirements_file="requirements.txt"):
         yield dependent_package
 
 
-def get_extra_data_from_requirements(requirements_file="requirements.txt"):
+def get_extra_data_from_requirements(requirements_file="requirements.txt") -> Iterable[Mapping]:
     """
-    Yield extra_data for each requirement in a `requirement`
-    file.
+    Yield extra_data for each requirement in a `requirement` file.
     """
     for package_data in PipRequirementsFileHandler.parse(location=requirements_file):
         yield package_data.extra_data
 
 
-def is_requirement_pinned(requirement: Requirement):
+def is_requirement_pinned(requirement: Requirement) -> bool:
     specifiers = requirement.specifier
     return specifiers and len(specifiers) == 1 and next(iter(specifiers)).operator in {"==", "==="}
 
 
-def get_dependency(specifier):
+def get_dependency(specifier) -> DependentPackage:
     """
     Return a DependentPackage given a requirement ``specifier`` string.
 

src/python_inspector/package_data.py

@@ -9,7 +9,7 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
-from typing import List, Iterable, Optional
+from typing import List, Iterable, Optional, Dict
 
 from packageurl import PackageURL
 
@@ -78,15 +78,15 @@ async def get_pypi_data_from_purl(
         if wheel_url:
             valid_distribution_urls.insert(0, wheel_url)
 
-    urls = {url.get("url"): url for url in response.get("urls", [])}
+    urls = {url.get("url"): url for url in response.get("urls") or []}
     # iterate over the valid distribution urls and return the first
     # one that is matching.
     for dist_url in valid_distribution_urls:
         if dist_url not in urls:
             continue
 
         url_data = urls.get(dist_url)
-        digests = url_data.get("digests", {})
+        digests = url_data.get("digests") or {}
 
         return PackageData(
             primary_language="Python",
@@ -116,16 +116,18 @@ async def get_pypi_data_from_purl(
     return None
 
 
-def choose_single_wheel(wheel_urls):
+def choose_single_wheel(wheel_urls: List[str]) -> Optional[str]:
     """
     Sort wheel urls descendingly and return the first one
     """
     wheel_urls.sort(reverse=True)
     if wheel_urls:
         return wheel_urls[0]
+    else:
+        return None
 
 
-def get_pypi_bugtracker_url(project_urls):
+def get_pypi_bugtracker_url(project_urls: Dict) -> Optional[str]:
     bug_tracking_url = project_urls.get("Tracker")
     if not bug_tracking_url:
         bug_tracking_url = project_urls.get("Issue Tracker")
@@ -134,7 +136,7 @@ def get_pypi_bugtracker_url(project_urls):
     return bug_tracking_url
 
 
-def get_pypi_codeview_url(project_urls):
+def get_pypi_codeview_url(project_urls: Dict) -> Optional[str]:
     code_view_url = project_urls.get("Source")
     if not code_view_url:
         code_view_url = project_urls.get("Code")

src/python_inspector/resolution.py

@@ -11,7 +11,7 @@
 import operator
 import os
 import tarfile
-from typing import Dict
+from typing import Dict, Iterable, Optional
 from typing import Generator
 from typing import List
 from typing import NamedTuple
@@ -70,7 +70,7 @@ class Result(NamedTuple):
 
 
 def get_requirements_from_distribution(
-    handler: BasePypiHandler,
+    handler: type[BasePypiHandler],
     location: str,
 ) -> List[Requirement]:
     """
@@ -84,7 +84,7 @@ def get_requirements_from_distribution(
     reqs = []
     for package_data in handler.parse(location):
         dependencies = package_data.dependencies
-    reqs.extend(get_requirements_from_dependencies(dependencies=dependencies))
+        reqs.extend(get_requirements_from_dependencies(dependencies=dependencies))
     return reqs
 
 
@@ -103,7 +103,7 @@ def get_deps_from_distribution(
     deps = []
     for package_data in handler.parse(location):
         dependencies = package_data.dependencies
-        deps.extend(dependencies=dependencies)
+        deps.extend(dependencies)
     return deps
 
 
@@ -254,7 +254,7 @@ def remove_extras(identifier: str) -> str:
     return name
 
 
-def get_reqs_from_requirements_file_in_sdist(sdist_location: str, files: str) -> List[Requirement]:
+def get_reqs_from_requirements_file_in_sdist(sdist_location: str, files: List) -> List[Requirement]:
     """
     Return a list of parsed requirements from the ``sdist_location`` sdist location
     """
@@ -282,7 +282,7 @@ def get_requirements_from_python_manifest(
     """
     Return a list of parsed requirements from the ``sdist_location`` sdist location
     """
-    # Look in requirements file if and only if they are refered in setup.py or setup.cfg
+    # Look in requirements file if and only if they are referred in setup.py or setup.cfg
     # And no deps have been yielded by requirements file.
     requirements = list(
         get_reqs_from_requirements_file_in_sdist(
@@ -388,7 +388,7 @@ def get_preference(
         return transitive, identifier
 
     def get_versions_for_package(
-        self, name: str, repo: Union[List[PypiSimpleRepository], None] = None
+        self, name: str, repo: Optional[PypiSimpleRepository] = None
     ) -> List[Version]:
         """
         Return a list of versions for a package.
@@ -442,7 +442,7 @@ def get_versions_for_package_from_pypi_json_api(self, name: str) -> List[Version
 
     def get_requirements_for_package(
         self, purl: PackageURL, candidate: Candidate
-    ) -> Generator[Requirement, None, None]:
+    ) -> Iterable[Requirement]:
         """
         Yield requirements for a package.
         """
@@ -524,7 +524,7 @@ def get_requirements_for_package_from_pypi_simple(
 
     def get_requirements_for_package_from_pypi_json_api(
         self, purl: PackageURL
-    ) -> List[Requirement]:
+    ) -> Iterable[Requirement]:
         """
         Return requirements for a package from the PyPI.org JSON API
         """
@@ -548,7 +548,7 @@ def get_candidates(
         bad_versions: List[str],
         name: str,
         extras: Dict,
-    ) -> Generator[Candidate, None, None]:
+    ) -> Iterable[Candidate]:
         """
         Generate candidates for the given identifier. Overridden.
         """
@@ -574,7 +574,7 @@ def _iter_matches(
         incompatibilities: Dict,
     ) -> Generator[Candidate, None, None]:
         """
-        Yield candidates for the given identifier, requirements and incompatibilities
+        Yield candidates for the given identifier, requirements and incompatibilities.
         """
         name = remove_extras(identifier=identifier)
         bad_versions = {c.version for c in incompatibilities[identifier]}

src/python_inspector/utils_pypi.py

@@ -98,7 +98,7 @@
 """
 
 TRACE = False
-TRACE_DEEP = False
+TRACE_DEEP = True
 TRACE_ULTRA_DEEP = False
 
 # Supported environments
@@ -265,7 +265,7 @@ def download_wheel(
             fetched_wheel_filenames.append(fetched_wheel_filename)
 
         if fetched_wheel_filenames:
-            # do not futher fetch from other repos if we find in first, typically PyPI
+            # do not further fetch from other repos if we find in first, typically PyPI
             break
     return fetched_wheel_filenames
 
@@ -1770,7 +1770,7 @@ def get_remote_file_content(
 ):
     """
     Fetch and return a tuple of (headers, content) at `url`. Return content as a
-    text string if `as_text` is True. Otherwise return the content as bytes.
+    text string if `as_text` is True. Otherwise, return the content as bytes.
 
     If `header_only` is True, return only (headers, None). Headers is a mapping
     of HTTP headers.
@@ -1779,7 +1779,7 @@ def get_remote_file_content(
     """
     time.sleep(_delay)
     headers = headers or {}
-    # using a GET with stream=True ensure we get the the final header from
+    # using a GET with stream=True ensure we get the final header from
     # several redirects and that we can ignore content there. A HEAD request may
     # not get us this last header
     if verbose and not echo_func:
@@ -1834,7 +1834,7 @@ def fetch_and_save(
 ):
     """
     Fetch content at ``path_or_url`` URL or path and save this to
-    ``dest_dir/filername``. Return the fetched content. Raise an Exception on
+    ``dest_dir/filename``. Return the fetched content. Raise an Exception on
     errors. Treats the content as text if as_text is True otherwise as treat as
     binary.
     """
@@ -1845,6 +1845,7 @@ def fetch_and_save(
         verbose=verbose,
         echo_func=echo_func,
     )
+
     output = os.path.join(dest_dir, filename)
     wmode = "w" if as_text else "wb"
     with open(output, wmode) as fo: