plumpy.process_states module¶
-
class
plumpy.process_states.
Continue
(continue_fn: Callable[[…], Any], *args: Any, **kwargs: Any)[source]¶ Bases:
plumpy.process_states.Command
-
CONTINUE_FN
= 'continue_fn'¶
-
load_instance_state
(saved_state: MutableMapping[str, Any], load_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
save_instance_state
(out_state: MutableMapping[str, Any], save_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
-
class
plumpy.process_states.
Created
(process: Process, run_fn: Callable[[…], Any], *args: Any, **kwargs: Any)[source]¶ Bases:
plumpy.process_states.State
-
ALLOWED
: Set[Union[None, enum.Enum, str]] = {<ProcessState.KILLED: 'killed'>, <ProcessState.RUNNING: 'running'>, <ProcessState.EXCEPTED: 'excepted'>}¶
-
RUN_FN
= 'run_fn'¶
-
execute
() → plumpy.base.state_machine.State[source]¶ Execute the state, performing the actions that this state is responsible for. :returns: a state to transition to or None if finished.
-
load_instance_state
(saved_state: MutableMapping[str, Any], load_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
save_instance_state
(out_state: MutableMapping[str, Any], save_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
-
class
plumpy.process_states.
Excepted
(process: Process, exception: Optional[BaseException], trace_back: Optional[traceback] = None)[source]¶ Bases:
plumpy.process_states.State
-
EXC_VALUE
= 'ex_value'¶
-
TRACEBACK
= 'traceback'¶
-
get_exc_info
() → Tuple[Optional[Type[BaseException]], Optional[BaseException], Optional[traceback]][source]¶ Recreate the exc_info tuple and return it
-
load_instance_state
(saved_state: MutableMapping[str, Any], load_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
save_instance_state
(out_state: MutableMapping[str, Any], save_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
-
class
plumpy.process_states.
Finished
(process: Process, result: Any, successful: bool)[source]¶ Bases:
plumpy.process_states.State
-
class
plumpy.process_states.
Kill
(msg: Optional[Any] = None)[source]¶ Bases:
plumpy.process_states.Command
-
class
plumpy.process_states.
Killed
(process: Process, msg: Optional[str])[source]¶ Bases:
plumpy.process_states.State
-
class
plumpy.process_states.
ProcessState
(value)[source]¶ Bases:
enum.Enum
The possible states that a
Process
can be in.
-
class
plumpy.process_states.
Running
(process: Process, run_fn: Callable[[…], Any], *args: Any, **kwargs: Any)[source]¶ Bases:
plumpy.process_states.State
-
ALLOWED
: Set[Union[None, enum.Enum, str]] = {<ProcessState.EXCEPTED: 'excepted'>, <ProcessState.RUNNING: 'running'>, <ProcessState.KILLED: 'killed'>, <ProcessState.FINISHED: 'finished'>, <ProcessState.WAITING: 'waiting'>}¶
-
COMMAND
= 'command'¶
-
RUN_FN
= 'run_fn'¶
-
_action_command
(command: Union[plumpy.process_states.Kill, plumpy.process_states.Stop, plumpy.process_states.Wait, plumpy.process_states.Continue]) → plumpy.process_states.State[source]¶
-
_command
: Union[None, plumpy.process_states.Kill, plumpy.process_states.Stop, plumpy.process_states.Wait, plumpy.process_states.Continue] = None¶
-
_run_handle
= None¶
-
async
execute
() → plumpy.process_states.State[source]¶ Execute the state, performing the actions that this state is responsible for. :returns: a state to transition to or None if finished.
-
load_instance_state
(saved_state: MutableMapping[str, Any], load_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
save_instance_state
(out_state: MutableMapping[str, Any], save_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
-
class
plumpy.process_states.
Stop
(result: Any, successful: bool)[source]¶ Bases:
plumpy.process_states.Command
-
class
plumpy.process_states.
Wait
(continue_fn: Optional[Callable[[…], Any]] = None, msg: Optional[Any] = None, data: Optional[Any] = None)[source]¶ Bases:
plumpy.process_states.Command
-
class
plumpy.process_states.
Waiting
(process: Process, done_callback: Optional[Callable[[…], Any]], msg: Optional[str] = None, data: Optional[Any] = None)[source]¶ Bases:
plumpy.process_states.State
-
ALLOWED
: Set[Union[None, enum.Enum, str]] = {<ProcessState.EXCEPTED: 'excepted'>, <ProcessState.RUNNING: 'running'>, <ProcessState.KILLED: 'killed'>, <ProcessState.FINISHED: 'finished'>, <ProcessState.WAITING: 'waiting'>}¶
-
DONE_CALLBACK
= 'DONE_CALLBACK'¶
-
_interruption
= None¶
-
async
execute
() → plumpy.process_states.State[source]¶ Execute the state, performing the actions that this state is responsible for. :returns: a state to transition to or None if finished.
-
load_instance_state
(saved_state: MutableMapping[str, Any], load_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-
save_instance_state
(out_state: MutableMapping[str, Any], save_context: plumpy.persistence.LoadSaveContext) → None[source]¶
-