feat: Replace old print/echo calls to new logger function

Signed-off-by: Helio Chissini de Castro <[email protected]>

Author: heliocastro

src/python_inspector/api.py

@@ -9,6 +9,7 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 import asyncio
+import logging
 import os
 from netrc import netrc
 from typing import Dict
@@ -32,6 +33,7 @@
 from python_inspector import pyinspector_settings as settings
 from python_inspector import utils
 from python_inspector import utils_pypi
+from python_inspector.logging import logger
 from python_inspector.package_data import get_pypi_data_from_purl
 from python_inspector.resolution import PythonInputProvider
 from python_inspector.resolution import format_pdt_tree
@@ -87,10 +89,8 @@ def resolve_dependencies(
     max_rounds=200000,
     use_cached_index=False,
     use_pypi_json_api=False,
-    verbose=False,
     analyze_setup_py_insecurely=False,
     prefer_source=False,
-    printer=print,
     generic_paths=False,
     ignore_errors=False,
 ):
@@ -123,8 +123,7 @@ def resolve_dependencies(
             f"Must be one of: {', '.join(valid_python_versions)}"
         )
 
-    if verbose:
-        printer("Resolving dependencies...")
+    logger.info("Resolving dependencies...")
 
     if netrc_file:
         if not os.path.exists(netrc_file):
@@ -138,8 +137,7 @@ def resolve_dependencies(
                 netrc_file = None
 
     if netrc_file:
-        if verbose:
-            printer(f"Using netrc file {netrc_file}")
+        logger.info(f"Using netrc file {netrc_file}")
         parsed_netrc = netrc(netrc_file)
     else:
         parsed_netrc = None
@@ -234,18 +232,17 @@ def resolve_dependencies(
             files=files,
         )
 
-    if verbose:
-        printer("direct_dependencies:")
+    logger.info("direct_dependencies:")
+    if logger.level <= logging.INFO:
         for dep in direct_dependencies:
-            printer(f" {dep}")
+            logging.info(f" {dep}")
 
     # create a resolution environments
     environment = utils_pypi.Environment.from_pyver_and_os(
         python_version=python_version, operating_system=operating_system
     )
 
-    if verbose:
-        printer(f"environment: {environment}")
+    logging.info(f"environment: {environment}")
 
     repos_by_url = {}
     if not use_pypi_json_api:
@@ -254,8 +251,7 @@ def resolve_dependencies(
         for index_url in index_urls:
             index_url = index_url.strip("/")
             if use_only_confed and index_url not in settings.INDEX_URL:
-                if verbose:
-                    printer(f"Skipping index URL unknown in settings: {index_url!r}")
+                logger.info(f"Skipping index URL unknown in settings: {index_url!r}")
                 continue
             if index_url in repos_by_url:
                 continue
@@ -273,10 +269,10 @@ def resolve_dependencies(
             repos_by_url[index_url] = repo
 
     repos = repos_by_url.values()
-    if verbose:
-        printer("repos:")
+    logger.info("repos:")
+    if logger.level <= logging.INFO:
         for repo in repos:
-            printer(f" {repo}")
+            logger.info(f" {repo}")
 
     # resolve dependencies proper
     resolution, purls = resolve(
@@ -288,8 +284,6 @@ def resolve_dependencies(
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
         ignore_errors=ignore_errors,
-        verbose=verbose,
-        printer=printer,
     )
 
     async def gather_pypi_data():
@@ -298,20 +292,17 @@ async def get_pypi_data(package):
                 package, repos=repos, environment=environment, prefer_source=prefer_source
             )
 
-            if verbose:
-                printer(f"  retrieved package '{package}'")
+            logger.info(f"  retrieved package '{package}'")
 
             return data
 
-        if verbose:
-            printer(f"retrieve package data from pypi:")
+        logger.info(f"retrieve package data from pypi:")
 
         return await asyncio.gather(*[get_pypi_data(package) for package in purls])
 
     packages = [pkg.to_dict() for pkg in asyncio.run(gather_pypi_data()) if pkg is not None]
 
-    if verbose:
-        printer("done!")
+    logger.info("done!")
 
     return Resolution(
         packages=packages,
@@ -351,8 +342,6 @@ def resolve(
     pdt_output: bool = False,
     analyze_setup_py_insecurely: bool = False,
     ignore_errors: bool = False,
-    verbose: bool = False,
-    printer=print,
 ):
     """
     Resolve dependencies given a ``direct_dependencies`` list of
@@ -379,8 +368,6 @@ def resolve(
         pdt_output=pdt_output,
         analyze_setup_py_insecurely=analyze_setup_py_insecurely,
         ignore_errors=ignore_errors,
-        verbose=verbose,
-        printer=printer,
     )
 
     return resolved_dependencies, packages
@@ -395,8 +382,6 @@ def get_resolved_dependencies(
     pdt_output: bool = False,
     analyze_setup_py_insecurely: bool = False,
     ignore_errors: bool = False,
-    verbose: bool = False,
-    printer=print,
 ) -> Tuple[List[Dict], List[str]]:
     """
     Return resolved dependencies of a ``requirements`` list of Requirement for
@@ -419,13 +404,11 @@ async def gather_version_data():
         async def get_version_data(name: str):
             versions = await provider.fill_versions_for_package(name)
 
-            if verbose:
-                printer(f"  retrieved versions for package '{name}'")
+            logger.info(f"  retrieved versions for package '{name}'")
 
             return versions
 
-        if verbose:
-            printer(f"versions:")
+        logger.info(f"versions:")
 
         return await asyncio.gather(
             *[get_version_data(requirement.name) for requirement in requirements]
@@ -445,11 +428,9 @@ async def get_dependencies(requirement: Requirement):
                 candidate = Candidate(requirement.name, purl.version, requirement.extras)
                 await provider.fill_requirements_for_package(purl, candidate)
 
-                if verbose:
-                    printer(f"  retrieved dependencies for requirement '{str(purl)}'")
+                logger.info(f"  retrieved dependencies for requirement '{str(purl)}'")
 
-        if verbose:
-            printer(f"dependencies:")
+        logger.info(f"dependencies:")
 
         return await asyncio.gather(
             *[get_dependencies(requirement) for requirement in requirements]

src/python_inspector/dependencies.py

@@ -19,6 +19,8 @@
 from _packagedcode.pypi import PipRequirementsFileHandler
 from _packagedcode.pypi import get_requirements_txt_dependencies
 
+from python_inspector.logging import logger
+
 """
 Utilities to resolve dependencies.
 """
@@ -36,10 +38,9 @@ def get_dependencies_from_requirements(
         location=requirements_file, include_nested=True
     )
     for dependent_package in dependent_packages:
-        if TRACE:
-            print(
-                "dependent_package.extracted_requirement:",
-                dependent_package.extracted_requirement,
+        logger.debug(
+                "dependent_package.extracted_requirement: "
+                f"{dependent_package.extracted_requirement}",
             )
         yield dependent_package
 

src/python_inspector/resolution.py

@@ -42,6 +42,7 @@
 from python_inspector import pyinspector_settings as settings
 from python_inspector import utils_pypi
 from python_inspector.error import NoVersionsFound
+from python_inspector.logging import logger
 from python_inspector.setup_py_live_eval import iter_requirements
 from python_inspector.utils import Candidate
 from python_inspector.utils import contain_string
@@ -321,8 +322,8 @@ def get_requirements_from_python_manifest(
                     )
                 ]
                 if len(setup_fct) > 1:
-                    print(
-                        f"Warning: identified multiple definitions of 'setup()' in {setup_py_location}, "
+                    logger.warning(
+                        f"Identified multiple definitions of 'setup()' in {setup_py_location}, "
                         "defaulting to the first occurrence"
                     )
                 setup_fct = setup_fct[0]
@@ -331,8 +332,8 @@ def get_requirements_from_python_manifest(
                 ]
                 if install_requires:
                     if len(install_requires) > 1:
-                        print(
-                            f"Warning: identified multiple definitions of 'install_requires' in "
+                        logger.warning(
+                            f"Identified multiple definitions of 'install_requires' in "
                             "{setup_py_location}, defaulting to the first occurrence"
                         )
                     install_requires = install_requires[0].elts

src/python_inspector/resolve_cli.py

@@ -239,7 +239,9 @@ def resolve_dependencies(
         ctx.exit(1)
 
     # Setup verbose level
-    if verbose >= 3:
+    if verbose >= 4:
+        logging.setup_logger("DEEP")
+    elif verbose == 3:
         logging.setup_logger("TRACE")
     elif verbose == 2:
         logging.setup_logger("DEBUG")
@@ -280,7 +282,6 @@ def resolve_dependencies(
             use_cached_index=use_cached_index,
             use_pypi_json_api=use_pypi_json_api,
             analyze_setup_py_insecurely=analyze_setup_py_insecurely,
-            printer=click.secho,
             prefer_source=prefer_source,
             ignore_errors=ignore_errors,
             generic_paths=generic_paths,

src/python_inspector/setup_py_live_eval.py

@@ -24,12 +24,13 @@
 import setuptools
 from commoncode.command import pushd
 from packvers.requirements import Requirement
+from python_inspector.logging import logger
 
 
 def minver_error(pkg_name):
     """Report error about missing minimum version constraint and exit."""
-    print(
-        'ERROR: specify minimal version of "{0}" using ' '">=" or "=="'.format(pkg_name),
+    logger.error(
+        'Specify minimal version of "{0}" using ' '">=" or "=="'.format(pkg_name),
         file=sys.stderr,
     )
     sys.exit(1)
@@ -98,16 +99,16 @@ def iter_requirements(level, extras, setup_file):
                     imports.append(name)
             setup_providers = [i for i in imports if i in ["distutils.core", "setuptools"]]
             if len(setup_providers) == 0:
-                print(
-                    f"Warning: unable to recognize setup provider in {setup_file}: "
+                logger.warning(
+                    f"Unable to recognize setup provider in {setup_file}: "
                     "defaulting to 'distutils.core'."
                 )
                 setup_provider = "distutils.core"
             elif len(setup_providers) == 1:
                 setup_provider = setup_providers[0]
             else:
-                print(
-                    f"Warning: ambiguous setup provider in {setup_file}: candidates are {setup_providers}"
+                logger.warning(
+                    f"Ambiguous setup provider in {setup_file}: candidates are {setup_providers}"
                     "defaulting to 'distutils.core'."
                 )
                 setup_provider = "distutils.core"
@@ -163,8 +164,8 @@ def iter_requirements(level, extras, setup_file):
         specs = pkg.specifier
         specs = {s.operator: s.version for s in specs._specs}
         if ((">=" in specs) and (">" in specs)) or (("<=" in specs) and ("<" in specs)):
-            print(
-                "ERROR: Do not specify such weird constraints! " '("{0}")'.format(pkg),
+            logger.error(
+                "Do not specify such weird constraints! " '("{0}")'.format(pkg),
                 file=sys.stderr,
             )
             sys.exit(1)