Skip to content

taipy.core.Pipeline

Bases: _Entity

List of Tasks and additional attributes representing a set of data processing elements connected as a direct acyclic graph.

Attributes:

Name Type Description
config_id str

The identifier of the PipelineConfig.

properties dict[str, Any]

A dictionary of additional properties.

tasks List[Task]

The list of Tasks.

pipeline_id str

The Unique identifier of the pipeline.

parent_id str

The identifier of the parent (scenario_id, cycle_id) or None.

submit(callbacks=None, force=False, wait=False, timeout=None)

Submit the pipeline for execution.

All the Tasks of the pipeline will be submitted for execution.

Parameters:

Name Type Description Default
callbacks List[Callable]

The list of callable functions to be called on status change.

None
force bool

Force execution even if the data nodes are in cache.

False
wait bool

Wait for the scheduled jobs created from the pipeline submission to be finished in asynchronous mode.

False
timeout Union[float, int]

The maximum number of seconds to wait for the jobs to be finished before returning.

None

subscribe(callback, params=None)

Subscribe a function to be called on Job status change. The subscription is applied to all jobs created from the pipeline's execution.

Parameters:

Name Type Description Default
callback Callable[[Pipeline, Job], None]

The callable function to be called on status change.

required
params Optional[List[Any]]

The parameters to be passed to the callback.

None
Note

Notification will be available only for jobs created after this subscription.

unsubscribe(callback, params=None)

Unsubscribe a function that is called when the status of a Job changes.

Parameters:

Name Type Description Default
callback Callable[[Pipeline, Job], None]

The callable function to unsubscribe.

required
params Optional[List[Any]]

The parameters to be passed to the callback.

None
Note

The function will continue to be called for ongoing jobs.