185199b910
Also makes some docstring adjustments to make sure the documentation looks readable (especially the inline examples). Part of blueprint top-level-types Change-Id: Ic6f02ce92449ee23aa9be8645edd8f6f11ee18ab
2.8 KiB
TaskFlow
TaskFlow is a Python library that helps to make task execution easy, consistent and reliable.1
Note
If you are just getting started or looking for an overview please visit: http://wiki.openstack.org/wiki/TaskFlow which provides better introductory material, description of high level goals and related content.
Contents
atoms arguments_and_results inputs_and_outputs
patterns engines notifications persistence resumption
jobs conductors
workers
Examples
While developing TaskFlow the team has worked hard to make sure the various concepts are explained by relevant examples. Here are a few selected examples to get started (ordered by perceived complexity):
examples
To explore more of these examples please check out the examples directory in the TaskFlow source tree.
Note
If the examples provided are not satisfactory (or up to your standards) contributions are welcome and very much appreciated to help improve them. The higher the quality and the clearer the examples are the better and more useful they are for everyone.
Considerations
Things to consider before (and during) development and integration with TaskFlow into your project:
- Read over the paradigm
shifts and engage the team in IRC (or
via the openstack-dev
mailing list) if these need more explanation (prefix
[TaskFlow]to your emails subject to get an even faster response). - Follow (or at least attempt to follow) some of the established best practices (feel free to add your own suggested best practices).
Warning
External usage of internal helpers and other internal utility functions and modules should be kept to a minimum as these may be altered, refactored or moved without notice. If you are unsure whether to use a function, class, or module, please ask (see above).
Miscellaneous
exceptions states types
Indices and tables
genindexmodindexsearch
It should be noted that even though it is designed with OpenStack integration in mind, and that is where most of its current integration is it aims to be generally usable and useful in any project.↩︎