Add API function for using cleanly as a library #39

Add metadata support for API
Adjust with the latest changes in output

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

Author: TG1999

src/python_inspector/resolution.py

@@ -743,6 +743,7 @@ def get_resolved_dependencies(
     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
@@ -771,6 +772,9 @@ def get_resolved_dependencies(
         )
     except Exception as e:
         if verbose:
-            import click
+            if ctx:
+                import click
 
-            click.secho(f"{e!r}", err=True)
+                click.secho(f"{e!r}", err=True)
+            else:
+                print(f"{e!r}")

src/python_inspector/resolve_cli.py

@@ -36,7 +36,7 @@
 
 TRACE = False
 
-__version__ = "0.8.1"
+__version__ = "0.9.0"
 
 DEFAULT_PYTHON_VERSION = "38"
 PYPI_SIMPLE_URL = "https://pypi.org/simple"
@@ -227,8 +227,67 @@ def resolve_dependencies(
         click.secho("Only one of --json or --json-pdt can be used.", err=True)
         ctx.exit(1)
 
+    resolver_api(
+        requirement_files=requirement_files,
+        setup_py_file=setup_py_file,
+        specifiers=specifiers,
+        python_version=python_version,
+        operating_system=operating_system,
+        index_urls=index_urls,
+        json_output=json_output,
+        pdt_output=pdt_output,
+        netrc_file=netrc_file,
+        max_rounds=max_rounds,
+        use_cached_index=use_cached_index,
+        use_pypi_json_api=use_pypi_json_api,
+        verbose=verbose,
+        analyze_setup_py_insecurely=analyze_setup_py_insecurely,
+        ctx=ctx,
+    )
+
+
+def raise_error(message, ctx):
+    """Raise error."""
+    if ctx:
+        click.secho(message, err=True)
+        ctx.exit(1)
+    else:
+        raise ValueError(message)
+
+
+def print_message(message, ctx):
+    """Print message."""
+    if ctx:
+        click.secho(message)
+    else:
+        print(message)
+
+
+def resolver_api(
+    requirement_files=[],
+    setup_py_file=None,
+    specifiers=[],
+    python_version=DEFAULT_PYTHON_VERSION,
+    operating_system="linux",
+    index_urls=tuple([PYPI_SIMPLE_URL]),
+    json_output=None,
+    pdt_output=None,
+    netrc_file=None,
+    max_rounds=200000,
+    use_cached_index=False,
+    use_pypi_json_api=False,
+    verbose=False,
+    analyze_setup_py_insecurely=False,
+    ctx=None,
+):
+    """
+    Resolve the dependencies for the package requirements listed in one or
+    more ``requirement_files``, one or more ``specifiers`` and one setuptools
+    ``setup_py_file`` file and save the results as JSON to FILE.
+    """
+
     if verbose:
-        click.secho(f"Resolving dependencies...")
+        print_message("Resolving dependencies...", ctx=ctx)
 
     if netrc_file:
         if not os.path.exists(netrc_file):
@@ -243,7 +302,7 @@ def resolve_dependencies(
 
     if netrc_file:
         if verbose:
-            click.secho(f"Using netrc file {netrc_file}")
+            print_message(f"Using netrc file {netrc_file}", ctx=ctx)
         netrc = Netrc(file=netrc_file)
     else:
         netrc = None
@@ -286,13 +345,12 @@ def resolve_dependencies(
             python_version=get_python_version_from_env_tag(python_version),
             python_requires=python_requires,
         ):
-            click.secho(
+            raise_error(
                 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}",
-                err=True,
+                ctx=ctx,
             )
-            ctx.exit(1)
 
         setup_py_file_deps = package_data.dependencies
         for dep in package_data.dependencies:
@@ -341,21 +399,20 @@ def resolve_dependencies(
         )
 
     if not direct_dependencies:
-        click.secho("Error: no requirements requested.")
-        ctx.exit(1)
+        raise_error("Error: no requirements requested.", ctx=ctx)
 
     if verbose:
-        click.secho("direct_dependencies:")
+        print_message("direct_dependencies:", ctx=ctx)
         for dep in direct_dependencies:
-            click.secho(f" {dep}")
+            print_message(f" {dep}", ctx=ctx)
 
     # create a resolution environments
     environment = utils_pypi.Environment.from_pyver_and_os(
         python_version=python_version, operating_system=operating_system
     )
 
     if verbose:
-        click.secho(f"environment: {environment}")
+        print_message(f"environment: {environment}", ctx=ctx)
 
     repos = []
     if not use_pypi_json_api:
@@ -381,9 +438,9 @@ def resolve_dependencies(
                 repos.append(repo)
 
     if verbose:
-        click.secho("repos:")
+        print_message("repos:", ctx=ctx)
         for repo in repos:
-            click.secho(f" {repo}")
+            print_message(f" {repo}", ctx=ctx)
 
     # resolve dependencies proper
     resolved_dependencies, purls = resolve(
@@ -395,14 +452,23 @@ def resolve_dependencies(
         verbose=verbose,
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
+        ctx=ctx,
     )
 
-    cli_options = [f"--requirement {rf}" for rf in requirement_files]
-    cli_options += [f"--specifier {sp}" for sp in specifiers]
-    cli_options += [f"--index-url {iu}" for iu in index_urls]
-    cli_options += [f"--python-version {python_version}"]
-    cli_options += [f"--operating-system {operating_system}"]
-    cli_options += ["--json <file>"]
+    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:
+        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]
+        options += [f"python-version {python_version}"]
+        options += [f"operating-system {operating_system}"]
+        options += [f"json "]
 
     notice = (
         "Dependency tree generated with python-inspector.\n"
@@ -414,7 +480,7 @@ def resolve_dependencies(
         tool_name="python-inspector",
         tool_homepageurl="https://github.com/nexB/python-inspector",
         tool_version=__version__,
-        options=cli_options,
+        options=options,
         notice=notice,
         warnings=[],
         errors=[],
@@ -434,13 +500,16 @@ def resolve_dependencies(
         packages=packages,
     )
 
-    write_output(
-        json_output=json_output or pdt_output,
-        output=output,
-    )
+    if ctx:
+        write_output(
+            json_output=json_output or pdt_output,
+            output=output,
+        )
+    else:
+        return output
 
     if verbose:
-        click.secho("done!")
+        print_message("done!", ctx=ctx)
 
 
 def resolve(
@@ -452,6 +521,7 @@ def resolve(
     verbose=False,
     pdt_output=False,
     analyze_setup_py_insecurely=False,
+    ctx=None,
 ):
     """
     Resolve dependencies given a ``direct_dependencies`` list of
@@ -478,6 +548,7 @@ def resolve(
         verbose=verbose,
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
+        ctx=ctx,
     )
 
     return resolved_dependencies, packages

tests/data/default-url-expected.json

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

tests/data/environment-marker-test-requirements.txt-expected.json

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

tests/data/frozen-requirements.txt-expected.json

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

tests/data/insecure-setup-2/setup.py-expected.json

@@ -2,7 +2,7 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/nexB/python-inspector",
-    "tool_version": "0.8.1",
+    "tool_version": "0.9.0",
     "options": [
       "--index-url https://pypi.org/simple",
       "--python-version 27",

tests/data/insecure-setup/setup.py-expected.json

@@ -2,7 +2,7 @@
   "headers": {
     "tool_name": "python-inspector",
     "tool_homepageurl": "https://github.com/nexB/python-inspector",
-    "tool_version": "0.8.1",
+    "tool_version": "0.9.0",
     "options": [
       "--index-url https://pypi.org/simple",
       "--python-version 27",

tests/data/pdt-requirements.txt-expected.json

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

tests/data/pinned-pdt-requirements.txt-expected.json

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

tests/data/pinned-requirements.txt-expected.json

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