openstack/deb-python-taskflow
Code Issues Proposed changes

Merge "Add docstrings on runtime objects methods and link to them in docs"

Browse Source
This commit is contained in:
Jenkins
2015-06-29 04:39:29 +00:00
committed by Gerrit Code Review
parent b8dab64a8c 153febce9a
commit 766978c68e
2 changed files with 23 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/engines.rst
View File

@@ -237,7 +237,9 @@ saved to internal engine variables (these object help in execution of
atoms, analyzing the graph and performing other internal engine
activities). At the finishing of this stage a
:py:class:`~taskflow.engines.action_engine.runtime.Runtime` object is created
which contains references to all needed runtime components.
which contains references to all needed runtime components and its
:py:func:`~taskflow.engines.action_engine.runtime.Runtime.compile` is called
to compile a cache of frequently used execution helper objects.
Preparation
-----------

23
taskflow/engines/action_engine/runtime.py
View File

@@ -44,9 +44,14 @@ class Runtime(object):
self._atom_cache = {}
def compile(self):
# Build out a cache of commonly used item that are associated
# with the contained atoms (by name), and are useful to have for
# quick lookup on...
"""Compiles & caches frequently used execution helper objects.
Build out a cache of commonly used item that are associated
with the contained atoms (by name), and are useful to have for
quick lookup on (for example, the change state handler function for
each atom, the scope walker object for each atom, the task or retry
specific scheduler and so-on).
"""
change_state_handlers = {
'task': functools.partial(self.task_action.change_state,
progress=0.0),
@@ -152,6 +157,7 @@ class Runtime(object):
# consumption...
def reset_nodes(self, atoms, state=st.PENDING, intention=st.EXECUTE):
"""Resets all the provided atoms to the given state and intention."""
tweaked = []
for atom in atoms:
metadata = self._atom_cache[atom.name]
@@ -165,13 +171,24 @@ class Runtime(object):
return tweaked
def reset_all(self, state=st.PENDING, intention=st.EXECUTE):
"""Resets all atoms to the given state and intention."""
return self.reset_nodes(self.analyzer.iterate_all_nodes(),
state=state, intention=intention)
def reset_subgraph(self, atom, state=st.PENDING, intention=st.EXECUTE):
"""Resets a atoms subgraph to the given state and intention.
The subgraph is contained of all of the atoms successors.
"""
return self.reset_nodes(self.analyzer.iterate_subgraph(atom),
state=state, intention=intention)
def retry_subflow(self, retry):
"""Prepares a retrys + its subgraph for execution.
This sets the retrys intention to ``EXECUTE`` and resets all of its
subgraph (its successors) to the ``PENDING`` state with an ``EXECUTE``
intention.
"""
self.storage.set_atom_intention(retry.name, st.EXECUTE)
self.reset_subgraph(retry)