pipelines.reporters package#

class pipelines.reporters.PipelineReporter#

Bases: object

The base pipeline reporting object to reporting status messages about pipelines. This should be extended providing a report method to implement a new reporting mechanism.

report(context_object: PipelineStorageObject, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a particular results storage object.

Parameters:

  • context_object – The results storage object to write a report for

  • status – The status of the context object being reported

  • message – The message to record against the context object

report_context_object(context_object: PipelineStorageObject, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a particular results storage object.

The log message will be built based on the context object provided before being passed onto report

Parameters:

  • context_object – The results storage object to write a report for

  • status – The status of the context object being reported

  • message – The message to record against the context object

report_pipeline_execution(pipeline_execution: PipelineExecution, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a given PipelineExecution object.

Parameters:

  • pipeline_execution – The pipeline execution storage object to write a report for

  • status – The status of the pipeline execution being reported

  • message – The message to record against the context object

report_pipeline_result(pipeline_result: PipelineResult, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a given PipelineResult object.

Parameters:

  • pipeline_result – The pipeline result storage object to write a report for

  • status – The status of the pipeline result being reported

  • message – The message to record against the context object

report_task_execution(task_execution: TaskExecution, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a given TaskExecution object.

Parameters:

  • task_execution – The task execution storage object to write a report for

  • status – The status of the task execution being reported

  • message – The message to record against the context object

report_task_result(task_result: TaskResult, status: PipelineTaskStatus, message: str)#

Writes the report to the report storage mechanism for a given TaskResult object.

Parameters:

  • task_result – The task result storage object to write a report for

  • status – The status of the task result being reported

  • message – The message to record against the context object

Submodules#