polaris.run.results.TaskResult

class polaris.run.results.TaskResult(path: str, steps_to_run: List[str] | None = None, log: str | None = None, execution_passed: bool | None = None, baseline_passed: bool | None = None, elapsed_seconds: float | None = None, baseline_diffs: Dict = <factory>)[source]

The outcome of running a task as part of a suite

Variables:

path (str) – The path of the task within the component, which is also its name in the suite
steps_to_run (list of str, optional) – The steps the task was set to run, or None if the task has not been run yet
log (str, optional) – The path of the task’s log file, relative to the suite’s base work directory, or None if the task does not have a single log file
execution_passed (bool, optional) – Whether the steps of the task ran without error, or None if the task has not been run yet
baseline_passed (bool, optional) – Whether the baseline comparisons passed, or None if none were made
elapsed_seconds (float, optional) – The wall-clock time the task took to run, or None if the task has not been run yet
baseline_diffs (dict) – The maximum l1, l2 and l_infinity norms of the difference from the baseline, keyed by variable name, as merged by polaris.validate.merge_diff_summary()

__init__(path: str, steps_to_run: List[str] | None = None, log: str | None = None, execution_passed: bool | None = None, baseline_passed: bool | None = None, elapsed_seconds: float | None = None, baseline_diffs: Dict = <factory>) → None

Methods

`__init__`(path, steps_to_run, log, ...)
`to_dict`()	The task's entry in the results file

Attributes

`baseline_passed`
`elapsed_seconds`
`execution_passed`
`log`
`pending`	Whether the task has not been run yet
`status`	`pending`, `pass` or `fail`
`steps_to_run`
`success`	Whether the task ran without error and no baseline comparison failed
`path`
`baseline_diffs`