fea: Add file handler for log output

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

Author: heliocastro

src/python_inspector/__init__.py

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

src/python_inspector/dependencies.py

@@ -39,9 +39,8 @@ def get_dependencies_from_requirements(
     )
     for dependent_package in dependent_packages:
         logger.debug(
-                "dependent_package.extracted_requirement: "
-                f"{dependent_package.extracted_requirement}",
-            )
+            f"dependent_package.extracted_requirement: {dependent_package.extracted_requirement}",
+        )
         yield dependent_package
 
 

src/python_inspector/logging.py

@@ -8,6 +8,7 @@
 #
 
 import logging
+from pathlib import Path
 from types import TracebackType
 from typing import Any, Optional, Tuple, Type, Union
 
@@ -70,21 +71,22 @@ def deep(
                 stacklevel=stacklevel,
             )
 
-
     logging.Logger.trace = trace
     logging.Logger.deep = deep
 
 
-def setup_logger(level: str = "WARNING") -> None:
+def setup_logger(level: str = "WARNING", log_file: Optional[Path] = None) -> None:
     """
-    Configures the logger for the 'python-inspector' application.
+    Configure 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").
+        log_file (Optional[Path]): File name for persistent log
+
     """
     # Setup out trace level
     logging.addLevelName(TRACE_LEVEL, "TRACE")
@@ -101,6 +103,11 @@ def setup_logger(level: str = "WARNING") -> None:
         handler.setFormatter(formatter)
         _logger.addHandler(handler)
 
+        if log_file:
+            file_handler = logging.FileHandler(log_file, encoding="utf-8")
+            file_handler.setFormatter(formatter)
+            logger.addHandler(file_handler)
+
 
 # Logger as a singleton
 logger: logging.Logger = logging.getLogger("python-inspector")

src/python_inspector/resolve_cli.py

@@ -9,7 +9,8 @@
 # See https://aboutcode.org for more information about nexB OSS projects.
 #
 
-from typing import Dict
+from pathlib import Path
+from typing import Dict, Optional
 
 import click
 
@@ -43,8 +44,7 @@ def print_version(ctx, param, value):
     metavar="REQUIREMENT-FILE",
     multiple=True,
     required=False,
-    help="Path to pip requirements file listing thirdparty packages. "
-    "This option can be used multiple times.",
+    help="Path to pip requirements file listing thirdparty packages. This option can be used multiple times.",
 )
 @click.option(
     "-s",
@@ -96,8 +96,7 @@ def print_version(ctx, param, value):
     # since multiple is True, this is a sequence
     default=[settings.PYPI_SIMPLE_URL],
     multiple=True,
-    help="PyPI simple index URL(s) to use in order of preference. "
-    "This option can be used multiple times.",
+    help="PyPI simple index URL(s) to use in order of preference. This option can be used multiple times.",
 )
 @click.option(
     "--json",
@@ -140,8 +139,7 @@ def print_version(ctx, param, value):
     "--use-cached-index",
     is_flag=True,
     hidden=True,
-    help="Use cached on-disk PyPI simple package indexes "
-    "and do not refetch package index if cache is present.",
+    help="Use cached on-disk PyPI simple package indexes and do not refetch package index if cache is present.",
 )
 @click.option(
     "--use-pypi-json-api",
@@ -177,7 +175,10 @@ def print_version(ctx, param, value):
     help="Show the version and exit.",
 )
 @click.option(
-    "--ignore-errors", is_flag=True, default=False, help="Ignore errors and continue execution."
+    "--ignore-errors",
+    is_flag=True,
+    default=False,
+    help="Ignore errors and continue execution.",
 )
 @click.help_option("-h", "--help")
 @click.option(
@@ -187,6 +188,11 @@ def print_version(ctx, param, value):
     help="Use generic or truncated paths in the JSON output header and files sections. "
     "Used only for testing to avoid absolute paths and paths changing at each run.",
 )
+@click.option(
+    "--log-file",
+    type=click.Path(path_type=Path),
+    help="Write logs to a file.",
+)
 def resolve_dependencies(
     ctx,
     requirement_files,
@@ -200,6 +206,7 @@ def resolve_dependencies(
     netrc_file,
     max_rounds,
     verbose,
+    log_file: Optional[Path],
     use_cached_index=False,
     use_pypi_json_api=False,
     analyze_setup_py_insecurely=False,
@@ -240,15 +247,15 @@ def resolve_dependencies(
 
     # Setup verbose level
     if verbose >= 4:
-        logging.setup_logger("DEEP")
+        logging.setup_logger("DEEP", log_file=log_file)
     elif verbose == 3:
-        logging.setup_logger("TRACE")
+        logging.setup_logger("TRACE", log_file=log_file)
     elif verbose == 2:
-        logging.setup_logger("DEBUG")
+        logging.setup_logger("DEBUG", log_file=log_file)
     elif verbose == 1:
-        logging.setup_logger("INFO")
+        logging.setup_logger("INFO", log_file=log_file)
     else:
-        logging.setup_logger()
+        logging.setup_logger(log_file=log_file)
 
     options = get_pretty_options(ctx, generic_paths=generic_paths)
 

src/python_inspector/setup_py_live_eval.py

@@ -30,7 +30,7 @@
 def minver_error(pkg_name):
     """Report error about missing minimum version constraint and exit."""
     logger.error(
-        'Specify minimal version of "{0}" using ' '">=" or "=="'.format(pkg_name),
+        'Specify minimal version of "{0}" using ">=" or "=="'.format(pkg_name),
         file=sys.stderr,
     )
     sys.exit(1)
@@ -165,7 +165,7 @@ def iter_requirements(level, extras, setup_file):
         specs = {s.operator: s.version for s in specs._specs}
         if ((">=" in specs) and (">" in specs)) or (("<=" in specs) and ("<" in specs)):
             logger.error(
-                "Do not specify such weird constraints! " '("{0}")'.format(pkg),
+                'Do not specify such weird constraints! ("{0}")'.format(pkg),
                 file=sys.stderr,
             )
             sys.exit(1)

src/python_inspector/utils_pypi.py

@@ -301,9 +301,9 @@ async def get_supported_and_valid_wheels(
         ):
             continue
         logger.trace(
-                f"""    get_supported_and_valid_wheels: Getting wheel from index (or cache):
+            f"""    get_supported_and_valid_wheels: Getting wheel from index (or cache):
                 {durl}"""
-            )
+        )
         wheels.append(wheel)
     return wheels
 
@@ -606,17 +606,17 @@ async def get_best_download_url(self, repos=tuple()):
             package = await repo.get_package_version(name=self.name, version=self.version)
             if not package:
                 logger.debug(
-                        f"     get_best_download_url: {self.name}=={self.version} "
-                        f"not found in {repo.index_url}"
-                    )
+                    f"     get_best_download_url: {self.name}=={self.version} "
+                    f"not found in {repo.index_url}"
+                )
                 continue
             pypi_url = package.get_url_for_filename(self.filename)
             if pypi_url:
                 return pypi_url
             else:
                 logger.debug(
-                        f"     get_best_download_url: {self.filename} not found in {repo.index_url}"
-                    )
+                    f"     get_best_download_url: {self.filename} not found in {repo.index_url}"
+                )
 
     async def download(
         self,
@@ -628,8 +628,8 @@ async def download(
         """
         assert self.filename
         logger.trace(
-                f"Fetching distribution of {self.name}=={self.version}: {self.filename}",
-            )
+            f"Fetching distribution of {self.name}=={self.version}: {self.filename}",
+        )
 
         # FIXME:
         await fetch_and_save(
@@ -1202,16 +1202,16 @@ def package_from_dists(cls, dists):
         for dist in dists:
             if dist.normalized_name != normalized_name:
                 logger.debug(
-                        f"  Skipping inconsistent dist name: expected {normalized_name} got {dist}"
-                    )
+                    f"  Skipping inconsistent dist name: expected {normalized_name} got {dist}"
+                )
                 continue
             elif dist.version != version:
                 dv = packaging_version.parse(dist.version)
                 v = packaging_version.parse(version)
                 if dv != v:
                     logger.debug(
-                            f"  Skipping inconsistent dist version: expected {version} got {dist}"
-                        )
+                        f"  Skipping inconsistent dist version: expected {version} got {dist}"
+                    )
                     continue
 
             if isinstance(dist, Sdist):