[keighrim]

Overview

This release fixes how document and annotation properties are read and written, and adds a write mode for MMIF producers. Mmif.serialize() no longer changes the object it serializes. It also replaces pytype with mypy as the test-time type checker.

Additions

• Mmif.set_producer(): new write mode for producers, returning a ProducerContext. It keeps capital Annotation records and contains factoring within the views of the current run, so earlier views stay unchanged. It also takes over empty-view pruning from clams-python (adding consistent handling of "empty" views returned from apps clams-python#307). See redesigning Annotation and Document property handling #411 for the design discussion.

Changes

• Mmif.get_start(), Mmif.get_end(), video document lookup, and document properties: fixed a bug where values factored to the view level were not found when reading a MMIF file (improving shared-value property factoring #398)
• Mmif.serialize(): fixed bugs where it changed the Mmif object in memory, wrote document properties twice with sanitize=True, and silently dropped data when an error occurred during serialization (redesigning Annotation and Document property handling #411)
• Document.add_property(): location, text, and mime can now be set only once. Only the mmif source command is meant to set these values, so this adds only a preemptive check and does not change how apps should behave
• new_contain(): fixed a bug where metadata was dropped when the type was already in the view. It now always returns the Contain
• Deprecated Mmif.generate_capital_annotations(), Mmif.factor_out_shared_properties(), Mmif.sanitize(), and the matching Mmif.serialize() arguments, to be removed in 2.0.0. Adding properties to existing documents without a producer now issues a FutureWarning
• WorkflowSource: fixed a bug where common metadata given as a JSON string raised a TypeError
• (contributors only) Type checking: tests now use mypy in place of pytype (replacing pytype with mypy #414)

[codecov]

Codecov Report

❌ Patch coverage is 96.68412% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.13%. Comparing base (945894e) to head (23ef841).
⚠️ Report is 16 commits behind head on main.

Files with missing lines	Patch %	Lines
mmif/serialize/mmif.py	97.67%	4 Missing ⚠️
mmif/serialize/annotation.py	96.59%	3 Missing ⚠️
mmif/utils/cli/source.py	72.72%	3 Missing ⚠️
mmif/utils/video_document_helper.py	94.64%	3 Missing ⚠️
mmif/utils/summarizer/nodes.py	0.00%	2 Missing ⚠️
mmif/serialize/view.py	97.61%	1 Missing ⚠️
mmif/utils/summarizer/graph.py	85.71%	1 Missing ⚠️
mmif/utils/summarizer/summary.py	85.71%	1 Missing ⚠️
mmif/utils/summarizer/utils.py	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #415      +/-   ##
==========================================
+ Coverage   78.62%   80.13%   +1.50%     
==========================================
  Files          27       28       +1     
  Lines        3416     3630     +214     
==========================================
+ Hits         2686     2909     +223     
+ Misses        730      721       -9     

Flag	Coverage Δ
unittests	80.13% <96.68%> (+1.50%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.