diffpdf 1.1.1__tar.gz → 1.2.0__tar.gz

{diffpdf-1.1.1 → diffpdf-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: diffpdf
-Version: 1.1.1
+Version: 1.2.0
 Summary: A tool for comparing PDF files
 Project-URL: Homepage, https://github.com/JustusRijke/DiffPDF
 Project-URL: Issues, https://github.com/JustusRijke/DiffPDF/issues
@@ -16,7 +16,6 @@ Requires-Python: >=3.10.0
 Requires-Dist: click>=8
 Requires-Dist: pillow>=10.0.0
 Requires-Dist: pixelmatch-fast>=1.3.1
-Requires-Dist: pre-commit>=4.5.1
 Requires-Dist: pymupdf>=1.23.0
 Description-Content-Type: text/markdown
 
@@ -62,6 +61,7 @@ Options:
   --dpi INTEGER           Render resolution
   --output-dir DIRECTORY  Diff output directory (saves text diffs and visual diff images on failure)
   -v, --verbose           Increase verbosity
+  --skip-compare-text     Skip text content comparison
   --version               Show the version and exit.
   --help                  Show this message and exit.
 ```
@@ -84,6 +84,14 @@ diffpdf("reference.pdf", "actual.pdf")
 diffpdf("reference.pdf", "actual.pdf", output_dir="./output", dpi=300)
 ```
 
+## Cross-Platform Considerations
+
+PDF rendering may differ slightly between platforms due to different font
+rendering engines (ClearType on Windows, FreeType on Linux). DiffPDF's
+default threshold accounts for these minor differences.
+
+**Tip:** Generate reference PDFs on the same platform as your CI environment
+
 ## Development
 
 Install [uv](https://github.com/astral-sh/uv?tab=readme-ov-file#installation). Then, install dependencies & activate the automatically generated virtual environment:

{diffpdf-1.1.1 → diffpdf-1.2.0}/README.md

@@ -40,6 +40,7 @@ Options:
   --dpi INTEGER           Render resolution
   --output-dir DIRECTORY  Diff output directory (saves text diffs and visual diff images on failure)
   -v, --verbose           Increase verbosity
+  --skip-compare-text     Skip text content comparison
   --version               Show the version and exit.
   --help                  Show this message and exit.
 ```
@@ -62,6 +63,14 @@ diffpdf("reference.pdf", "actual.pdf")
 diffpdf("reference.pdf", "actual.pdf", output_dir="./output", dpi=300)
 ```
 
+## Cross-Platform Considerations
+
+PDF rendering may differ slightly between platforms due to different font
+rendering engines (ClearType on Windows, FreeType on Linux). DiffPDF's
+default threshold accounts for these minor differences.
+
+**Tip:** Generate reference PDFs on the same platform as your CI environment
+
 ## Development
 
 Install [uv](https://github.com/astral-sh/uv?tab=readme-ov-file#installation). Then, install dependencies & activate the automatically generated virtual environment:

{diffpdf-1.1.1 → diffpdf-1.2.0}/pyproject.toml

@@ -26,7 +26,6 @@ dependencies = [
     "pymupdf>=1.23.0",
     "pixelmatch-fast>=1.3.1",
     "Pillow>=10.0.0",
-    "pre-commit>=4.5.1",
 ]
 
 [project.urls]
@@ -39,6 +38,8 @@ dev = [
     "pytest-cov>=6",
     "ruff>=0.10",
     "ty>=0.0.8",
+    "pre-commit>=4.5.1",
+    "nodeenv>=1.4.0", # Required for pre-commit
 ]
 
 [project.scripts]

{diffpdf-1.1.1 → diffpdf-1.2.0}/src/diffpdf/__init__.py

@@ -17,6 +17,7 @@ def diffpdf(
     dpi: int = 96,
     output_dir: str | Path | None = None,
     verbose: bool = False,
+    skip_compare_text: bool = False,
 ) -> bool:
     ref_path = Path(reference) if isinstance(reference, str) else reference
     actual_path = Path(actual) if isinstance(actual, str) else actual
@@ -34,9 +35,12 @@ def diffpdf(
     if not check_page_counts(ref_path, actual_path):
         return False
 
-    logger.info("[3/4] Checking text content...")
-    if not check_text_content(ref_path, actual_path, out_path):
-        return False
+    if skip_compare_text:
+        logger.info("[3/4] Skipping text content check")
+    else:
+        logger.info("[3/4] Checking text content...")
+        if not check_text_content(ref_path, actual_path, out_path):
+            return False
 
     logger.info("[4/4] Checking visual content...")
     if not check_visual_content(ref_path, actual_path, threshold, dpi, out_path):

{diffpdf-1.1.1 → diffpdf-1.2.0}/src/diffpdf/cli.py

@@ -28,6 +28,11 @@ from .logger import setup_logging
     is_flag=True,
     help="Increase verbosity",
 )
+@click.option(
+    "--skip-compare-text",
+    is_flag=True,
+    help="Skip text content comparison (useful when different render engines produce identical-looking PDFs with different text extraction order)",
+)
 @click.version_option(package_name="diffpdf")
 def cli(
     reference: Path,
@@ -36,10 +41,13 @@ def cli(
     dpi: int,
     output_dir: Path | None,
     verbose: bool,
+    skip_compare_text: bool,
 ) -> None:
     """Compare two PDF files for structural, textual, and visual differences."""
     try:
-        if diffpdf(reference, actual, threshold, dpi, output_dir, verbose):
+        if diffpdf(
+            reference, actual, threshold, dpi, output_dir, verbose, skip_compare_text
+        ):
             sys.exit(0)
         else:
             sys.exit(1)

{diffpdf-1.1.1 → diffpdf-1.2.0}/tests/test_api.py

@@ -31,6 +31,24 @@ def test_api(ref_pdf_rel, actual_pdf_rel, should_pass):
     assert result == should_pass
 
 
+def test_skip_compare_text():
+    ref_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-A.pdf"
+    actual_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-B.pdf"
+
+    # Without skip: fails at text stage
+    assert diffpdf(ref_pdf, actual_pdf) is False
+    # With skip: text stage bypassed, fails at visual stage (letter difference is visible)
+    assert diffpdf(ref_pdf, actual_pdf, skip_compare_text=True) is False
+
+
+def test_skip_compare_text_multiplatform():
+    ref_pdf = TEST_ASSETS_DIR / "pass/multiplatform-diff-A.pdf"
+    actual_pdf = TEST_ASSETS_DIR / "pass/multiplatform-diff-B.pdf"
+
+    # Multiplatform PDFs already pass with text comparison
+    assert diffpdf(ref_pdf, actual_pdf, skip_compare_text=True) is True
+
+
 def test_text_diff_output(tmp_path):
     ref_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-A.pdf"
     actual_pdf = TEST_ASSETS_DIR / "fail/1-letter-diff-B.pdf"

{diffpdf-1.1.1 → diffpdf-1.2.0}/tests/test_cli.py

@@ -20,6 +20,19 @@ def test_cli_with_output_dir():
         assert Path("./diff").exists()
 
 
+def test_skip_compare_text_flag():
+    runner = CliRunner()
+    result = runner.invoke(
+        cli,
+        [
+            str(TEST_ASSETS_DIR / "pass/multiplatform-diff-A.pdf"),
+            str(TEST_ASSETS_DIR / "pass/multiplatform-diff-B.pdf"),
+            "--skip-compare-text",
+        ],
+    )
+    assert result.exit_code == 0
+
+
 def test_verbose_flag():
     runner = CliRunner()
     result = runner.invoke(