paratext-cli 0.2.3__tar.gz → 0.2.4__tar.gz

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: paratext-cli
-Version: 0.2.3
+Version: 0.2.4
 Summary: Modular, project-based metadata extraction from digitised library/archive collections with a multimodal model
 License-Expression: Apache-2.0
 License-File: LICENSE

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/pyproject.toml

@@ -3,7 +3,7 @@
 # the plain name on PyPI belongs to an unrelated project, so the distribution
 # carries the `-cli` suffix.
 name = "paratext-cli"
-version = "0.2.3"
+version = "0.2.4"
 description = "Modular, project-based metadata extraction from digitised library/archive collections with a multimodal model"
 readme = "README.md"
 # Core is pure-Python + numpy/pillow/pydantic. The [detector] extra needs

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/src/paratext/__init__.py

@@ -1,3 +1,3 @@
 """paratext — metadata extraction from digitised collections with a multimodal model."""
 
-__version__ = "0.2.3"
+__version__ = "0.2.4"

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/src/paratext/extract.py

@@ -84,6 +84,27 @@ def _guard_stale_output(output: Path, header: dict, project: str, re_extract: bo
     )
 
 
+def _report_failures(attempted: int, succeeded: int, last_error: str, output: Path) -> None:
+    """A run where the model never answered is a failure, not an empty result.
+
+    Every call failing means one cause — a bad key, a wrong base-url, a model the
+    endpoint doesn't serve — so it stops with that cause instead of reporting
+    success over an empty file.
+    """
+    failed = attempted - succeeded
+    if not failed:
+        return
+    errors = output.with_name(output.stem + "_errors" + output.suffix)
+    if succeeded:
+        print(f"\n!  {failed} of {attempted} sample(s) failed — see {errors}")
+        return
+    raise SystemExit(
+        f"\nAll {attempted} sample(s) failed — the model was never reached.\n"
+        f"  last error: {last_error}\n"
+        f"  Check --base-url, --model and the API key, then see {errors}."
+    )
+
+
 def run(
     project: Project,
     source: Path,
@@ -138,9 +159,12 @@ def run(
     if seen:
         logger.info("Resuming run — skipping %d already-processed sample(s)", len(seen))
 
+    attempted = succeeded = 0
+    last_error = ""
     for sample in tqdm(project.iter_samples(source, limit), unit="sample"):
         if sample.id in seen:
             continue
+        attempted += 1
         # A sample can be pre-classified by iter_samples (e.g. a deterministic
         # verso filter) to skip the model call entirely.
         pre = (sample.metadata or {}).get("preclassified")
@@ -154,6 +178,7 @@ def run(
                     "elapsed_s": 0.0,
                 },
             )
+            succeeded += 1
             continue
         t0 = time.monotonic()
         try:
@@ -188,6 +213,7 @@ def run(
         except Exception as e:
             append_error(output, sample.id, str(e))
             logger.warning("[%s] failed: %s", sample.id, e)
+            last_error = str(e)
             continue
         elapsed = time.monotonic() - t0
         record = {
@@ -197,6 +223,9 @@ def run(
             "elapsed_s": round(elapsed, 3),
         }
         append_jsonl(output, record)
+        succeeded += 1
+
+    _report_failures(attempted, succeeded, last_error, Path(output))
 
     for notice in getattr(project.source, "notices", []):
         logger.warning("%s", notice)

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/tests/test_extract.py

@@ -165,3 +165,44 @@ def test_guard_is_a_no_op_for_a_new_file(tmp_path):
     from paratext.extract import _guard_stale_output
 
     _guard_stale_output(tmp_path / "nope.jsonl", _header(), "p", False)
+
+
+def test_report_failures_is_silent_when_all_succeeded(tmp_path, capsys):
+    from paratext.extract import _report_failures
+
+    _report_failures(3, 3, "", tmp_path / "out.jsonl")
+    assert capsys.readouterr().out == ""
+
+
+def test_report_failures_notes_a_partial_failure(tmp_path, capsys):
+    from paratext.extract import _report_failures
+
+    _report_failures(5, 3, "boom", tmp_path / "out.jsonl")
+    out = capsys.readouterr().out
+    assert "2 of 5" in out and "out_errors.jsonl" in out
+
+
+def test_report_failures_stops_when_nothing_succeeded(tmp_path):
+    import pytest
+
+    from paratext.extract import _report_failures
+
+    with pytest.raises(SystemExit, match="All 4 sample"):
+        _report_failures(4, 0, "401 unauthorized", tmp_path / "out.jsonl")
+
+
+def test_report_failures_names_the_last_error(tmp_path):
+    import pytest
+
+    from paratext.extract import _report_failures
+
+    with pytest.raises(SystemExit, match="401 unauthorized"):
+        _report_failures(1, 0, "401 unauthorized", tmp_path / "out.jsonl")
+
+
+def test_report_failures_ignores_a_run_with_nothing_to_do(tmp_path, capsys):
+    from paratext.extract import _report_failures
+
+    # A full resume attempts nothing; that is not a failure.
+    _report_failures(0, 0, "", tmp_path / "out.jsonl")
+    assert capsys.readouterr().out == ""

{paratext_cli-0.2.3 → paratext_cli-0.2.4}/uv.lock

@@ -803,7 +803,7 @@ wheels = [
 
 [[package]]
 name = "paratext-cli"
-version = "0.2.3"
+version = "0.2.4"
 source = { editable = "." }
 dependencies = [
     { name = "huggingface-hub" },