refactor: remove custom logging implementation (#302)

sdn4z · web-flow · commit 0f7619631419 · 2025-09-03T12:28:07.000+02:00
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@
   - [Configuration file](#configuration-file)
   - [Cache](#cache)
 - [Using `Twyn` as a library](#using-twyn-as-a-library)
+  - [Logging level](#logging-level)
 
 ## Overview
 `Twyn` is a security tool that compares the name of your dependencies against a set of the most popular ones,
@@ -214,3 +215,10 @@ for typo in typos.errors:
   print(f"Did you mean any of [{','.join(typo.similars)}]")
   
 ```
+### Logging level
+To override the logging level when using `Twyn` as a 3rd party library, simply override it like:
+
+```python
+logging.basicConfig(level=logging.DEBUG)
+logging.getLogger("twyn").setLevel(logging.DEBUG)
+```
diff --git a/src/twyn/base/constants.py b/src/twyn/base/constants.py
@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-from enum import Enum
 from typing import TYPE_CHECKING, Literal
 
 from twyn import dependency_parser
@@ -30,10 +29,3 @@
 DEFAULT_TWYN_TOML_FILE = "twyn.toml"
 DEFAULT_TOP_PYPI_PACKAGES = "https://hugovk.github.io/top-pypi-packages/top-pypi-packages.min.json"
 DEFAULT_USE_CACHE = True
-
-
-class AvailableLoggingLevels(Enum):
-    none = "NONE"
-    debug = "DEBUG"
-    info = "INFO"
-    warning = "WARNING"
diff --git a/src/twyn/base/exceptions.py b/src/twyn/base/exceptions.py
@@ -3,7 +3,7 @@
 
 import click
 
-logger = logging.getLogger("twyn.errors")
+logger = logging.getLogger("twyn")
 
 
 class TwynError(Exception):
diff --git a/src/twyn/cli.py b/src/twyn/cli.py
@@ -11,7 +11,6 @@
     DEFAULT_PROJECT_TOML_FILE,
     DEPENDENCY_FILE_MAPPING,
     SELECTOR_METHOD_MAPPING,
-    AvailableLoggingLevels,
 )
 from twyn.base.exceptions import CliError, TwynError
 from twyn.config.config_handler import ConfigHandler
@@ -101,11 +100,9 @@ def run(
     json: bool,
 ) -> int:
     if vv:
-        verbosity = AvailableLoggingLevels.debug
+        logger.setLevel(logging.DEBUG)
     elif v:
-        verbosity = AvailableLoggingLevels.info
-    else:
-        verbosity = AvailableLoggingLevels.none
+        logger.setLevel(logging.INFO)
 
     if dependency and dependency_file:
         raise click.UsageError(
@@ -121,9 +118,8 @@ def run(
             dependencies=set(dependency) or None,
             config_file=config,
             dependency_file=dependency_file,
-            verbosity=verbosity,
             use_cache=not no_cache if no_cache is not None else no_cache,
-            use_track=False if json else not no_track,
+            show_progress_bar=False if json else not no_track,
             load_config_from_file=True,
         )
     except TwynError as e:
diff --git a/src/twyn/config/config_handler.py b/src/twyn/config/config_handler.py
@@ -13,7 +13,6 @@
     DEFAULT_TWYN_TOML_FILE,
     DEFAULT_USE_CACHE,
     SELECTOR_METHOD_KEYS,
-    AvailableLoggingLevels,
 )
 from twyn.config.exceptions import (
     AllowlistPackageAlreadyExistsError,
@@ -34,7 +33,6 @@ class TwynConfiguration:
 
     dependency_file: Optional[str]
     selector_method: str
-    logging_level: AvailableLoggingLevels
     allowlist: set[str]
     pypi_reference: str
     use_cache: bool
@@ -46,7 +44,6 @@ class ReadTwynConfiguration:
 
     dependency_file: Optional[str] = None
     selector_method: Optional[str] = None
-    logging_level: Optional[AvailableLoggingLevels] = None
     allowlist: set[str] = field(default_factory=set)
     pypi_reference: Optional[str] = None
     use_cache: Optional[bool] = None
@@ -62,7 +59,6 @@ def resolve_config(
         self,
         selector_method: Optional[str] = None,
         dependency_file: Optional[str] = None,
-        verbosity: AvailableLoggingLevels = AvailableLoggingLevels.none,
         use_cache: Optional[bool] = None,
     ) -> TwynConfiguration:
         """Resolve the configuration for Twyn.
@@ -99,7 +95,6 @@ def resolve_config(
         return TwynConfiguration(
             dependency_file=dependency_file or read_config.dependency_file,
             selector_method=final_selector_method,
-            logging_level=_get_logging_level(verbosity, read_config.logging_level),
             allowlist=read_config.allowlist,
             pypi_reference=read_config.pypi_reference or DEFAULT_TOP_PYPI_PACKAGES,
             use_cache=final_use_cache,
@@ -133,7 +128,6 @@ def _get_read_config(self, toml: TOMLDocument) -> ReadTwynConfiguration:
         return ReadTwynConfiguration(
             dependency_file=twyn_config_data.get("dependency_file"),
             selector_method=twyn_config_data.get("selector_method"),
-            logging_level=twyn_config_data.get("logging_level"),
             allowlist=set(twyn_config_data.get("allowlist", set())),
             pypi_reference=twyn_config_data.get("pypi_reference"),
             use_cache=twyn_config_data.get("use_cache"),
@@ -179,20 +173,6 @@ def get_default_config_file_path() -> str:
         return DEFAULT_PROJECT_TOML_FILE
 
 
-def _get_logging_level(
-    cli_verbosity: AvailableLoggingLevels,
-    config_logging_level: Optional[str],
-) -> AvailableLoggingLevels:
-    """Return the appropriate logging level, considering that the one in config has less priority than the one passed directly."""
-    if cli_verbosity is AvailableLoggingLevels.none:
-        if config_logging_level:
-            return AvailableLoggingLevels[config_logging_level.lower()]
-        else:
-            # default logging level
-            return AvailableLoggingLevels.warning
-    return cli_verbosity
-
-
 def _serialize_config(x: Any) -> Union[Any, str, list[Any]]:
     def _value_to_for_config(v: Any) -> Union[str, list[Any], Any]:
         if isinstance(v, Enum):
diff --git a/src/twyn/main.py b/src/twyn/main.py
@@ -5,7 +5,6 @@
 
 from twyn.base.constants import (
     SELECTOR_METHOD_MAPPING,
-    AvailableLoggingLevels,
     SelectorMethod,
 )
 from twyn.base.utils import normalize_packages
@@ -22,45 +21,60 @@
 )
 
 logger = logging.getLogger("twyn")
+logger.addHandler(logging.NullHandler())
 
 
 def check_dependencies(
     selector_method: Union[SelectorMethod, None] = None,
     config_file: Optional[str] = None,
     dependency_file: Optional[str] = None,
     dependencies: Optional[set[str]] = None,
-    verbosity: AvailableLoggingLevels = AvailableLoggingLevels.none,
     use_cache: Optional[bool] = True,
-    use_track: bool = False,
+    show_progress_bar: bool = False,
     load_config_from_file: bool = False,
 ) -> TyposquatCheckResultList:
-    """Check if dependencies could be typosquats."""
-    config = get_config(
+    """
+    Check if the provided dependencies are potential typosquats of trusted packages.
+
+    This function analyzes a set of dependencies and determines if any of them are likely typosquats
+    (i.e., malicious or mistaken variants) of popular or trusted packages, using configurable methods
+    and references.
+
+    Args:
+        selector_method (Union[SelectorMethod, None], optional): The method used to select candidate typosquat matches.
+        config_file (Optional[str], optional): Path to a configuration file to load settings from.
+        dependency_file (Optional[str], optional): Path to a file containing the list of dependencies to check.
+        dependencies (Optional[set[str]], optional): A set of dependency names to check. If not provided, dependencies are loaded from the dependency_file.
+        use_cache (Optional[bool], optional): Whether to use cached data for package references and results. Defaults to True.
+        show_progress_bar (bool, optional): Whether to display a progress bar during processing. Defaults to False.
+        load_config_from_file (bool, optional): Whether to load configuration from the specified config_file. Defaults to False.
+
+    Returns:
+        TyposquatCheckResultList: A list of results indicating which dependencies, if any, are suspected typosquats.
+    """
+    config = _get_config(
         load_config_from_file=load_config_from_file,
         config_file=config_file,
-        verbosity=verbosity,
         selector_method=selector_method,
         dependency_file=dependency_file,
         use_cache=use_cache,
     )
 
-    _set_logging_level(config.logging_level)
-
     cache_handler = CacheHandler() if config.use_cache else None
 
     trusted_packages = TrustedPackages(
         names=TopPyPiReference(source=config.pypi_reference, cache_handler=cache_handler).get_packages(),
         algorithm=EditDistance(),
-        selector=get_candidate_selector(config.selector_method),
+        selector=_get_candidate_selector(config.selector_method),
         threshold_class=SimilarityThreshold,
     )
     normalized_allowlist_packages = normalize_packages(config.allowlist)
-    dependencies = dependencies if dependencies else get_parsed_dependencies_from_file(config.dependency_file)
+    dependencies = dependencies if dependencies else _get_parsed_dependencies_from_file(config.dependency_file)
     normalized_dependencies = normalize_packages(dependencies)
 
     typos_list = TyposquatCheckResultList()
     dependencies_list = (
-        track(normalized_dependencies, description="Processing...") if use_track else normalized_dependencies
+        track(normalized_dependencies, description="Processing...") if show_progress_bar else normalized_dependencies
     )
     for dependency in dependencies_list:
         if dependency in normalized_allowlist_packages:
@@ -74,10 +88,9 @@ def check_dependencies(
     return typos_list
 
 
-def get_config(
+def _get_config(
     load_config_from_file: bool,
     config_file: Optional[str],
-    verbosity: AvailableLoggingLevels,
     selector_method: Union[SelectorMethod, None],
     dependency_file: Optional[str],
     use_cache: Optional[bool],
@@ -87,26 +100,20 @@ def get_config(
     else:
         config_file_handler = None
     return ConfigHandler(config_file_handler).resolve_config(
-        verbosity=verbosity,
         selector_method=selector_method,
         dependency_file=dependency_file,
         use_cache=use_cache,
     )
 
 
-def _set_logging_level(logging_level: AvailableLoggingLevels) -> None:
-    logger.setLevel(logging_level.value)
-    logger.debug("Logging level: %s", logging_level.value)
-
-
-def get_candidate_selector(selector_method_name: str) -> AbstractSelector:
+def _get_candidate_selector(selector_method_name: str) -> AbstractSelector:
     logger.debug("Selector method received %s", selector_method_name)
     selector_method = SELECTOR_METHOD_MAPPING[selector_method_name]()
     logger.debug("Instantiated %s selector", selector_method)
     return selector_method
 
 
-def get_parsed_dependencies_from_file(dependency_file: Optional[str] = None) -> set[str]:
+def _get_parsed_dependencies_from_file(dependency_file: Optional[str] = None) -> set[str]:
     dependency_parser = DependencySelector(dependency_file).get_dependency_parser()
     dependencies = dependency_parser.parse()
     logger.debug("Successfully parsed local dependencies file.")
diff --git a/tests/config/test_config_handler.py b/tests/config/test_config_handler.py
@@ -11,7 +11,6 @@
     DEFAULT_SELECTOR_METHOD,
     DEFAULT_TOP_PYPI_PACKAGES,
     DEFAULT_TWYN_TOML_FILE,
-    AvailableLoggingLevels,
 )
 from twyn.config.config_handler import ConfigHandler, ReadTwynConfiguration, TwynConfiguration
 from twyn.config.exceptions import (
@@ -40,7 +39,6 @@ def test_no_enforce_file_on_non_existent_file(self, mock_is_file: Mock) -> None:
         assert config == TwynConfiguration(
             dependency_file=None,
             selector_method="all",
-            logging_level=AvailableLoggingLevels.warning,
             allowlist=set(),
             pypi_reference=DEFAULT_TOP_PYPI_PACKAGES,
             use_cache=True,
@@ -54,7 +52,6 @@ def test_read_config_values(self, pyproject_toml_file: Path) -> None:
         config = ConfigHandler(file_handler=FileHandler(pyproject_toml_file)).resolve_config()
         assert config.dependency_file == "my_file.txt"
         assert config.selector_method == "all"
-        assert config.logging_level == AvailableLoggingLevels.debug
         assert config.allowlist == {"boto4", "boto2"}
         assert config.use_cache is False
 
@@ -66,7 +63,6 @@ def test_get_twyn_data_from_file(self, pyproject_toml_file: Path) -> None:
         assert twyn_data == ReadTwynConfiguration(
             dependency_file="my_file.txt",
             selector_method="all",
-            logging_level="debug",
             allowlist={"boto4", "boto2"},
             pypi_reference=None,
             use_cache=False,
@@ -105,7 +101,6 @@ def test_write_toml(self, pyproject_toml_file: Path) -> None:
                 "twyn": {
                     "dependency_file": "my_file.txt",
                     "selector_method": "all",
-                    "logging_level": "debug",
                     "allowlist": {},
                     "pypi_reference": DEFAULT_TOP_PYPI_PACKAGES,
                     "use_cache": False,
@@ -146,7 +141,6 @@ def test_no_load_config_from_cache(self, pyproject_toml_file: Path) -> None:
 
         assert config.allowlist == set()
         assert config.dependency_file is None
-        assert config.logging_level == AvailableLoggingLevels.warning
         assert config.use_cache is True
         assert config.selector_method == DEFAULT_SELECTOR_METHOD
         assert config.pypi_reference == DEFAULT_TOP_PYPI_PACKAGES
diff --git a/tests/main/test_cli.py b/tests/main/test_cli.py
@@ -4,7 +4,6 @@
 import pytest
 from click.testing import CliRunner
 from twyn import cli
-from twyn.base.constants import AvailableLoggingLevels
 from twyn.base.exceptions import TwynError
 from twyn.trusted_packages.cache_handler import CacheEntry, CacheHandler
 from twyn.trusted_packages.trusted_packages import TyposquatCheckResult, TyposquatCheckResultList
@@ -88,9 +87,8 @@ def test_click_arguments_dependency_file(self, mock_check_dependencies: Mock) ->
                 dependency_file="requirements.txt",
                 dependencies=None,
                 selector_method="first-letter",
-                verbosity=AvailableLoggingLevels.debug,
                 use_cache=None,
-                use_track=True,
+                show_progress_bar=True,
                 load_config_from_file=True,
             )
         ]
@@ -112,9 +110,8 @@ def test_click_arguments_dependency_file_in_different_path(self, mock_check_depe
                 dependency_file="/path/requirements.txt",
                 dependencies=None,
                 selector_method=None,
-                verbosity=AvailableLoggingLevels.none,
                 use_cache=None,
-                use_track=True,
+                show_progress_bar=True,
                 load_config_from_file=True,
             )
         ]
@@ -135,9 +132,8 @@ def test_click_arguments_single_dependency_cli(self, mock_check_dependencies: Mo
                 dependency_file=None,
                 dependencies={"reqests"},
                 selector_method=None,
-                verbosity=AvailableLoggingLevels.none,
                 use_cache=None,
-                use_track=True,
+                show_progress_bar=True,
                 load_config_from_file=True,
             )
         ]
@@ -170,9 +166,8 @@ def test_click_arguments_multiple_dependencies(self, mock_check_dependencies: Mo
                 dependency_file=None,
                 dependencies={"reqests", "reqeusts"},
                 selector_method=None,
-                verbosity=AvailableLoggingLevels.none,
                 use_cache=None,
-                use_track=True,
+                show_progress_bar=True,
                 load_config_from_file=True,
             )
         ]
@@ -188,9 +183,8 @@ def test_click_arguments_default(self, mock_check_dependencies: Mock) -> None:
                 dependency_file=None,
                 selector_method=None,
                 dependencies=None,
-                verbosity=AvailableLoggingLevels.none,
                 use_cache=None,
-                use_track=True,
+                show_progress_bar=True,
                 load_config_from_file=True,
             )
         ]
diff --git a/tests/main/test_main.py b/tests/main/test_main.py
