Make output dir optional

Author: JustusRijke

README.md

@@ -33,7 +33,7 @@ Usage: diffpdf [OPTIONS] REFERENCE ACTUAL
 Options:
   --threshold FLOAT       Pixelmatch threshold (0.0-1.0)
   --dpi INTEGER           Render resolution
-  --output-dir DIRECTORY  Diff image output directory
+  --output-dir DIRECTORY  Diff image output directory (optional, if not specified no diff images are saved)
   -v, --verbose           Increase verbosity (-v for INFO, -vv for DEBUG)
   --save-log              Write log output to log.txt
   --version               Show the version and exit.
@@ -51,7 +51,10 @@ Options:
 ```python
 from diffpdf import diffpdf
 
+# Basic usage (no diff images saved)
 diffpdf("reference.pdf", "actual.pdf")
+
+# With options (save diff images to ./output directory)
 diffpdf("reference.pdf", "actual.pdf", output_dir="./output", threshold=0.2, dpi=150, verbosity=2)
 ```
 

src/diffpdf/__init__.py

@@ -12,7 +12,7 @@ def diffpdf(
     actual: str | Path,
     threshold: float = 0.1,
     dpi: int = 96,
-    output_dir: str | Path = "./",
+    output_dir: str | Path | None = None,
     verbosity: int = 0,
     save_log: bool = False,
 ) -> None:

src/diffpdf/cli.py

@@ -19,8 +19,8 @@
 @click.option(
     "--output-dir",
     type=click.Path(file_okay=False, path_type=Path),
-    default="./",
-    help="Diff image output directory",
+    default=None,
+    help="Diff image output directory (if not specified, no diff images are saved)",
 )
 @click.option(
     "-v",

src/diffpdf/comparators.py

@@ -8,7 +8,7 @@
 
 
 def compare_pdfs(
-    ref: Path, actual: Path, threshold: float, dpi: int, output_dir: Path, logger
+    ref: Path, actual: Path, threshold: float, dpi: int, output_dir: Path | None, logger
 ) -> None:
     check_hash(ref, actual, logger)
 

src/diffpdf/visual_check.py

@@ -16,7 +16,10 @@ def render_page_to_image(pdf_path: Path, page_num: int, dpi: int) -> Image.Image
 
 
 def compare_images(
-    ref_img: Image.Image, actual_img: Image.Image, threshold: float, output_path: Path
+    ref_img: Image.Image,
+    actual_img: Image.Image,
+    threshold: float,
+    output_path: Path | None,
 ) -> bool:
     mismatch_count = pixelmatch(
         ref_img, actual_img, diff_path=output_path, threshold=threshold
@@ -29,11 +32,12 @@ def compare_images(
 
 
 def check_visual_content(
-    ref: Path, actual: Path, threshold: float, dpi: int, output_dir: Path, logger
+    ref: Path, actual: Path, threshold: float, dpi: int, output_dir: Path | None, logger
 ) -> None:
     logger.info("[4/4] Checking visual content...")
 
-    output_dir.mkdir(parents=True, exist_ok=True)
+    if output_dir is not None:
+        output_dir.mkdir(parents=True, exist_ok=True)
 
     ref_doc = fitz.open(ref)
     page_count = len(ref_doc)
@@ -45,11 +49,13 @@ def check_visual_content(
         ref_img = render_page_to_image(ref, page_num, dpi)
         actual_img = render_page_to_image(actual, page_num, dpi)
 
-        ref_name = ref.stem
-        actual_name = actual.stem
-        output_path = (
-            output_dir / f"{ref_name}_vs_{actual_name}_page{page_num + 1}_diff.png"
-        )
+        output_path = None
+        if output_dir is not None:
+            ref_name = ref.stem
+            actual_name = actual.stem
+            output_path = (
+                output_dir / f"{ref_name}_vs_{actual_name}_page{page_num + 1}_diff.png"
+            )
 
         passed = compare_images(ref_img, actual_img, threshold, output_path)
 

tests/test_api.py

@@ -7,11 +7,10 @@
 TEST_ASSETS_DIR = Path(__file__).parent / "assets"
 
 
-def test_diffpdf_function():
+def test_diffpdf():
     with pytest.raises(SystemExit) as exc_info:
         diffpdf(
             TEST_ASSETS_DIR / "pass/identical-A.pdf",
             TEST_ASSETS_DIR / "pass/identical-B.pdf",
-            output_dir=Path("./"),
         )
     assert exc_info.value.code == 0

tests/test_comparators.py

@@ -33,3 +33,16 @@ def test_comparators(ref_pdf_rel, actual_pdf_rel, expected_exit_code):
     result = runner.invoke(cli, [ref_pdf, actual_pdf])
 
     assert result.exit_code == expected_exit_code
+
+
+def test_comparators_with_output_dir():
+    runner = CliRunner()
+
+    with runner.isolated_filesystem():
+        ref_pdf = str(TEST_ASSETS_DIR / "fail/major-color-diff-A.pdf")
+        actual_pdf = str(TEST_ASSETS_DIR / "fail/major-color-diff-B.pdf")
+
+        result = runner.invoke(cli, [ref_pdf, actual_pdf, "--output-dir", "./diff"])
+
+        assert result.exit_code == 1
+        assert Path("./diff").exists()