feat: Add extended standard logger support

CustomLogger to replace uneven print/trace solution.

Add trace level support, set standard level to warning/error.
Using --verbose or -v options, set the app logger to INFO, -vv set
the app logger to DEBUG, -vvv set the app logger to TRACE status and
last -vvvv to DEEP status.

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

Author: heliocastro

.gitignore

@@ -2,6 +2,7 @@ pip3 # Python compiled files
 *.py[cod]
 
 # virtualenv and other misc bits
+.venv
 /src/*.egg-info
 *.egg-info
 /dist

src/python_inspector/__init__.py

@@ -13,3 +13,4 @@
 pyinspector_settings = settings.Settings()
 
 settings.create_cache_directory(pyinspector_settings.CACHE_THIRDPARTY_DIR)
+

src/python_inspector/logging.py

@@ -0,0 +1,106 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# ScanCode is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/aboutcode-org/python-inspector for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+import logging
+from types import TracebackType
+from typing import Any, Optional, Tuple, Type, Union
+
+# Add TRACE custom level to be third leve, as verbose will match
+# -v == logLevel INFO
+# -vv == logLevel DEBUG
+# -vvv == logLevel TRACE
+TRACE_LEVEL: int = 5
+DEEP_LEVEL: int = 4
+
+
+class CustomLogger(logging.Logger):
+    def trace(
+        self: logging.Logger,
+        msg: Any,
+        *args: Any,
+        exc_info: Union[
+            bool,
+            BaseException,
+            Tuple[Type[BaseException], BaseException, TracebackType],
+            None,
+        ] = None,
+        stack_info: bool = False,
+        stacklevel: int = 1,
+        extra: Optional[dict[str, Any]] = None,
+    ) -> None:
+        if self.isEnabledFor(TRACE_LEVEL):
+            self._log(
+                TRACE_LEVEL,
+                msg,
+                args,
+                exc_info=exc_info,
+                extra=extra,
+                stack_info=stack_info,
+                stacklevel=stacklevel,
+            )
+
+    def deep(
+        self: logging.Logger,
+        msg: Any,
+        *args: Any,
+        exc_info: Union[
+            bool,
+            BaseException,
+            Tuple[Type[BaseException], BaseException, TracebackType],
+            None,
+        ] = None,
+        stack_info: bool = False,
+        stacklevel: int = 1,
+        extra: Optional[dict[str, Any]] = None,
+    ) -> None:
+        if self.isEnabledFor(DEEP_LEVEL):
+            self._log(
+                DEEP_LEVEL,
+                msg,
+                args,
+                exc_info=exc_info,
+                extra=extra,
+                stack_info=stack_info,
+                stacklevel=stacklevel,
+            )
+
+
+    logging.Logger.trace = trace
+    logging.Logger.deep = deep
+
+
+def setup_logger(level: str = "WARNING") -> None:
+    """
+    Configures the logger for the 'python-inspector' application.
+
+    This function sets up a custom logging level, assigns a custom logger class,
+    and configures the logger with the specified logging level. If no handlers are present,
+    it adds a stream handler with a simple formatter.
+
+    Args:
+        level (str): The logging level to set for the logger (e.g., 'DEBUG', 'INFO', 'WARNING', "TRACE").
+    """
+    # Setup out trace level
+    logging.addLevelName(TRACE_LEVEL, "TRACE")
+    logging.addLevelName(DEEP_LEVEL, "DEEP")
+    logging.setLoggerClass(CustomLogger)
+
+    _logger = logging.getLogger("python-inspector")
+    _logger.setLevel(level)
+    _logger.propagate = False
+
+    if not _logger.hasHandlers():
+        handler = logging.StreamHandler()
+        formatter = logging.Formatter("[%(levelname)s] %(message)s")
+        handler.setFormatter(formatter)
+        _logger.addHandler(handler)
+
+
+# Logger as a singleton
+logger: logging.Logger = logging.getLogger("python-inspector")

src/python_inspector/resolve_cli.py

@@ -13,8 +13,8 @@
 
 import click
 
-from python_inspector import settings
-from python_inspector import utils_pypi
+from python_inspector import logging, utils_pypi
+from python_inspector import pyinspector_settings as settings
 from python_inspector.cli_utils import FileOptionType
 from python_inspector.utils import write_output_in_file
 
@@ -162,9 +162,10 @@ def print_version(ctx, param, value):
     "distribution is available then binary distributions are used",
 )
 @click.option(
+    "-v",
     "--verbose",
-    is_flag=True,
-    help="Enable verbose debug output.",
+    count=True,
+    help="Increase verbosity: -v=INFO, -vv=DEBUG, -vvv=TRACE.",
 )
 @click.option(
     "-V",
@@ -198,11 +199,11 @@ def resolve_dependencies(
     pdt_output,
     netrc_file,
     max_rounds,
+    verbose,
     use_cached_index=False,
     use_pypi_json_api=False,
     analyze_setup_py_insecurely=False,
     prefer_source=False,
-    verbose=TRACE,
     generic_paths=False,
     ignore_errors=False,
 ):
@@ -237,6 +238,16 @@ def resolve_dependencies(
         click.secho("Only one of --json or --json-pdt can be used.", err=True)
         ctx.exit(1)
 
+    # Setup verbose level
+    if verbose >= 3:
+        logging.setup_logger("TRACE")
+    elif verbose == 2:
+        logging.setup_logger("DEBUG")
+    elif verbose == 1:
+        logging.setup_logger("INFO")
+    else:
+        logging.setup_logger()
+
     options = get_pretty_options(ctx, generic_paths=generic_paths)
 
     notice = (
@@ -268,7 +279,6 @@ def resolve_dependencies(
             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,
             printer=click.secho,
             prefer_source=prefer_source,