1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
.. include:: ../../global.inc
.. include:: manual_chapter_numbers.inc
.. _new_manual.inputs.code:
############################################################################################################################################################################################################
|new_manual.inputs.chapter_num|: Python Code for Manipulating task inputs via string substitution using :ref:`inputs() <decorators.inputs>` and :ref:`add_inputs() <decorators.add_inputs>`
############################################################################################################################################################################################################
.. seealso::
* :ref:`Manual Table of Contents <new_manual.table_of_contents>`
* :ref:`inputs() <decorators.inputs>` syntax
* :ref:`add_inputs() <decorators.add_inputs>` syntax
* Back to |new_manual.inputs.chapter_num|: :ref:`Manipulating task inputs via string substitution <new_manual.inputs>`
******************************************************************************************************************************************************
Example code for adding additional *input* prerequisites per job with :ref:`add_inputs() <decorators.add_inputs>`
******************************************************************************************************************************************************
.. _new_manual.inputs.example1:
===================================================================
1. Example: compiling c++ code
===================================================================
.. code-block:: python
# source files exist before our pipeline
source_files = ["hasty.cpp", "tasty.cpp", "messy.cpp"]
for source_file in source_files:
open(source_file, "w")
from ruffus import *
@transform(source_files, suffix(".cpp"), ".o")
def compile(input_filename, output_file):
open(output_file, "w")
pipeline_run()
Giving:
.. code-block:: pycon
>>> pipeline_run()
Job = [hasty.cpp -> hasty.o] completed
Job = [messy.cpp -> messy.o] completed
Job = [tasty.cpp -> tasty.o] completed
Completed Task = compile
.. _new_manual.inputs.example2:
======================================================================================================================================
2. Example: Adding a common header file with :ref:`add_inputs() <decorators.add_inputs>`
======================================================================================================================================
.. code-block:: python
:emphasize-lines: 12
# source files exist before our pipeline
source_files = ["hasty.cpp", "tasty.cpp", "messy.cpp"]
for source_file in source_files:
open(source_file, "w")
# common (universal) header exists before our pipeline
open("universal.h", "w")
from ruffus import *
@transform( source_files, suffix(".cpp"),
# add header to the input of every job
add_inputs("universal.h"),
".o")
def compile(input_filename, output_file):
open(output_file, "w")
pipeline_run()
Giving:
.. code-block:: pycon
>>> pipeline_run()
Job = [[hasty.cpp, universal.h] -> hasty.o] completed
Job = [[messy.cpp, universal.h] -> messy.o] completed
Job = [[tasty.cpp, universal.h] -> tasty.o] completed
Completed Task = compile
.. _new_manual.inputs.example3:
=====================================================================
3. Example: Additional *Input* can be tasks
=====================================================================
.. code-block:: python
:emphasize-lines: 11,17,19
# source files exist before our pipeline
source_files = ["hasty.cpp", "tasty.cpp", "messy.cpp"]
for source_file in source_files:
open(source_file, "w")
# common (universal) header exists before our pipeline
open("universal.h", "w")
from ruffus import *
# make header files
@transform(source_files, suffix(".cpp"), ".h")
def create_matching_headers(input_file, output_file):
open(output_file, "w")
@transform(source_files, suffix(".cpp"),
# add header to the input of every job
add_inputs("universal.h",
# add result of task create_matching_headers to the input of every job
create_matching_headers),
".o")
def compile(input_filename, output_file):
open(output_file, "w")
pipeline_run()
Giving:
.. code-block:: pycon
>>> pipeline_run()
Job = [hasty.cpp -> hasty.h] completed
Job = [messy.cpp -> messy.h] completed
Job = [tasty.cpp -> tasty.h] completed
Completed Task = create_matching_headers
Job = [[hasty.cpp, universal.h, hasty.h, messy.h, tasty.h] -> hasty.o] completed
Job = [[messy.cpp, universal.h, hasty.h, messy.h, tasty.h] -> messy.o] completed
Job = [[tasty.cpp, universal.h, hasty.h, messy.h, tasty.h] -> tasty.o] completed
Completed Task = compile
.. _new_manual.inputs.example4:
================================================================================================================================================================================================================================================
4. Example: Add corresponding files using :ref:`add_inputs() <decorators.add_inputs>` with :ref:`formatter <decorators.formatter>` or :ref:`regex <decorators.regex>`
================================================================================================================================================================================================================================================
.. code-block:: python
:emphasize-lines: 11,17,19
# source files exist before our pipeline
source_files = ["hasty.cpp", "tasty.cpp", "messy.cpp"]
header_files = ["hasty.h", "tasty.h", "messy.h"]
for source_file in source_files + header_files:
open(source_file, "w")
# common (universal) header exists before our pipeline
open("universal.h", "w")
from ruffus import *
@transform( source_files,
formatter(".cpp$"),
# corresponding header for each source file
add_inputs("{basename[0]}.h",
# add header to the input of every job
"universal.h"),
"{basename[0]}.o")
def compile(input_filename, output_file):
open(output_file, "w")
pipeline_run()
Giving:
.. code-block:: pycon
>>> pipeline_run()
Job = [[hasty.cpp, hasty.h, universal.h] -> hasty.o] completed
Job = [[messy.cpp, messy.h, universal.h] -> messy.o] completed
Job = [[tasty.cpp, tasty.h, universal.h] -> tasty.o] completed
Completed Task = compile
*********************************************************************************************
Example code for replacing all input parameters with :ref:`inputs() <decorators.inputs>`
*********************************************************************************************
.. _new_manual.inputs.example5:
================================================================================================================================================================================================================================================
5. Example: Running matching python scripts using :ref:`inputs() <decorators.inputs>`
================================================================================================================================================================================================================================================
.. code-block:: python
:emphasize-lines: 11,17,19
# source files exist before our pipeline
source_files = ["hasty.cpp", "tasty.cpp", "messy.cpp"]
python_files = ["hasty.py", "tasty.py", "messy.py"]
for source_file in source_files + python_files:
open(source_file, "w")
# common (universal) header exists before our pipeline
open("universal.h", "w")
from ruffus import *
@transform( source_files,
formatter(".cpp$"),
# corresponding python file for each source file
inputs("{basename[0]}.py"),
"{basename[0]}.results")
def run_corresponding_python(input_filenames, output_file):
open(output_file, "w")
pipeline_run()
Giving:
.. code-block:: pycon
>>> pipeline_run()
Job = [hasty.py -> hasty.results] completed
Job = [messy.py -> messy.results] completed
Job = [tasty.py -> tasty.results] completed
Completed Task = run_corresponding_python
|
