Skip to content

Submittable class

Instance of an entity that can be submitted for execution.

A submittable holds functions that can be used to build the execution directed acyclic graph.

Methods

data_nodes_being_edited()

data_nodes_being_edited() -> Set[DataNode]

Return the set of data nodes that are being edited.

Returns:

Type Description
Set[DataNode]

The set of data nodes that are being edited.

get_inputs()

get_inputs() -> Set[DataNode]

Return the set of input data nodes of this submittable.

Returns:

Type Description
Set[DataNode]

The set of input data nodes.

get_intermediate()

get_intermediate() -> Set[DataNode]

Return the set of intermediate data nodes of the submittable entity.

Returns:

Type Description
Set[DataNode]

The set of intermediate data nodes.

get_outputs()

get_outputs() -> Set[DataNode]

Return the set of output data nodes of the submittable entity.

Returns:

Type Description
Set[DataNode]

The set of output data nodes.

is_ready_to_run()

is_ready_to_run() -> ReasonCollection

Indicate if the entity is ready to be run.

Returns:

Type Description
ReasonCollection

A ReasonCollection object that can function as a Boolean value, which is True if the given entity is ready to be run or there is no reason to be blocked, False otherwise.