fix(#167): Separate "messages" from "logging"

Author: scastlara

src/twyn/base/exceptions.py

@@ -1,5 +1,17 @@
-class TwynError(Exception):
+import logging
+from typing import IO, Any, Optional
+
+import click
+
+logger = logging.getLogger("twyn.errors")
+
+
+class TwynError(click.ClickException):
     message = ""
 
     def __init__(self, message: str = "") -> None:
         super().__init__(message or self.message)
+
+    def show(self, file: Optional[IO[Any]] = None) -> None:
+        logger.debug(self.format_message(), exc_info=True)
+        logger.error(self.format_message(), exc_info=False)

src/twyn/cli.py

@@ -65,7 +65,9 @@ def run(
     vv: bool,
 ) -> int:
     if v and vv:
-        raise ValueError("Only one verbosity level is allowed. Choose either -v or -vv.")
+        raise click.UsageError(
+            "Only one verbosity level is allowed. Choose either -v or -vv.", ctx=click.get_current_context()
+        )
 
     if v:
         verbosity = AvailableLoggingLevels.info
@@ -75,10 +77,12 @@ def run(
         verbosity = AvailableLoggingLevels.none
 
     if dependency and dependency_file:
-        raise ValueError("Only one of --dependency or --dependency-file can be set at a time.")
+        raise click.UsageError(
+            "Only one of --dependency or --dependency-file can be set at a time.", ctx=click.get_current_context()
+        )
 
     if dependency_file and not any(dependency_file.endswith(key) for key in DEPENDENCY_FILE_MAPPING):
-        raise ValueError("Dependency file name not supported.")
+        raise click.UsageError("Dependency file name not supported.", ctx=click.get_current_context())
 
     return int(
         check_dependencies(

src/twyn/config/config_handler.py

@@ -19,7 +19,7 @@
     TOMLError,
 )
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 @dataclass(frozen=True)

src/twyn/dependency_parser/abstract_parser.py

@@ -5,7 +5,7 @@
 
 from twyn.file_handler.file_handler import FileHandlerPathlib
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class AbstractParser(ABC):

src/twyn/dependency_parser/dependency_selector.py

@@ -8,7 +8,7 @@
     NoMatchingParserError,
 )
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class DependencySelector:

src/twyn/file_handler/file_handler.py

@@ -6,7 +6,7 @@
 from twyn.base.exceptions import TwynError
 from twyn.file_handler.exceptions import PathIsNotFileError, PathNotFoundError
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class BaseFileHandler(Protocol):

src/twyn/main.py

@@ -2,6 +2,7 @@
 import re
 from typing import Optional
 
+import click
 from rich.logging import RichHandler
 from rich.progress import track
 
@@ -24,7 +25,7 @@
     datefmt="[%X]",
     handlers=[RichHandler(rich_tracebacks=True, show_path=False)],
 )
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 def check_dependencies(
@@ -61,11 +62,15 @@ def check_dependencies(
             errors.append(typosquat_results)
 
     for possible_typosquats in errors:
-        logger.error(
-            f"Possible typosquat detected: `{possible_typosquats.candidate_dependency}`, "
-            f"did you mean any of [{', '.join(possible_typosquats.similar_dependencies)}]?"
+        click.echo(
+            click.style("Possible typosquat detected: ", fg="red") + f"`{possible_typosquats.candidate_dependency}`, "
+            f"did you mean any of [{', '.join(possible_typosquats.similar_dependencies)}]?",
+            color=True,
         )
 
+    if not errors:
+        click.echo(click.style("No typosquats detected", fg="green"), color=True)
+
     return bool(errors)
 
 

src/twyn/similarity/algorithm.py

@@ -7,7 +7,7 @@
 
 from twyn.similarity.exceptions import DistanceAlgorithmError, ThresholdError
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class SimilarityThreshold:
@@ -30,9 +30,7 @@ def from_name(cls, name: str) -> SimilarityThreshold:
             logger.debug(f"max length of {cls.MAX_FOR_SHORT_WORDS} selected for {name}")
             return cls(max=cls.MAX_FOR_SHORT_WORDS)
         logger.debug(f"max length of {cls.MAX_FOR_LONG_WORDS} selected for {name}")
-        return cls(
-            max=cls.MAX_FOR_LONG_WORDS
-        )  # we allow more typos if the name is longer
+        return cls(max=cls.MAX_FOR_LONG_WORDS)  # we allow more typos if the name is longer
 
     def is_inside_threshold(self, value: float) -> bool:
         return self.min <= value <= self.max

src/twyn/trusted_packages/references.py

@@ -10,7 +10,7 @@
     InvalidPyPiFormatError,
 )
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class AbstractPackageReference(ABC):

src/twyn/trusted_packages/selectors.py

@@ -10,7 +10,7 @@
 if TYPE_CHECKING:
     from twyn.trusted_packages.trusted_packages import _PackageNames
 
-logger = logging.getLogger()
+logger = logging.getLogger("twyn")
 
 
 class AbstractSelector(ABC):