/doc/task.rst

https://code.google.com/p/ruffus/ · ReStructuredText · 139 lines · 93 code · 46 blank · 0 comment · 0 complexity · 20648f86872fc8235f46878b6232bf8f MD5 · raw file

  1. .. include:: global.inc
  2. #####################
  3. ruffus.Task
  4. #####################
  5. .. automodule:: ruffus.task
  6. :undoc-members:
  7. :noindex:
  8. ***************************************
  9. Decorators
  10. ***************************************
  11. Basic Task decorators are:
  12. :ref:`@follows() <decorators.follows>`
  13. and
  14. :ref:`@files() <decorators.files>`
  15. Task decorators include:
  16. :ref:`@split() <decorators.files>`
  17. :ref:`@transform() <decorators.files>`
  18. :ref:`@merge() <decorators.files>`
  19. :ref:`@posttask() <decorators.posttask>`
  20. More advanced users may require:
  21. :ref:`@transform() <decorators.transform_ex>`
  22. :ref:`@collate() <decorators.collate>`
  23. :ref:`@parallel() <decorators.parallel>`
  24. :ref:`@check_if_uptodate() <decorators.check_if_uptodate>`
  25. :ref:`@files_re() <decorators.files_re>`
  26. ***************************************
  27. Pipeline functions
  28. ***************************************
  29. ========================
  30. pipeline_run
  31. ========================
  32. .. autofunction:: pipeline_run (target_tasks, forcedtorun_tasks=[], multiprocess=1, logger=stderr_logger, gnu_make_maximal_rebuild_mode=True)
  33. ========================
  34. pipeline_printout
  35. ========================
  36. .. autofunction:: pipeline_printout
  37. ========================
  38. pipeline_printout_graph
  39. ========================
  40. .. autofunction:: pipeline_printout_graph
  41. .. ???
  42. ***************************************
  43. Logging
  44. ***************************************
  45. .. autoclass:: t_black_hole_logger
  46. .. autoclass:: t_stderr_logger
  47. .. ???
  48. ***************************************
  49. Implementation:
  50. ***************************************
  51. =================================
  52. Parameter factories:
  53. =================================
  54. .. autofunction:: merge_param_factory
  55. .. autofunction:: collate_param_factory
  56. .. autofunction:: files_re_param_factory
  57. .. autofunction:: transform_param_factory
  58. .. autofunction:: files_param_factory
  59. .. autofunction:: args_param_factory
  60. .. autofunction:: split_param_factory
  61. .. ???
  62. =================================
  63. Wrappers around jobs:
  64. =================================
  65. .. autofunction:: job_wrapper_generic
  66. .. autofunction:: job_wrapper_io_files
  67. .. autofunction:: job_wrapper_mkdir
  68. .. ???
  69. =================================
  70. Checking if job is update:
  71. =================================
  72. .. autofunction:: needs_update_check_modify_time
  73. .. autofunction:: needs_update_check_directory_missing
  74. .. ???
  75. ***************************************
  76. Exceptions and Errors
  77. ***************************************
  78. .. autoclass::task_FilesArgumentsError
  79. .. autoclass::task_FilesreArgumentsError
  80. .. autoclass::JobSignalledBreak
  81. .. autoclass::MissingInputFileError
  82. .. autoclass::PostTaskArgumentError
  83. .. autoclass::error_making_directory
  84. .. autoclass::error_duplicate_task_name
  85. .. autoclass::error_decorator_args
  86. .. autoclass::error_task_name_lookup_failed
  87. .. autoclass::error_task_decorator_takes_no_args
  88. .. autoclass::error_function_is_not_a_task
  89. .. autoclass::error_circular_dependencies
  90. .. autoclass::error_not_a_directory
  91. .. autoclass::error_missing_output
  92. .. autoclass::error_job_signalled_interrupt
  93. .. ???