gemseo.core.execution_status module

Execution status of processes.

class ExecutionStatus(process_name)

Bases: Serializable

Execution status of a process.

The status aims at monitoring a process and give the user a simplified view on the state of the processes.

The possible statuses are defined in Status. The status rules are:

• the initial status is DONE,

• the status RUNNING or LINEARIZING can only be set when the current one is DONE,

• the status DONE can only be set when the current one is RUNNING.

Helper methods should be used to handle the statuses when executing a monitored process, e.g., a Discipline or an MDOScenario, using the method execute(), or linearizing a Discipline using the method linearize().

Observers can be attached and are notified when the value of the status is changed. The observers are not restored after pickling.

Initialize self. See help(type(self)) for accurate signature.

Parameters:

process_name (str) -- The name of the process.

class Status(*values)

Bases: StrEnum

The statuses.

DONE = 'DONE'

FAILED = 'FAILED'

LINEARIZING = 'LINEARIZING'

RUNNING = 'RUNNING'

add_observer(observer)

Add an observer.

Parameters:

observer (BaseExecutionStatusObserver) -- The observer to add.

Return type:

None

handle(status, function, *args)

Handle a status while executing a function.

On exception, the status is set to FAILED, otherwise is set to DONE.

Parameters:

• status (Status) -- The status to be set before execution.

• function (Callable[[Any], None]) -- The function to be called.

• *args (Any) -- The argument to be passed for calling the function.

Return type:

None

remove_observer(observer)

Remove an observer.

Parameters:

observer (BaseExecutionStatusObserver) -- The observer to remove.

Return type:

None

is_enabled: ClassVar[bool] = False

Whether to handle statuses when calling handle().

property value: Status

The status of the process.