Docxodus v12.1.0: drop WmlComparer for DocxDiff (1.0.0)

[JSv4]

Tracks the Docxodus submodule from v7.0.0 to v12.1.0 and releases the result as 1.0.0.

Docxodus v11.0.0 deleted the WmlComparer engine in favour of DocxDiff, its default since v8.0.0 and now mature. That removal reaches straight into this project's public API, which has exposed the upstream selector as a keyword argument since 0.3.0.

Breaking changes

Three keyword arguments are removed from DocxodusEngine.run_redline() and raise ValueError:

Argument	Why it is gone
engine	Selected between wmlcomparer and docxdiff. There is nothing left to select.
detail_threshold	Tuned WmlComparer's LCS granularity. DocxDiff's granularity is structural.
simplify_move_markup	Worked around WmlComparer's move markup. DocxDiff renders moves natively.

They raise rather than being ignored, and that is the load-bearing part of this PR. Simply deleting the code path would not have produced a breaking change — it would have produced a wrong-answer change. _build_command only reads keys it knows about, so run_redline(..., engine="wmlcomparer") would have become a silently-ignored kwarg handing the caller DocxDiff output while they believed they had selected WmlComparer.

There is a second, independent reason: the v12 CLI writes a warning to stderr for --detail-threshold= and --simplify-move-markup. run_redline surfaces any non-empty stderr, so passing them through breaks every assert stderr is None in the suite.

Unknown keyword arguments are now rejected on the same reasoning — detial_threshold=0.5 used to vanish in silence, which is indistinguishable from a setting that did nothing.

The Action's comparison input maps onto the deleted selector and now fails the run.

Bug fixes

Issue #30 — leaked NamedTemporaryFile. The output scratch file was tempfile.NamedTemporaryFile(delete=False).name, which drops the only reference to the file object. Its finalizer reports ResourceWarning on CPython 3.13+, once per call, and under -W error surfaces as an unraisable exception attributed to whatever test was running when the collector fired. Now mkstemp, which is the right tool when only a path is wanted.

Data loss on path inputs — found while fixing #30, and the most user-protective change here. run_redline appended original_path and modified_path to temp_files unconditionally, and the finally block os.removes every entry. When the caller passed a path — a documented, type-hinted input mode that docs/quickstart.md demonstrates — those entries were the caller's own files:

engine.run_redline("Author", "original.docx", "modified.docx")  # deleted both

Only byte inputs were safe, which is why the Action (bytes-only) never hit it. Only files this library creates are registered for cleanup now. Anyone who avoided the path API because it ate their documents can use it.

Revision counts: measured, not predicted

The fixture count is now 10. It is neither the 9 the old default reported nor the 11 the 0.3.0 opt-in reported — v11/v12 changed region arrangement, surplus table cells and section defaults. Measured against a freshly built v12.1.0 binary, with ~/.cache/python-redlines cleared first (the extraction cache keys on the installed binary package version, so a rebuilt binary at an unchanged version is otherwise silently ignored).

The Action self-test workflow no longer asserts an exact count: it installs python-redlines from PyPI, so its number tracks the published version, not this branch. Pinning it to 10 would fail every run until 1.0.0 ships; pinning it to 9 would fail every run after. It asserts a positive count — which is what "the action plumbing works" means — and the exact count stays pinned in tests/test_docxodus_engine.py, which runs against the working tree.

Deliberately not done

XmlPowerToolsEngine wraps the original Open-XML-PowerTools WmlComparer in a separately published wheel. Retiring a package users have pinned is its own decision with its own migration story, so it keeps shipping and keeps working — it just emits a DeprecationWarning now. Release notes say "the Docxodus engine no longer carries WmlComparer", not "Python-Redlines is WmlComparer-free", which would be false while that wheel exists. all still resolves to both engines, so existing pins do not change meaning.

Verification

• 72 passed, 1 skipped — the skip is the ResourceWarning assertion, which only fires on CPython 3.13+ (this box is 3.12); a version-independent test asserts the same defect directly.
• Built and ran the v12.1.0 binary on linux-x64, and confirmed --engine= now exits 1 as an unknown flag.
• Built win-x64 as a cross-RID check — the v7→v12 jump touched 1366 files, so dotnet publish -r <rid> --self-contained needed re-verifying against something other than the native RID before the six-RID release matrix runs.

Not verifiable locally: macOS and Windows runners, and the other four RIDs. CI on this PR is the first real test of the v12 submodule on those.

Closes #30

🤖 Generated with Claude Code

https://claude.ai/code/session_014ed9PC7DDco5AFPjsZyy9F