component.py 15.6 KB
Newer Older
Jerome Mariette's avatar
Jerome Mariette committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
#
# Copyright (C) 2012 INRA
# 
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#

import os
19
import sys
Jerome Mariette's avatar
Jerome Mariette committed
20
21
import inspect
import tempfile
Jerome Mariette's avatar
Jerome Mariette committed
22
import types
Jerome Mariette's avatar
Jerome Mariette committed
23
24
25
26

from jflow.workflows_manager import WorkflowsManager
from jflow.config_reader import JFlowConfigReader
from jflow.dataset import ArrayList
Jerome Mariette's avatar
Jerome Mariette committed
27
from jflow.utils import which, display_error_message
Jerome Mariette's avatar
Jerome Mariette committed
28
from jflow.parameter import *
Jerome Mariette's avatar
Jerome Mariette committed
29
30
31
32
from weaver.util import parse_string_list


class Component(object):
Frédéric Escudié's avatar
Frédéric Escudié committed
33

34
    def __init__(self):
Jerome Mariette's avatar
Jerome Mariette committed
35
        self.prefix = "default"
Jerome Mariette's avatar
Jerome Mariette committed
36
        self.params_order = []
Jerome Mariette's avatar
Jerome Mariette committed
37
38
        self.output_directory = None
        self.config_reader = JFlowConfigReader()
39
        self.version = self.get_version()
40
        self.batch_options = self.config_reader.get_component_batch_options(self.__class__.__name__)
Frédéric Escudié's avatar
Frédéric Escudié committed
41
42

    def is_dynamic(self):
43
44
45
46
47
48
49
50
51
52
53
        return len(self.get_dynamic_outputs()) != 0

    def get_dynamic_outputs(self):
        """
         @return : the list of outputs updated at the end of component execution.
        """
        dynamic_outputs = list()
        for attribute_value in self.__dict__.values():
            if issubclass( attribute_value.__class__, DynamicOutput ):
                dynamic_outputs.append( attribute_value )
        return dynamic_outputs
Frédéric Escudié's avatar
Frédéric Escudié committed
54

55
    def get_output_files(self):
Philippe Bardou's avatar
Philippe Bardou committed
56
        outputs = {}
57
58
        for attribute_value in self.__dict__.values():
            if ( issubclass( attribute_value.__class__, DynamicOutput ) or
Philippe Bardou's avatar
Philippe Bardou committed
59
60
                 issubclass( attribute_value.__class__, OutputFileList) ):
                for f in attribute_value:
61
                    outputs[os.path.basename(f)] = f
62
            elif issubclass( attribute_value.__class__, OutputFile):
63
                outputs[os.path.basename(attribute_value)] = attribute_value
64
        return outputs
Frédéric Escudié's avatar
Frédéric Escudié committed
65

66
67
68
69
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
                       required=False, flag=None, group="default", display_name=None, add_to=None):
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
                              type=type, required=required, group=group, display_name=display_name)
70
71

        # store where the parameter is coming from
Frédéric Escudié's avatar
Frédéric Escudié committed
72
73
        new_param.component_nameid = self.get_nameid()
        if issubclass( default.__class__, LinkTraceback ):
74
75
            new_param.parent_component_nameid = default.component_nameid

76
77
78
79
80
81
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
Jerome Mariette's avatar
Jerome Mariette committed
82
        else:
83
84
            self.params_order.append(name)
            self.__setattr__(name, new_param)
85
86
87
88
89
    
    def reset(self):
        for file in os.listdir(self.output_directory):
            os.remove(os.path.join(self.output_directory, file))
    
90
91
    def add_input_file_list(self, name, help, file_format="any", default=None, type="inputfile", 
                            required=False, flag=None, group="default", display_name=None, add_to=None):
92
93
94
        if default == None:
            inputs = []
        else:
Frédéric Escudié's avatar
Frédéric Escudié committed
95
            inputs = [IOFile(file, file_format, self.get_nameid(), None) for file in default]
96
        new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=inputs, 
Jerome Mariette's avatar
Jerome Mariette committed
97
                                  type=type, required=required, group=group, display_name=display_name)
98
        # store where the parameter is coming from
Frédéric Escudié's avatar
Frédéric Escudié committed
99
        new_param.component_nameid = self.get_nameid()
100
101
        if issubclass( default.__class__, list ):
            for idx, val in enumerate(default):
Frédéric Escudié's avatar
Frédéric Escudié committed
102
                if issubclass( val.__class__, LinkTraceback ):
103
                    new_param[idx].parent_component_nameid = val.component_nameid
Frédéric Escudié's avatar
Frédéric Escudié committed
104
105
106
107
108
109
110
111
112
                    new_param.parent_component_nameid.append( val.component_nameid )
                else:
                    new_param.parent_component_nameid.append( None )
        else:
            if issubclass( default.__class__, LinkTraceback ):
                new_param[0].parent_component_nameid = default.component_nameid
                new_param.parent_component_nameid.append( default.component_nameid )
            else:
                new_param.parent_component_nameid.append( None )
Jerome Mariette's avatar
Jerome Mariette committed
113
114
115
116
117
118
119
120
121
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
122

123
124
    def add_parameter(self, name, help, default=None, type=types.StringType, choices=None, 
                      required=False, flag=None, group="default", display_name=None, add_to=None):
Frédéric Escudié's avatar
Frédéric Escudié committed
125
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
126
127
128
129
130
131
132
                              required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
Jerome Mariette's avatar
Jerome Mariette committed
133
        else:
134
135
136
137
138
139
140
            self.params_order.append(name)
            self.__setattr__(name, new_param)

    def add_parameter_list(self, name, help, default=None, type=types.StringType, choices=None, 
                           required=False, flag=None, group="default", display_name=None, add_to=None):
        if default == None: default = []
        new_param = ParameterList(name, help, flag=flag, default=default, type=type, choices=choices, 
Jerome Mariette's avatar
Jerome Mariette committed
141
142
143
144
145
146
147
148
149
150
                                  required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
151

152
153
    def add_output_file(self, name, help, file_format="any", filename=None, group="default", display_name=None, add_to=None):
        filename = os.path.basename(filename)
Frédéric Escudié's avatar
Frédéric Escudié committed
154
        new_param = OutputFile(name, help, default=os.path.join(self.output_directory, filename),
155
                               file_format=file_format, group=group, display_name=display_name)
Frédéric Escudié's avatar
Frédéric Escudié committed
156
        # store where the parameter is coming from
157
        new_param.component_nameid = self.get_nameid()
158
159
160
161
162
163
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
Jerome Mariette's avatar
Jerome Mariette committed
164
        else:
165
166
            self.params_order.append(name)
            self.__setattr__(name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
167

168
169
    def add_output_file_list(self, name, help, file_format="any", pattern='{basename_woext}.out', 
                             items=None, group="default", display_name=None, add_to=None):
Frédéric Escudié's avatar
Frédéric Escudié committed
170
        default = [IOFile(file, file_format, self.get_nameid(), None) for file in self.get_outputs(pattern, items)]
171
        new_param = OutputFileList(name, help, default=default, file_format=file_format, group=group, display_name=display_name)
Frédéric Escudié's avatar
Frédéric Escudié committed
172
173
        # store where the parameter is coming from
        new_param.component_nameid = self.get_nameid()
Jerome Mariette's avatar
Jerome Mariette committed
174
175
176
177
178
179
180
181
182
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
183

Frédéric Escudié's avatar
Frédéric Escudié committed
184
    def add_output_file_endswith(self, name, help, pattern, file_format="any", behaviour="include",
Frédéric Escudié's avatar
Frédéric Escudié committed
185
                               group="default", display_name=None, add_to=None):
186
        new_param = OutputFilesEndsWith(name, help, self.output_directory, pattern, include=(behaviour == "include"), 
187
                                       file_format=file_format, group=group, display_name=display_name)
Frédéric Escudié's avatar
Frédéric Escudié committed
188
189
        # store where the parameter is coming from
        new_param.component_nameid = self.get_nameid()
Frédéric Escudié's avatar
Frédéric Escudié committed
190
191
192
193
194
195
196
197
198
199
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)

Frédéric Escudié's avatar
Frédéric Escudié committed
200
    def add_output_file_pattern(self, name, help, pattern, file_format="any", behaviour="include",
Frédéric Escudié's avatar
Frédéric Escudié committed
201
                               group="default", display_name=None, add_to=None):
202
        new_param = OutputFilesPattern(name, help, self.output_directory, pattern, include=(behaviour == "exclude"), 
203
                                       file_format=file_format, group=group, display_name=display_name)
Frédéric Escudié's avatar
Frédéric Escudié committed
204
205
        # store where the parameter is coming from
        new_param.component_nameid = self.get_nameid()
Frédéric Escudié's avatar
Frédéric Escudié committed
206
207
208
209
210
211
212
213
214
215
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)

Jerome Mariette's avatar
Jerome Mariette committed
216
    def _longestCommonSubstr(self, data, clean_end=True):
Jerome Mariette's avatar
Jerome Mariette committed
217
218
219
220
221
222
223
224
        substr = ''
        if len(data) > 1 and len(data[0]) > 0:
            for i in range(len(data[0])):
                for j in range(len(data[0])-i+1):
                    if j > len(substr) and all(data[0][i:i+j] in x for x in data):
                        substr = data[0][i:i+j]
        else:
            substr = data[0]
Jerome Mariette's avatar
Jerome Mariette committed
225
226
227
        if clean_end:
            while substr.endswith("_") or substr.endswith("-") or substr.endswith("."):
                substr = substr[:-1]
Jerome Mariette's avatar
Jerome Mariette committed
228
        return substr
Frédéric Escudié's avatar
Frédéric Escudié committed
229

Jerome Mariette's avatar
Jerome Mariette committed
230
231
232
233
    def get_outputs(self, output_list=None, input_list=None):
        """
        If `output_list` is a string template, then it may have the following
        fields:
Frédéric Escudié's avatar
Frédéric Escudié committed
234

Jerome Mariette's avatar
Jerome Mariette committed
235
236
237
238
        - `{fullpath}`, `{FULL}`         -- Full input file path.
        - `{basename}`, `{BASE}`         -- Base input file name.
        - `{fullpath_woext}`, `{FULLWE}` -- Full input file path without extension
        - `{basename_woext}`, `{BASEWE}` -- Base input file name without extension
Frédéric Escudié's avatar
Frédéric Escudié committed
239
        """
Jerome Mariette's avatar
Jerome Mariette committed
240
241
        if output_list is None:
            return []
Frédéric Escudié's avatar
Frédéric Escudié committed
242

Jerome Mariette's avatar
Jerome Mariette committed
243
        if isinstance(output_list, str):
Jerome Mariette's avatar
Jerome Mariette committed
244
            ilist = []
Jerome Mariette's avatar
Jerome Mariette committed
245
            if not input_list or not '{' in str(output_list):
246
247
248
249
                if input_list is not None and len(input_list) == 0:
                    return []
                else:
                    return [output_list]
Jerome Mariette's avatar
Jerome Mariette committed
250
251
252
253
254
255
256
257
258
259
            # if multiple list of inputs is used
            elif isinstance(input_list[0], list):
                for i, val in enumerate(input_list[0]):
                    iter_values = []
                    for j, ingroup in enumerate(input_list):
                        iter_values.append(os.path.basename(input_list[j][i]))
                    ilist.append(self._longestCommonSubstr(iter_values))
            else:
                ilist = parse_string_list(input_list)
                            
Jerome Mariette's avatar
Jerome Mariette committed
260
261
262
263
264
265
266
267
268
269
270
            return [os.path.join(self.output_directory, str(output_list).format(
                        fullpath       = input,
                        FULL           = input,
                        i              = '{0:05X}'.format(i),
                        NUMBER         = '{0:05X}'.format(i),
                        fullpath_woext = os.path.splitext(input)[0],
                        FULL_WOEXT     = os.path.splitext(input)[0],
                        basename       = os.path.basename(input),
                        BASE           = os.path.basename(input),
                        basename_woext = os.path.splitext(os.path.basename(input))[0] if os.path.splitext(os.path.basename(input))[1] != ".gz" else os.path.splitext(os.path.splitext(os.path.basename(input))[0])[0],
                        BASE_WOEXT     = os.path.splitext(os.path.basename(input))[0] if os.path.splitext(os.path.basename(input))[1] != ".gz" else os.path.splitext(os.path.splitext(os.path.basename(input))[0])[0]))
Jerome Mariette's avatar
Jerome Mariette committed
271
                    for i, input in enumerate(ilist)]
Jerome Mariette's avatar
Jerome Mariette committed
272
273
274
    
    def execute(self):
        # first create the output directory
Jerome Mariette's avatar
Jerome Mariette committed
275
276
        if not os.path.isdir(self.output_directory):
            os.makedirs(self.output_directory, 0751)
Jerome Mariette's avatar
Jerome Mariette committed
277
        # then run the component
Jerome Mariette's avatar
Jerome Mariette committed
278
        self.process()
Jerome Mariette's avatar
Jerome Mariette committed
279
    
Jerome Mariette's avatar
Jerome Mariette committed
280
    def process(self):
Jerome Mariette's avatar
Jerome Mariette committed
281
282
283
284
285
        """ 
        Run the component, has to be implemented by subclasses
        """
        raise NotImplementedError
    
286
287
288
289
    def get_version(self):
        """ 
        Return the tool version, has to be implemented by subclasses
        """
Jerome Mariette's avatar
Jerome Mariette committed
290
        return None
291
    
Jerome Mariette's avatar
Jerome Mariette committed
292
293
294
295
296
297
298
299
300
301
302
303
    def get_temporary_file(self, suffix=".txt"):
        # first check if tmp directory exists
        if not os.path.isdir(self.config_reader.get_tmp_directory()):
            os.makedirs(self.config_reader.get_tmp_directory(), 0751)
        tempfile_name = os.path.basename(tempfile.NamedTemporaryFile(suffix=suffix).name)
        return os.path.join(self.config_reader.get_tmp_directory(), tempfile_name)
    
    def define_parameters(self, *args):
        """ 
        Define the component parameters, has to be implemented by subclasses
        """
        raise NotImplementedError
304
305
306

    def get_resource(self, resource):
        return self.config_reader.get_resource(resource)
Jerome Mariette's avatar
Jerome Mariette committed
307
308
    
    def get_exec_path(self, software):
309
        exec_path = self.config_reader.get_exec(software)
310
311
312
        if exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../../bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../../bin", software)
        elif exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)):
313
314
315
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)
        elif exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)
316
        elif exec_path is None and which(software) == None:
Jerome Mariette's avatar
Jerome Mariette committed
317
            display_error_message("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
318
319
320
        elif exec_path is None and which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
Jerome Mariette's avatar
Jerome Mariette committed
321
            display_error_message("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
322
        return exec_path
Jerome Mariette's avatar
Jerome Mariette committed
323
    
Jerome Mariette's avatar
Jerome Mariette committed
324
325
326
    def get_nameid(self):
        return self.__class__.__name__ + "." + self.prefix
    
Jerome Mariette's avatar
Jerome Mariette committed
327
328
    def __eq__(self, other):
        return self.__class__ == other.__class__ and self.prefix == other.prefix