Fix: Cleaning

Author: adrien-berchet

README.md

@@ -10,7 +10,7 @@
 This project provides simple tools to compare the content of a directory against a reference
 directory.
 
-This is useful to check the results of a process that generate several files, like a luigi
+This is useful to check the results of a process that generates several files, like a luigi
 workflow for example.
 
 

dir_content_diff/__init__.py

@@ -14,13 +14,10 @@
 
 import importlib.metadata
 
-# Import base comparators for backward compatibility
+# Import base comparators
 from dir_content_diff.base_comparators import BaseComparator
 from dir_content_diff.base_comparators import DefaultComparator
 
-# from dir_content_diff.core import _DEFAULT_EXPORT_SUFFIX
-# from dir_content_diff.core import _check_config
-# from dir_content_diff.core import _split_into_chunks
 # Import core comparison functionality
 from dir_content_diff.config import ComparisonConfig
 from dir_content_diff.core import ComparatorType
@@ -31,18 +28,11 @@
 from dir_content_diff.core import pick_comparator
 
 # Import comparator registry functionality
-# from dir_content_diff.registry import _COMPARATORS
 from dir_content_diff.registry import get_comparators
 from dir_content_diff.registry import register_comparator
 from dir_content_diff.registry import reset_comparators
 from dir_content_diff.registry import unregister_comparator
 
-# from dir_content_diff.base_comparators import IniComparator
-# from dir_content_diff.base_comparators import JsonComparator
-# from dir_content_diff.base_comparators import PdfComparator
-# from dir_content_diff.base_comparators import XmlComparator
-# from dir_content_diff.base_comparators import YamlComparator
-
 __version__ = importlib.metadata.version("dir-content-diff")
 
 # For backward compatibility, ensure all public functions are available
@@ -60,13 +50,4 @@
     "unregister_comparator",
     "BaseComparator",
     "DefaultComparator",
-    # "IniComparator",
-    # "JsonComparator",
-    # "PdfComparator",
-    # "XmlComparator",
-    # "YamlComparator",
-    # "_DEFAULT_EXPORT_SUFFIX",
-    # "_split_into_chunks",
-    # "_check_config",
-    # "_COMPARATORS",
 ]

dir_content_diff/base_comparators.py

@@ -513,7 +513,7 @@ def _cast_from_attribute(text, attr):
             elif str(text).lower() == "false":
                 res = False
             else:
-                raise ValueError("Bool attributes expect 'true' or 'false'.")
+                raise ValueError("Boolean attributes expect 'true' or 'false'.")
         elif value_type == "list":
             res = []
         elif value_type == "dict":

dir_content_diff/config.py

@@ -26,6 +26,7 @@
 import attrs
 
 from dir_content_diff.base_comparators import BaseComparator
+from dir_content_diff.registry import get_comparators
 
 # Type alias for comparators
 ComparatorType = Union[BaseComparator, Callable]
@@ -150,9 +151,6 @@ class ComparisonConfig:
 
     def __attrs_post_init__(self):
         """Initialize computed fields after attrs initialization."""
-        # Import here to avoid circular imports
-        from dir_content_diff.registry import get_comparators
-
         # Validate and compile patterns - with frozen, we compile once and store directly
         try:
             compiled_include = self._compile_patterns(self.include_patterns)

dir_content_diff/core.py

@@ -14,18 +14,11 @@
 
 import copy
 import os
-import re
 from collections.abc import Callable
 from concurrent.futures import ProcessPoolExecutor
 from concurrent.futures import ThreadPoolExecutor
 from pathlib import Path
-from typing import Any
-from typing import Dict
-from typing import Iterable
-from typing import List
-from typing import Literal
 from typing import Optional
-from typing import Pattern
 from typing import Tuple
 from typing import Union
 
@@ -47,8 +40,6 @@
 _DEFAULT_EXPORT_SUFFIX = "_FORMATTED"
 
 
-
-
 def compare_files(
     ref_file: Union[str, Path],
     comp_file: Union[str, Path],
@@ -368,6 +359,7 @@ def compare_trees(
                         config,
                         comp_path,
                         formatted_data_path,
+                        _compare_single_file,
                     ): chunk
                     for chunk in file_chunks
                     if chunk  # Skip empty chunks

dir_content_diff/parallel_utils.py

@@ -51,6 +51,7 @@ def _compare_file_chunk(
     config: ComparisonConfig,
     comp_path: Path,
     formatted_data_path: Path,
+    compare_single_file_func,
 ) -> List[Tuple[str, Union[str, bool]]]:  # pragma: no cover
     """Compare a chunk of files.
 
@@ -59,17 +60,15 @@ def _compare_file_chunk(
         config: Comparison configuration.
         comp_path: Path to the comparison directory.
         formatted_data_path: Path where formatted files should be exported.
+        compare_single_file_func: Function to compare a single file.
 
     Returns:
         List of comparison results for the chunk.
     """
-    # Import here to avoid circular imports
-    from dir_content_diff.core import _compare_single_file
-
     results = []
     for ref_file, relative_path in file_chunk:
         try:
-            result = _compare_single_file(
+            result = compare_single_file_func(
                 ref_file, comp_path, relative_path, config, formatted_data_path
             )
             results.append(result)

dir_content_diff/util.py

@@ -170,7 +170,7 @@ def import_error_message(name):
         dependencies = COMPARATOR_DEPENDENCIES[name]
     except KeyError as exception:
         msg = (
-            f"The module {name} has no registered dependency, please add dependencies in the "
+            f"The module {name} has no registered dependency, please add dependencies to the "
             "dependencies.json file"
         )
         raise KeyError(msg) from exception

tests/test_base.py

@@ -623,7 +623,7 @@ def test_xmltodict(self):
 
             # Test bad value in boolean
             with pytest.raises(
-                ValueError, match="Bool attributes expect 'true' or 'false'."
+                ValueError, match="Boolean attributes expect 'true' or 'false'."
             ):
                 comparator.xmltodict(
                     """<?xml version="1.0" encoding="UTF-8" ?>"""

tests/test_util.py

@@ -28,7 +28,7 @@ def test_import_error_message(monkeypatch, caplog):
     with pytest.raises(
         KeyError,
         match=(
-            "The module UNKNOWN_MODULE has no registered dependency, please add dependencies in "
+            "The module UNKNOWN_MODULE has no registered dependency, please add dependencies to "
             "the dependencies.json file"
         ),
     ):