c6c57cd14e
Describe why engines exist and also describe at a somewhat lower-level how an action engine goes through its various stages when executing and what each stages high-level goal is (and how it is performed). Change-Id: I79c4b90047826fb2c9f33da75044a9cb42cfe47d
30 lines
748 B
ReStructuredText
30 lines
748 B
ReStructuredText
-----
|
|
Utils
|
|
-----
|
|
|
|
There are various helper utils that are part of taskflows internal usage (and
|
|
external/public usage of these helpers should be kept to a minimum as these
|
|
utility functions may be altered more often in the future).
|
|
|
|
External usage
|
|
==============
|
|
|
|
The following classes and modules are *recommended* for external usage:
|
|
|
|
.. autoclass:: taskflow.utils.misc.Failure
|
|
:members:
|
|
|
|
.. autoclass:: taskflow.utils.eventlet_utils.GreenExecutor
|
|
:members:
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.temporary_log_book
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.temporary_flow_detail
|
|
|
|
.. autofunction:: taskflow.utils.persistence_utils.pformat
|
|
|
|
Internal usage
|
|
==============
|
|
|
|
.. automodule:: taskflow.utils.flow_utils
|