diff options
| author | Joshua Harlow <harlowja@gmail.com> | 2013-10-12 23:04:27 -0700 |
|---|---|---|
| committer | Joshua Harlow <harlowja@gmail.com> | 2013-10-12 23:13:10 -0700 |
| commit | ee83a3ff6f0b16b37c9fbfb634857a659a4205ad (patch) | |
| tree | 20f2bdec06ef444f84bd058d894ebe14b6707f0c /taskflow/patterns | |
| parent | faf2d155dfc3d9225a4def5c492c37a9c7d18c5d (diff) | |
| download | taskflow-ee83a3ff6f0b16b37c9fbfb634857a659a4205ad.tar.gz | |
Pattern comment additions/adjustments
Change-Id: I3154d1c228474d8699f3ae4d0be2fb46406a2f41
Diffstat (limited to 'taskflow/patterns')
| -rw-r--r-- | taskflow/patterns/graph_flow.py | 6 | ||||
| -rw-r--r-- | taskflow/patterns/linear_flow.py | 4 | ||||
| -rw-r--r-- | taskflow/patterns/unordered_flow.py | 3 |
3 files changed, 8 insertions, 5 deletions
diff --git a/taskflow/patterns/graph_flow.py b/taskflow/patterns/graph_flow.py index 880bd9b..01d59d8 100644 --- a/taskflow/patterns/graph_flow.py +++ b/taskflow/patterns/graph_flow.py @@ -28,8 +28,9 @@ from taskflow.utils import graph_utils class Flow(flow.Flow): """Graph flow pattern - Nested flows will be executed according to their dependencies - that will be resolved using data tasks provide and require. + Contained *flows/tasks* will be executed according to their dependencies + which will be resolved by using the *flows/tasks* provides and requires + mappings or by following manually created dependency links. Note: Cyclic dependencies are not allowed. """ @@ -49,6 +50,7 @@ class Flow(flow.Flow): " resolution") def link(self, u, v): + """Link existing node u as a runtime dependency of existing node v.""" if not self._graph.has_node(u): raise ValueError('Item %s not found to link from' % (u)) if not self._graph.has_node(v): diff --git a/taskflow/patterns/linear_flow.py b/taskflow/patterns/linear_flow.py index c8ebe63..a3a3824 100644 --- a/taskflow/patterns/linear_flow.py +++ b/taskflow/patterns/linear_flow.py @@ -27,8 +27,8 @@ class Flow(flow.Flow): applied in order as one unit and rolled back as one unit using the reverse order that the *tasks/flows* have been applied in. - NOTE(imelnikov): Tasks in should not depend on outputs - of tasks that follow it in the flow. + NOTE(imelnikov): Tasks/flows contained in this linear flow must not + depend on outputs (provided names/values) of tasks/flows that follow it. """ def __init__(self, name, uuid=None): diff --git a/taskflow/patterns/unordered_flow.py b/taskflow/patterns/unordered_flow.py index c66f2e8..3f517be 100644 --- a/taskflow/patterns/unordered_flow.py +++ b/taskflow/patterns/unordered_flow.py @@ -27,7 +27,8 @@ class Flow(flow.Flow): executed in any order as one unit and rolled back as one unit. NOTE(harlowja): Since the flow is unordered there can *not* be any - dependency between task inputs and task outputs. + dependency between task/flow inputs (requirements) and + task/flow outputs (provided names/values). """ def __init__(self, name, uuid=None): |