refactor: remove verbose arg from GGShieldUI methods

Author: agateau-gg

ggshield/cmd/secret/scan/archive.py

@@ -44,7 +44,6 @@ def archive_cmd(
 
         ctx_obj = ContextObj.get(ctx)
         config = ctx_obj.config
-        verbose = ui.is_verbose()
         files, binary_paths = create_files_from_paths(
             paths=[temp_path],
             exclusion_regexes=ctx_obj.exclusion_regexes,
@@ -53,7 +52,7 @@ def archive_cmd(
         print_file_list(files, binary_paths)
         ui.display_heading("Starting scan")
 
-        with ui.create_scanner_ui(len(files), verbose=verbose) as scanner_ui:
+        with ui.create_scanner_ui(len(files)) as scanner_ui:
             scan_context = ScanContext(
                 scan_mode=ScanMode.ARCHIVE,
                 command_path=ctx.command_path,

ggshield/cmd/secret/scan/docset.py

@@ -25,18 +25,15 @@ def generate_files_from_docsets(file: TextIO) -> Iterator[Scannable]:
 
 
 def create_scans_from_docset_files(
-    scanner: SecretScanner,
-    input_files: Iterable[TextIO],
-    progress: GGShieldProgress,
-    verbose: bool = False,
+    scanner: SecretScanner, input_files: Iterable[TextIO], progress: GGShieldProgress
 ) -> List[SecretScanCollection]:
     scans: List[SecretScanCollection] = []
 
     for input_file in input_files:
         ui.display_verbose(f"- {click.format_filename(input_file.name)}")
 
         files = generate_files_from_docsets(input_file)
-        with ui.create_message_only_scanner_ui(verbose=verbose) as scanner_ui:
+        with ui.create_message_only_scanner_ui() as scanner_ui:
             results = scanner.scan(files, scanner_ui=scanner_ui)
         scans.append(
             SecretScanCollection(id=input_file.name, type="docset", results=results)
@@ -80,10 +77,7 @@ def docset_cmd(
             scan_context=scan_context,
         )
         scans = create_scans_from_docset_files(
-            scanner=scanner,
-            input_files=files,
-            progress=progress,
-            verbose=ui.is_verbose(),
+            scanner=scanner, input_files=files, progress=progress
         )
 
     return output_handler.process_scan(

ggshield/cmd/secret/scan/path.py

@@ -69,7 +69,7 @@ def path_cmd(
         ui.display_heading("Starting scan")
     target = paths[0] if len(paths) == 1 else Path.cwd()
     target_path = target if target.is_dir() else target.parent
-    with ui.create_scanner_ui(len(files), verbose=ui.is_verbose()) as scanner_ui:
+    with ui.create_scanner_ui(len(files)) as scanner_ui:
         scan_context = ScanContext(
             scan_mode=ScanMode.PATH,
             command_path=ctx.command_path,

ggshield/cmd/secret/scan/precommit.py

@@ -60,13 +60,12 @@ def precommit_cmd(
     """
     ctx_obj = ContextObj.get(ctx)
     config = ctx_obj.config
-    verbose = ui.is_verbose()
 
     if check_user_requested_skip():
         return 0
 
     output_handler = SecretTextOutputHandler(
-        verbose=verbose,
+        verbose=ui.is_verbose(),
         client=ctx_obj.client,
         output=None,
         secret_config=config.user_config.secret,
@@ -94,7 +93,7 @@ def precommit_cmd(
         scan_context=scan_context,
         secret_config=config.user_config.secret,
     )
-    with ui.create_scanner_ui(len(commit.urls), verbose=verbose) as scanner_ui:
+    with ui.create_scanner_ui(len(commit.urls)) as scanner_ui:
         results = scanner.scan(commit.get_files(), scanner_ui)
 
     return_code = output_handler.process_scan(

ggshield/cmd/secret/scan/pypi.py

@@ -98,7 +98,6 @@ def pypi_cmd(
     ctx_obj = ContextObj.get(ctx)
     config = ctx_obj.config
     output_handler = create_output_handler(ctx)
-    verbose = ui.is_verbose()
 
     with tempfile.TemporaryDirectory(suffix="ggshield") as temp_dir:
         temp_path = Path(temp_dir)
@@ -112,7 +111,7 @@ def pypi_cmd(
         print_file_list(files, binary_paths)
         ui.display_heading("Starting scan")
 
-        with ui.create_scanner_ui(len(files), verbose=verbose) as scanner_ui:
+        with ui.create_scanner_ui(len(files)) as scanner_ui:
             scan_context = ScanContext(
                 scan_mode=ScanMode.PYPI,
                 command_path=ctx.command_path,

ggshield/core/ui/__init__.py

@@ -81,12 +81,12 @@ def create_progress(total: int) -> GGShieldProgress:
     return _ui.create_progress(total)
 
 
-def create_scanner_ui(total: int, verbose: bool = False) -> ScannerUI:
-    return _ui.create_scanner_ui(total, verbose=verbose)
+def create_scanner_ui(total: int) -> ScannerUI:
+    return _ui.create_scanner_ui(total)
 
 
-def create_message_only_scanner_ui(verbose: bool = False) -> ScannerUI:
-    return _ui.create_message_only_scanner_ui(verbose=verbose)
+def create_message_only_scanner_ui() -> ScannerUI:
+    return _ui.create_message_only_scanner_ui()
 
 
 def _reset_ui():

ggshield/core/ui/ggshield_ui.py

@@ -57,22 +57,15 @@ def __init__(self):
         self.level = Level.INFO
 
     @abstractmethod
-    def create_scanner_ui(
-        self,
-        total: int,
-        verbose: bool = False,
-    ) -> ScannerUI:
+    def create_scanner_ui(self, total: int) -> ScannerUI:
         """
         Creates a ScannerUI instance. This is used to show progress on scanning
         Scannables.
         """
         ...
 
     @abstractmethod
-    def create_message_only_scanner_ui(
-        self,
-        verbose: bool = False,
-    ) -> ScannerUI:
+    def create_message_only_scanner_ui(self) -> ScannerUI:
         """
         Creates a ScannerUI instance without a progress bar. This is used when the scan
         itself is part of a larger scan. For example when scanning a commit range, each

ggshield/core/ui/plain_text/plain_text_ggshield_ui.py

@@ -59,17 +59,10 @@ def log(self, record: logging.LogRecord) -> None:
             self.display_warning(f"Unsupported log level {level}")
             self.display_error(msg)
 
-    def create_scanner_ui(
-        self,
-        total: int,
-        verbose: bool = False,
-    ) -> ScannerUI:
+    def create_scanner_ui(self, total: int) -> ScannerUI:
         return PlainTextScannerUI()
 
-    def create_message_only_scanner_ui(
-        self,
-        verbose: bool = False,
-    ) -> ScannerUI:
+    def create_message_only_scanner_ui(self) -> ScannerUI:
         return PlainTextScannerUI()
 
     def create_progress(self, total: int) -> GGShieldProgress:

ggshield/core/ui/rich/rich_ggshield_ui.py

@@ -63,18 +63,11 @@ def __init__(self):
         self.console = Console(file=sys.stderr)
         self._previous_timestamp = ""
 
-    def create_scanner_ui(
-        self,
-        total: int,
-        verbose: bool = False,
-    ) -> ScannerUI:
-        return RichProgressScannerUI(self, total, verbose)
-
-    def create_message_only_scanner_ui(
-        self,
-        verbose: bool = False,
-    ) -> ScannerUI:
-        return RichMessageOnlyScannerUI(self, verbose)
+    def create_scanner_ui(self, total: int) -> ScannerUI:
+        return RichProgressScannerUI(self, total)
+
+    def create_message_only_scanner_ui(self) -> ScannerUI:
+        return RichMessageOnlyScannerUI(self)
 
     def create_progress(self, total: int) -> GGShieldProgress:
         return RichGGShieldProgress(self.console, total)

ggshield/core/ui/rich/rich_scanner_ui.py

@@ -12,13 +12,8 @@ class RichMessageOnlyScannerUI(ScannerUI):
     Basic UI, only supports showing messages when `on_*()` methods are called
     """
 
-    def __init__(
-        self,
-        ui: GGShieldUI,
-        verbose: bool = False,
-    ):
+    def __init__(self, ui: GGShieldUI):
         self.ui = ui
-        self.verbose = verbose
 
     def __enter__(self) -> Self:
         return self
@@ -27,9 +22,8 @@ def __exit__(self, *args: Any) -> None:
         pass
 
     def on_scanned(self, scannables: Sequence[Scannable]) -> None:
-        if self.verbose:
-            for scannable in scannables:
-                self.ui.display_info(f"Scanned {scannable.path}")
+        for scannable in scannables:
+            self.ui.display_verbose(f"Scanned {scannable.path}")
 
     def on_skipped(self, scannable: Scannable, reason: str) -> None:
         if reason:
@@ -42,8 +36,8 @@ class RichProgressScannerUI(RichMessageOnlyScannerUI):
     Show a progress bar in addition to messages when `on_*()` methods are called
     """
 
-    def __init__(self, ui: GGShieldUI, total: int, verbose: bool = False):
-        super().__init__(ui, verbose)
+    def __init__(self, ui: GGShieldUI, total: int):
+        super().__init__(ui)
         self.progress = ui.create_progress(total)
 
     def __enter__(self) -> Self: