Clean up API entrypoint & split tests

Author: JustusRijke

README.md

@@ -48,10 +48,11 @@ Options:
 
 ## Library Usage
 
-Call the CLI from Python:
 ```python
-from diffpdf import main
-main(["-vv","foo.pdf", "bar.pdf"])
+from diffpdf import diffpdf
+
+diffpdf("reference.pdf", "actual.pdf")
+diffpdf("reference.pdf", "actual.pdf", output_dir="./output", threshold=0.2, dpi=150, verbosity=2)
 ```
 
 ## Development

pyproject.toml

@@ -40,7 +40,7 @@ dev = [
 ]
 
 [project.scripts]
-diffpdf = "diffpdf:main"
+diffpdf = "diffpdf.cli:cli"
 
 [tool.hatch.version]
 source = "vcs"

src/diffpdf/__init__.py

@@ -1,15 +1,27 @@
 from importlib.metadata import version
+from pathlib import Path
 
-from .cli import cli
+from .comparators import compare_pdfs
+from .logger import setup_logging
 
 __version__ = version("diffpdf")
 
 
-def main(args=None):  # pragma: no cover
-    if args is None:
-        cli()
-    else:
-        cli(args, standalone_mode=False)
+def diffpdf(
+    reference: str | Path,
+    actual: str | Path,
+    threshold: float = 0.1,
+    dpi: int = 96,
+    output_dir: str | Path = "./",
+    verbosity: int = 0,
+    save_log: bool = False,
+) -> None:
+    ref_path = Path(reference) if isinstance(reference, str) else reference
+    actual_path = Path(actual) if isinstance(actual, str) else actual
+    out_path = Path(output_dir) if isinstance(output_dir, str) else output_dir
 
+    logger = setup_logging(verbosity, save_log)
+    compare_pdfs(ref_path, actual_path, threshold, dpi, out_path, logger)
 
-__all__ = ["main", "__version__"]
+
+__all__ = ["diffpdf", "__version__"]

tests/test_api.py

@@ -0,0 +1,17 @@
+from pathlib import Path
+
+import pytest
+
+from diffpdf import diffpdf
+
+TEST_ASSETS_DIR = Path(__file__).parent / "assets"
+
+
+def test_diffpdf_function():
+    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_cli.py

@@ -1,6 +1,5 @@
 from pathlib import Path
 
-import pytest
 from click.testing import CliRunner
 
 from diffpdf.cli import cli
@@ -35,31 +34,3 @@ def test_double_verbose_flag():
     )
     assert result.exit_code == 0
     assert "DEBUG" in result.output
-
-
-@pytest.mark.parametrize(
-    "ref_pdf_rel,actual_pdf_rel,expected_exit_code",
-    [
-        # Pass cases (exit code 0)
-        ("pass/identical-A.pdf", "pass/identical-B.pdf", 0),
-        ("pass/hash-diff-A.pdf", "pass/hash-diff-B.pdf", 0),
-        ("pass/minor-color-diff-A.pdf", "pass/minor-color-diff-B.pdf", 0),
-        ("pass/multiplatform-diff-A.pdf", "pass/multiplatform-diff-B.pdf", 0),
-        # Fail cases (exit code 1)
-        ("fail/1-letter-diff-A.pdf", "fail/1-letter-diff-B.pdf", 1),
-        ("fail/major-color-diff-A.pdf", "fail/major-color-diff-B.pdf", 1),
-        ("fail/page-count-diff-A.pdf", "fail/page-count-diff-B.pdf", 1),
-        # Critical error cases (exit code 2)
-        ("nonexistent.pdf", "another.pdf", 2),
-    ],
-)
-def test_comparators(ref_pdf_rel, actual_pdf_rel, expected_exit_code):
-    """Parametric integration test: CLI should exit with correct code for various PDF pairs."""
-    runner = CliRunner()
-
-    ref_pdf = str(TEST_ASSETS_DIR / ref_pdf_rel)
-    actual_pdf = str(TEST_ASSETS_DIR / actual_pdf_rel)
-
-    result = runner.invoke(cli, [ref_pdf, actual_pdf])
-
-    assert result.exit_code == expected_exit_code

tests/test_comparators.py

@@ -0,0 +1,35 @@
+from pathlib import Path
+
+import pytest
+from click.testing import CliRunner
+
+from diffpdf.cli import cli
+
+TEST_ASSETS_DIR = Path(__file__).parent / "assets"
+
+
+@pytest.mark.parametrize(
+    "ref_pdf_rel,actual_pdf_rel,expected_exit_code",
+    [
+        # Pass cases (exit code 0)
+        ("pass/identical-A.pdf", "pass/identical-B.pdf", 0),
+        ("pass/hash-diff-A.pdf", "pass/hash-diff-B.pdf", 0),
+        ("pass/minor-color-diff-A.pdf", "pass/minor-color-diff-B.pdf", 0),
+        ("pass/multiplatform-diff-A.pdf", "pass/multiplatform-diff-B.pdf", 0),
+        # Fail cases (exit code 1)
+        ("fail/1-letter-diff-A.pdf", "fail/1-letter-diff-B.pdf", 1),
+        ("fail/major-color-diff-A.pdf", "fail/major-color-diff-B.pdf", 1),
+        ("fail/page-count-diff-A.pdf", "fail/page-count-diff-B.pdf", 1),
+        # Critical error cases (exit code 2)
+        ("nonexistent.pdf", "another.pdf", 2),
+    ],
+)
+def test_comparators(ref_pdf_rel, actual_pdf_rel, expected_exit_code):
+    runner = CliRunner()
+
+    ref_pdf = str(TEST_ASSETS_DIR / ref_pdf_rel)
+    actual_pdf = str(TEST_ASSETS_DIR / actual_pdf_rel)
+
+    result = runner.invoke(cli, [ref_pdf, actual_pdf])
+
+    assert result.exit_code == expected_exit_code