openstack/deb-python-taskflow
Code Issues Proposed changes

Document more of the retry subclasses special keyword arguments

Browse Source 
Change-Id: Iaa3949da61c95ffe697fd80cef3ee8a6febd2a8c
This commit is contained in:
Joshua Harlow
2015-06-15 17:16:47 -07:00
parent d2c01658d0
commit 9e6ef18ac4
1 changed files with 38 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
taskflow/retry.py
View File

@@ -238,7 +238,20 @@ class AlwaysRevertAll(Retry):
class Times(Retry):
"""Retries subflow given number of times. Returns attempt number."""
"""Retries subflow given number of times. Returns attempt number.
:param attempts: number of attempts to retry the associated subflow
before giving up
:type attempts: int
:param revert_all: when provided this will cause the full flow to revert
when the number of attempts that have been tried
has been reached (when false, it will only locally
revert the associated subflow)
:type revert_all: bool
Further arguments are interpreted as defined in the
:py:class:`~taskflow.atom.Atom` constructor.
"""
def __init__(self, attempts=1, name=None, provides=None, requires=None,
auto_extract=True, rebind=None, revert_all=False):
@@ -297,6 +310,21 @@ class ForEach(ForEachBase):
Accepts a collection of decision strategies on construction and returns the
next element of the collection on each try.
:param values: values collection to iterate over and provide to
atoms other in the flow as a result of this functions
:py:meth:`~taskflow.atom.Atom.execute` method, which
other dependent atoms can consume (for example, to alter
their own behavior)
:type values: list
:param revert_all: when provided this will cause the full flow to revert
when the number of attempts that have been tried
has been reached (when false, it will only locally
revert the associated subflow)
:type revert_all: bool
Further arguments are interpreted as defined in the
:py:class:`~taskflow.atom.Atom` constructor.
"""
def __init__(self, values, name=None, provides=None, requires=None,
@@ -320,6 +348,15 @@ class ParameterizedForEach(ForEachBase):
Accepts a collection of decision strategies from a predecessor (or from
storage) as a parameter and returns the next element of that collection on
each try.
:param revert_all: when provided this will cause the full flow to revert
when the number of attempts that have been tried
has been reached (when false, it will only locally
revert the associated subflow)
:type revert_all: bool
Further arguments are interpreted as defined in the
:py:class:`~taskflow.atom.Atom` constructor.
"""
def __init__(self, name=None, provides=None, requires=None,