Skip to content

Group

flowtask.components.group

GroupComponent

GroupComponent(loop=None, job=None, stat=None, component_list=None, **kwargs)

Bases: FlowComponent

GroupComponent

Overview

This component executes a group of other FlowTask components sequentially as a single unit.
It allows chaining multiple tasks together and provides error handling for various scenarios.

.. table:: Properties :widths: auto

+------------------------+----------+----------------------------------------------------------------------------------------------------------------+
| Name                   | Required | Description                                                                                                    |
+------------------------+----------+----------------------------------------------------------------------------------------------------------------+
| component_list (list)  |   Yes    | List of dictionaries defining the components to be executed in the group. Each dictionary                      |
|                        |          | should contain the following keys:                                                                             |
|                        |          |   - "component": The FlowTask component class to be used.                                                      |
|                        |          |   - "params": A dictionary containing parameters to be passed to the component.                                |
|                        |          | (Optional)                                                                                                     |
|                        |          |   - "conditions": A dictionary containing conditions that must be met before running the component. (Optional) |
+------------------------+----------+----------------------------------------------------------------------------------------------------------------+
| stat (Callable)        |    No    | Optional callback function for step-level monitoring and statistics collection.                                |
+------------------------+----------+----------------------------------------------------------------------------------------------------------------+
| skipError              |    No    | Defines the behavior when a component within the group raises an error.                                        |
|                        |          | Valid options are:                                                                                             |
|                        |          |   SkipErrors: Skip This makes the component continue his execution.                                            |
|                        |          |   SkipErrors: Raise This Raise the error and interrupt execution.                                              |
+------------------------+----------+----------------------------------------------------------------------------------------------------------------+

Return

The component modifies the data received from the previous component and returns the final output after
all components in the group have been executed.