BaseRunReport

class lsst.ctrl.bps.BaseRunReport(fields)

Bases: ABC

The base class representing a run report.

Parameters:

fieldslist [ tuple [ str, str]]

The list of column specification, fields, to include in the report. Each field has a name and a type.

Attributes Summary

message

Extra information a method need to pass to its caller (str).

Methods Summary

add(run_report[, use_global_id])	Add a single run info to the report.
clear()	Remove all entries from the report.
from_table(table)	Create a report from a table.
sort(columns[, ascending])	Sort the report entries according to one or more keys.

Attributes Documentation

message

Extra information a method need to pass to its caller (str).

Methods Documentation

abstract add(run_report, use_global_id=False)

Add a single run info to the report.

Parameters:

run_reportlsst.ctrl.bps.WmsRunReport

Information for single run.

use_global_idbool, optional

If set, use global run id. Defaults to False which means that the local id will be used instead.

Only applicable in the context of a WMS using distributed job queues (e.g., HTCondor).

clear()

Remove all entries from the report.

classmethod from_table(table)

Create a report from a table.

Parameters:

tableastropy.table.Table

Information about a run in a tabular form.

Returns:

inst`lsst.ctrl.bps.report.BaseRunReport

A report created based on the information in the provided table.

sort(columns, ascending=True)

Sort the report entries according to one or more keys.

Parameters:

columnsstr | list [ str ]

The column(s) to order the report by.

ascendingbool, optional

Sort report entries in ascending order, default.

Raises:

AttributeError

Raised if supplied with non-existent column(s).