atef.procedure.PreparedTemplateStep

class atef.procedure.PreparedTemplateStep(name: 'Optional[str]' = None, origin: 'TemplateStep' = <factory>, parent: 'Optional[PreparedProcedureGroup]' = None, combined_result: 'Result' = <factory>, verify_result: 'Result' = <factory>, step_result: 'Result' = <factory>, file: 'Union[PreparedFile, PreparedProcedureFile]' = <factory>)[source]

Attributes:

name
parent
result: Combines the step result and verification result based on settings

Methods

`from_origin`(step[, parent])	Prepare a TemplateStep for running.
`run`()	Run the step and return the result

Methods

__init__(name: str | None = None, origin: ~atef.procedure.TemplateStep = <factory>, parent: ~atef.procedure.PreparedProcedureGroup | None = None, combined_result: ~atef.result.Result = <factory>, verify_result: ~atef.result.Result = <factory>, step_result: ~atef.result.Result = <factory>, file: ~atef.config.PreparedFile | ~atef.procedure.PreparedProcedureFile = <factory>) → None

classmethod from_origin(step: TemplateStep, parent: PreparedProcedureGroup | None = None) → PreparedTemplateStep[source]

Prepare a TemplateStep for running. Applies edits and attempts

Parameters:

stepTemplateStep: the original TemplateStep (not prepared)
parentOptional[PreparedProcedureGroup]: the hierarchical parent for the prepared step.

Returns:

PreparedTemplateStep

async run() → Result: Run the step and return the result

Attributes

name: str | None = None: name of this comparison

parent: PreparedProcedureGroup | None = None: hierarchical parent of this step

result

Combines the step result and verification result based on settings

Returns:

Result: The overall result of this step

origin: TemplateStep: original procedure step, of which this is the prepared version

file: PreparedFile | PreparedProcedureFile

combined_result: Result: overall result of running the step

verify_result: Result: confirmation by the user that result matches expectations

step_result: Result: whether or not the step completed successfully