Address review comments

Signed-off-by: Tushar Goel <[email protected]>

Author: TG1999

src/python_inspector/resolution.py

@@ -14,7 +14,6 @@
 from typing import Generator
 from typing import List
 from typing import NamedTuple
-from typing import Sequence
 from typing import Tuple
 from typing import Union
 from zipfile import ZipFile
@@ -27,8 +26,6 @@
 from packaging.version import Version
 from packaging.version import parse as parse_version
 from resolvelib import AbstractProvider
-from resolvelib import Resolver
-from resolvelib.reporters import BaseReporter
 from resolvelib.structs import DirectedGraph
 
 from _packagedcode.models import DependentPackage
@@ -40,7 +37,6 @@
 from _packagedcode.pypi import can_process_dependent_package
 from python_inspector import utils_pypi
 from python_inspector.setup_py_live_eval import iter_requirements
-from python_inspector.utils_pypi import Environment
 from python_inspector.utils_pypi import PypiSimpleRepository
 
 
@@ -741,49 +737,3 @@ def get_setup_dependencies(location, analyze_setup_py_insecurely=False, use_requ
             yield from parse_reqs_from_setup_py_insecurely(setup_py=setup_py_location)
         else:
             raise Exception("Unable to collect setup.py dependencies securely")
-
-
-def get_resolved_dependencies(
-    requirements: List[Requirement],
-    environment: Environment = None,
-    repos: Sequence[PypiSimpleRepository] = tuple(),
-    as_tree: bool = False,
-    max_rounds: int = 200000,
-    verbose: bool = False,
-    pdt_output: bool = False,
-    analyze_setup_py_insecurely: bool = False,
-    ctx=None,
-):
-    """
-    Return resolved dependencies of a ``requirements`` list of Requirement for
-    an ``enviroment`` 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
-    """
-    try:
-        resolver = Resolver(
-            provider=PythonInputProvider(
-                environment=environment,
-                repos=repos,
-                analyze_setup_py_insecurely=analyze_setup_py_insecurely,
-            ),
-            reporter=BaseReporter(),
-        )
-        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,
-        )
-    except Exception as e:
-        if verbose:
-            if ctx:
-                import click
-
-                click.secho(f"{e!r}", err=True)
-            else:
-                print(f"{e!r}")

src/python_inspector/resolve_cli.py

@@ -11,11 +11,15 @@
 
 import json
 import os
+from functools import partial
 from typing import Dict
 from typing import List
+from typing import Sequence
 
 import click
 from packaging.requirements import Requirement
+from resolvelib import Resolver
+from resolvelib.reporters import BaseReporter
 from tinynetrc import Netrc
 
 from _packagedcode.models import DependentPackage
@@ -27,12 +31,16 @@
 from python_inspector import utils_pypi
 from python_inspector.cli_utils import FileOptionType
 from python_inspector.package_data import get_pypi_data_from_purl
+from python_inspector.resolution import PythonInputProvider
 from python_inspector.resolution import contain_string
+from python_inspector.resolution import format_pdt_tree
+from python_inspector.resolution import format_resolution
 from python_inspector.resolution import get_deps_from_distribution
 from python_inspector.resolution import get_environment_marker_from_environment
+from python_inspector.resolution import get_package_list
 from python_inspector.resolution import get_python_version_from_env_tag
-from python_inspector.resolution import get_resolved_dependencies
 from python_inspector.resolution import parse_deps_from_setup_py_insecurely
+from python_inspector.utils_pypi import Environment
 
 TRACE = False
 
@@ -227,6 +235,13 @@ def resolve_dependencies(
         click.secho("Only one of --json or --json-pdt can be used.", err=True)
         ctx.exit(1)
 
+    options = [f"--requirement {rf}" for rf in requirement_files]
+    options += [f"--specifier {sp}" for sp in specifiers]
+    options += [f"--index-url {iu}" for iu in index_urls]
+    options += [f"--python-version {python_version}"]
+    options += [f"--operating-system {operating_system}"]
+    options += ["--json <file>"]
+
     resolver_api(
         requirement_files=requirement_files,
         setup_py_file=setup_py_file,
@@ -242,25 +257,23 @@ def resolve_dependencies(
         use_pypi_json_api=use_pypi_json_api,
         verbose=verbose,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
-        ctx=ctx,
+        printer=click.secho,
+        raise_error=partial(raise_exception_from_cli, ctx),
+        options=options,
+        write_output=True,
     )
 
 
-def raise_error(message, ctx):
-    """Raise error."""
-    if ctx:
-        click.secho(message, err=True)
-        ctx.exit(1)
-    else:
-        raise ValueError(message)
+def raise_exception_from_cli(ctx, message):
+    click.secho(message, err=True)
+    ctx.exit(1)
 
 
-def print_message(message, ctx):
-    """Print message."""
-    if ctx:
-        click.secho(message)
-    else:
-        print(message)
+def raise_exception(message):
+    """
+    Raise error.
+    """
+    raise Exception(message)
 
 
 def resolver_api(
@@ -278,7 +291,10 @@ def resolver_api(
     use_pypi_json_api=False,
     verbose=False,
     analyze_setup_py_insecurely=False,
-    ctx=None,
+    printer=print,
+    raise_error=raise_exception,
+    options=[],
+    write_output=False,
 ):
     """
     Resolve the dependencies for the package requirements listed in one or
@@ -287,7 +303,7 @@ def resolver_api(
     """
 
     if verbose:
-        print_message("Resolving dependencies...", ctx=ctx)
+        printer("Resolving dependencies...")
 
     if netrc_file:
         if not os.path.exists(netrc_file):
@@ -302,7 +318,7 @@ def resolver_api(
 
     if netrc_file:
         if verbose:
-            print_message(f"Using netrc file {netrc_file}", ctx=ctx)
+            printer(f"Using netrc file {netrc_file}")
         netrc = Netrc(file=netrc_file)
     else:
         netrc = None
@@ -349,7 +365,6 @@ def resolver_api(
                 f"Python version {get_python_version_from_env_tag(python_version)} "
                 f"is not compatible with setup.py {setup_py_file} "
                 f"python_requires {python_requires}",
-                ctx=ctx,
             )
 
         setup_py_file_deps = package_data.dependencies
@@ -399,20 +414,20 @@ def resolver_api(
         )
 
     if not direct_dependencies:
-        raise_error("Error: no requirements requested.", ctx=ctx)
+        raise_error("Error: no requirements requested.")
 
     if verbose:
-        print_message("direct_dependencies:", ctx=ctx)
+        printer("direct_dependencies:")
         for dep in direct_dependencies:
-            print_message(f" {dep}", ctx=ctx)
+            printer(f" {dep}")
 
     # create a resolution environments
     environment = utils_pypi.Environment.from_pyver_and_os(
         python_version=python_version, operating_system=operating_system
     )
 
     if verbose:
-        print_message(f"environment: {environment}", ctx=ctx)
+        printer(f"environment: {environment}")
 
     repos = []
     if not use_pypi_json_api:
@@ -438,9 +453,9 @@ def resolver_api(
                 repos.append(repo)
 
     if verbose:
-        print_message("repos:", ctx=ctx)
+        printer("repos:")
         for repo in repos:
-            print_message(f" {repo}", ctx=ctx)
+            printer(f" {repo}")
 
     # resolve dependencies proper
     resolved_dependencies, purls = resolve(
@@ -449,20 +464,12 @@ def resolver_api(
         repos=repos,
         as_tree=False,
         max_rounds=max_rounds,
-        verbose=verbose,
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
-        ctx=ctx,
+        raise_error=raise_error,
     )
 
-    if ctx:
-        options = [f"--requirement {rf}" for rf in requirement_files]
-        options += [f"--specifier {sp}" for sp in specifiers]
-        options += [f"--index-url {iu}" for iu in index_urls]
-        options += [f"--python-version {python_version}"]
-        options += [f"--operating-system {operating_system}"]
-        options += ["--json <file>"]
-    else:
+    if not options:
         options = [f"requirement_files- {rf}" for rf in requirement_files]
         options += [f"specifiers- {sp}" for sp in specifiers]
         options += [f"index_urls- {iu}" for iu in index_urls]
@@ -500,16 +507,16 @@ def resolver_api(
         packages=packages,
     )
 
-    if ctx:
-        write_output(
+    if write_output:
+        write_output_in_file(
             json_output=json_output or pdt_output,
             output=output,
         )
     else:
         return output
 
     if verbose:
-        print_message("done!", ctx=ctx)
+        printer("done!")
 
 
 def resolve(
@@ -518,10 +525,9 @@ def resolve(
     repos=tuple(),
     as_tree=False,
     max_rounds=200000,
-    verbose=False,
     pdt_output=False,
     analyze_setup_py_insecurely=False,
-    ctx=None,
+    raise_error=raise_exception,
 ):
     """
     Resolve dependencies given a ``direct_dependencies`` list of
@@ -545,15 +551,53 @@ def resolve(
         repos=repos,
         as_tree=as_tree,
         max_rounds=max_rounds,
-        verbose=verbose,
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
-        ctx=ctx,
+        raise_error=raise_error,
     )
 
     return resolved_dependencies, packages
 
 
+def get_resolved_dependencies(
+    requirements: List[Requirement],
+    environment: Environment = None,
+    repos: Sequence[utils_pypi.PypiSimpleRepository] = tuple(),
+    as_tree: bool = False,
+    max_rounds: int = 200000,
+    pdt_output: bool = False,
+    analyze_setup_py_insecurely: bool = False,
+    raise_error=raise_exception,
+):
+    """
+    Return resolved dependencies of a ``requirements`` list of Requirement for
+    an ``enviroment`` 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
+    """
+    try:
+        resolver = Resolver(
+            provider=PythonInputProvider(
+                environment=environment,
+                repos=repos,
+                analyze_setup_py_insecurely=analyze_setup_py_insecurely,
+            ),
+            reporter=BaseReporter(),
+        )
+        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,
+        )
+    except Exception as e:
+        raise_error(f"{e!r}")
+
+
 def get_requirements_from_direct_dependencies(
     direct_dependencies: List[DependentPackage], environment_marker: Dict
 ) -> List[Requirement]:
@@ -571,7 +615,7 @@ def get_requirements_from_direct_dependencies(
                 yield req
 
 
-def write_output(output, json_output):
+def write_output_in_file(output, json_output):
     """
     Write headers, requirements and resolved_dependencies as JSON to ``json_output``.
     Return the output data.

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.3",
+    "tool_version": "0.9.0",
     "options": [
       "--requirement /home/tg1999/Desktop/python-inspector-1/tests/data/azure-devops.req.txt",
       "--index-url https://pypi.org/simple",

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

@@ -2,7 +2,7 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/nexB/python-inspector",
-    "tool_version": "0.8.3",
+    "tool_version": "0.9.0",
     "options": [
       "--requirement /home/tg1999/Desktop/python-inspector-1/tests/data/azure-devops.req.txt",
       "--index-url https://pypi.org/simple",

tests/data/single-url-except-simple-expected.json

@@ -5,7 +5,6 @@
     "tool_version": "0.9.0",
     "options": [
       "--specifier flask",
-      "--index-url https://pypi.org/simple",
       "--index-url https://thirdparty.aboutcode.org/pypi/simple/",
       "--python-version 38",
       "--operating-system linux",

tests/test_resolution.py

@@ -17,9 +17,9 @@
 
 from _packagedcode import models
 from python_inspector.resolution import get_requirements_from_dependencies
-from python_inspector.resolution import get_resolved_dependencies
 from python_inspector.resolution import is_valid_version
 from python_inspector.resolution import parse_reqs_from_setup_py_insecurely
+from python_inspector.resolve_cli import get_resolved_dependencies
 from python_inspector.utils_pypi import PYPI_PUBLIC_REPO
 from python_inspector.utils_pypi import Environment