task.rst

ruffus.Task

ruffus.task

Decorators

Basic Task decorators are:

@follows() <decorators.follows>

and

@files() <decorators.files>

Task decorators include:

@split() <decorators.files>

@transform() <decorators.files>

@merge() <decorators.files>

@posttask() <decorators.posttask>

More advanced users may require:

@transform() <decorators.transform_ex>

@collate() <decorators.collate>

@parallel() <decorators.parallel>

@check_if_uptodate() <decorators.check_if_uptodate>

@files_re() <decorators.files_re>

Pipeline functions

pipeline_run

pipeline_run (target_tasks, forcedtorun_tasks=[], multiprocess=1, logger=stderr_logger, gnu_make_maximal_rebuild_mode=True)

pipeline_printout

pipeline_printout

pipeline_printout_graph

pipeline_printout_graph

Logging

t_black_hole_logger

t_stderr_logger

Implementation:

Parameter factories:

merge_param_factory

collate_param_factory

transform_param_factory

files_param_factory

args_param_factory

split_param_factory

Wrappers around jobs:

job_wrapper_generic

job_wrapper_io_files

job_wrapper_mkdir

Checking if job is update:

needs_update_check_modify_time

needs_update_check_directory_missing

Exceptions and Errors

task_FilesArgumentsError

task_FilesreArgumentsError

JobSignalledBreak

MissingInputFileError

PostTaskArgumentError

error_making_directory

error_duplicate_task_name

error_decorator_args

error_task_name_lookup_failed

error_task_decorator_takes_no_args

error_function_is_not_a_task

error_circular_dependencies

error_not_a_directory

error_missing_output

error_job_signalled_interrupt