compass.pipeline.collection.steps.KnownLocalDocumentsStep#

class KnownLocalDocumentsStep[source]#

Bases: CollectionStep

Concrete Strategy for known local document collection

Methods

collect(workflow)

Collect known local documents for this jurisdiction

Attributes

STEP_NAME

Identifier for step
STEP_NAME = 'known_local_docs'#

Identifier for step

async collect(workflow)[source]#

Collect known local documents for this jurisdiction

Parameters:

workflow (compass.pipeline.jurisdiction.SingleJurisdictionRun) – The workflow for the jurisdiction being processed, which may or may not have user-supplied known local documents configured. If the workflow doesn’t have any user-supplied known local documents, this function will return an empty list.

Returns:

list – List of documents loaded from the user-supplied known local document file paths, with user-supplied metadata attrs added.