Gather stats for exclusion pattern match counts

* bdx/binary.py (BinaryDirectory): Add `_exclusion_stats' attribute.
(BinaryDirectory.__post_init__): Prepopulate it.
(BinaryDirectory.exclusion_stats): New property.
(BinaryDirectory._find_files): Update it.
* bdx/cli.py (index): Print exclusion pattern stats.
* bdx/index.py (IndexingStats): Add `exclusion_stats' attribute.
(index_binary_directory): Update it.

Author: mkcms

bdx/binary.py

@@ -506,11 +506,17 @@ class BinaryDirectory:
     use_compilation_database: bool = False
 
     _file_list: list[Path] = field(repr=False, default_factory=list)
+    _exclusion_stats: dict[Exclusion, int] = field(
+        repr=False, default_factory=dict
+    )
 
     class CompilationDatabaseNotFoundError(FileNotFoundError):
         """Could not find the compilation database."""
 
     def __post_init__(self):
+        for ex in self.exclusions:
+            self._exclusion_stats[ex] = 0
+
         self._file_list.extend(self._find_files())
 
     @cached_property
@@ -521,6 +527,11 @@ def compilation_database(self):
             info("Found compilation database: {}", compdb)
         return compdb
 
+    @property
+    def exclusion_stats(self) -> dict[Exclusion, int]:
+        """Mapping of ``Exclusion`` to match count."""
+        return dict(self._exclusion_stats)
+
     def changed_files(self) -> Iterator[Path]:
         """Yield files that were changed/created since last run."""
         files = self._file_list
@@ -575,6 +586,7 @@ def _find_files(self) -> Iterator[Path]:
                     file,
                     exclusion.pattern,
                 )
+                self._exclusion_stats[exclusion] += 1
                 continue
 
             if is_readable_elf_file(file):

bdx/cli.py

@@ -383,11 +383,17 @@ def index(
         exit(1)
 
     log(
-        f"Files indexed: {stats.num_files_indexed} "
-        f"(out of {stats.num_files_changed} changed files)"
+        "Files indexed: {} (out of {} changed files)",
+        stats.num_files_indexed,
+        stats.num_files_changed,
     )
-    log(f"Files removed from index: {stats.num_files_deleted}")
-    log(f"Symbols indexed: {stats.num_symbols_indexed}")
+    log("Files removed from index: {}", stats.num_files_deleted)
+    log("Symbols indexed: {}", stats.num_symbols_indexed)
+
+    if stats.exclusion_stats:
+        log("Exclusion pattern stats:")
+        for ex, count in stats.exclusion_stats.items():
+            log("  {!r}: {}", ex.pattern, count)
 
 
 class SearchOutputFormatParamType(click.Choice):

bdx/index.py

@@ -885,6 +885,10 @@ class IndexingStats:
     num_files_deleted: int = 0
     num_symbols_indexed: int = 0
 
+    exclusion_stats: dict[Exclusion, int] = field(
+        repr=False, default_factory=dict
+    )
+
 
 @contextmanager
 def sigint_catcher() -> Iterator[Callable[[], bool]]:
@@ -1190,6 +1194,7 @@ def index_binary_directory(
 
         stats.num_files_changed = len(changed_files)
         stats.num_files_deleted = len(deleted_files)
+        stats.exclusion_stats.update(bdir.exclusion_stats)
 
         def log_unindex_file(path, is_deleted):
             if dry_run and path in existing_files: