compass.pipeline.collection.persistence.persist_documents#

async persist_documents(jurisdiction, collected_docs, completed_steps, *, relative_to=None, **kwargs)[source]#

Persist deduplicated documents for one jurisdiction

Parameters:

jurisdiction (compass.utilities.jurisdictions.Jurisdiction) – Jurisdiction whose deduplicated documents will be persisted and serialized into collection metadata.
collected_docs (compass.pipeline.collection.dedupe.DocumentDeDuplicator) – Deduplicated document collection containing document info entries for each persisted document.
completed_steps (Iterable of str) – Collection step names that were completed for this jurisdiction, used to record the "completed_step_document_counts" in the collection metadata.
relative_to (path-like, optional) – Base path used to store source_fp and parsed_fp as relative paths when possible. By default, None.
**kwargs – Extra keyword-argument pairs to add to the collection metadata.

Returns:

dict – Serialized collection metadata for the jurisdiction, including jurisdiction identifiers and the persisted document records.