The Runner.state class

This page defines the Runner.state enum.

class Runner.state

The values in this enum are used to indicate the state of a runner.

The valid values are:

state.never_run = <state.never_run: 0>

Indicates that none of Runner.run, Runner.run_for, or Runner.run_until has been called since construction or the last call to Runner.init.

state.running_to_finish = <state.running_to_finish: 1>

Indicates that the Runner is currently running to the finish (via Runner.run).

state.running_for = <state.running_for: 2>

Indicates that the Runner is currently running for a specific amount of time (via Runner.run_for).

state.running_until = <state.running_until: 3>

Indicates that the Runner is currently running until some condition is met (via Runner.run_until).

state.timed_out = <state.timed_out: 4>

Indicates that the Runner was run via Runner.run_for for a specific amount of time and that time has elapsed.

state.stopped_by_predicate = <state.stopped_by_predicate: 6>

Indicates that the Runner was run via Runner.run_until until the condition specified by the argument to Runner.run_until was met.

state.not_running = <state.not_running: 7>

Indicates that the Runner is not in any of the previous states and is not currently running. This can occur when, for example, Runner.run throws an exception.

state.dead = <state.dead: 8>

Indicates that the Runner was killed (by another thread).