parameter.py 39 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
#
# 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/>.
#

Frédéric Escudié's avatar
Frédéric Escudié committed
18
import re
19
import sys
Jerome Mariette's avatar
Jerome Mariette committed
20
import types
Jerome Mariette's avatar
Jerome Mariette committed
21
import datetime
Jerome Mariette's avatar
Jerome Mariette committed
22
import logging
Jerome Mariette's avatar
Jerome Mariette committed
23
import argparse
Jerome Mariette's avatar
Jerome Mariette committed
24
25
import os
import tempfile
26
from argparse import _ensure_value
Jerome Mariette's avatar
Jerome Mariette committed
27
import urllib2
28
import copy as _copy
Jerome Mariette's avatar
Jerome Mariette committed
29
from urlparse import urlparse
30

Jerome Mariette's avatar
Jerome Mariette committed
31
from jflow.config_reader import JFlowConfigReader
32
from jflow.utils import get_octet_string_representation, get_nb_octet
Jerome Mariette's avatar
Jerome Mariette committed
33

Jerome Mariette's avatar
Jerome Mariette committed
34
# import custom types and custom formats
Jerome Mariette's avatar
Jerome Mariette committed
35
from workflows.types import *
Jerome Mariette's avatar
Jerome Mariette committed
36
from workflows.formats import *
Jerome Mariette's avatar
Jerome Mariette committed
37

Jerome Mariette's avatar
Jerome Mariette committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# define all input type available
INPUTFILE_TYPES = ["inputfile", "localfile", "urlfile", "browsefile"]

def browsefile(file):
    # browsefile are not available from command line, considere it as a localfile
    # from the gui, this will not been tested this way
    return localfile(file)

def localfile(file):
    if os.path.isfile(file):
        return os.path.abspath(file)
    else:
        raise argparse.ArgumentTypeError("Local file '" + file + "' does not exists! Please provide a valid file path!")
52

Jerome Mariette's avatar
Jerome Mariette committed
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
def urlfile(file):
    uri_object = urlparse(file)
    try:
        opener = urllib2.urlopen(file)
    except:
        raise argparse.ArgumentTypeError("URL '" + file + "' is invalid!")
    file_name = os.path.basename(uri_object.path)
    if file_name is not None and file_name != "":
        metadata = opener.info()
        file_size = int(metadata.getheaders("Content-Length")[0])
        if file_size == 0:
            raise argparse.ArgumentTypeError("The URL file '" + file + "' is empty!")
        return file
    else:
        raise argparse.ArgumentTypeError("URL '" + file + "' does not contain any file name!")
68

Jerome Mariette's avatar
Jerome Mariette committed
69
70
71
72
73
74
75
76
def inputfile(file):
    # test the format
    uri_object = urlparse(file)
    # check the file
    if uri_object.scheme == '':
        return localfile(file)
    else:
        return urlfile(file)
77

78
def create_test_function(type):
Jerome Mariette's avatar
Jerome Mariette committed
79
80
    try: type = type.encode('ascii','ignore')
    except: pass
81
82
83
    try:
        ctype, csizel = type.split(AbstractInputFile.SIZE_LIMIT_SPLITER)
        def inner_function(ifile):
Jerome Mariette's avatar
Jerome Mariette committed
84
85
            # first eval the asked type
            returned_value = eval(ctype)(ifile)
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
            # first test the size of the file
            uri_object = urlparse(ifile)
            if uri_object.scheme == '':
                isize = os.path.getsize(ifile)
                if isize > int(get_nb_octet(csizel)):
                    raise argparse.ArgumentTypeError("File '" + ifile + "' (size=" + get_octet_string_representation(isize) + ") exceeds size limits: " + csizel + ".")
            else:
                try:
                    opener = urllib2.urlopen(file)
                    metadata = opener.info()
                    isize = int(metadata.getheaders("Content-Length")[0])
                    if isize > int(get_nb_octet(csizel)):
                        raise argparse.ArgumentTypeError("File '" + ifile + "' (size=" + get_octet_string_representation(isize) + ") exceeds size limits: " + csizel + ".")
                except:
                    raise argparse.ArgumentTypeError("URL '" + file + "' is invalid!")
            # then test the type
Jerome Mariette's avatar
Jerome Mariette committed
102
            return returned_value
103
104
105
106
107
        inner_function.__name__ = ctype+AbstractInputFile.SIZE_LIMIT_SPLITER+csizel
        return inner_function
    except:
        return type

Jerome Mariette's avatar
Jerome Mariette committed
108
class MultipleParameters(object):
109
    def __init__(self, types, required, choices, excludes, default, actions):
Jerome Mariette's avatar
Jerome Mariette committed
110
        self.types = types
111
        self.choices = choices
Jerome Mariette's avatar
Jerome Mariette committed
112
        self.excludes = excludes
113
        self.default = default
114
        self.actions = actions
Jerome Mariette's avatar
Jerome Mariette committed
115
        self.index = None
116
        self.required = required
Jerome Mariette's avatar
Jerome Mariette committed
117
        self.__name__ = "MultipleParameters"
118

Jerome Mariette's avatar
help ok    
Jerome Mariette committed
119
120
121
122
123
    def get_help(self):
        help = " ("
        for flag in self.types.keys():
            help += flag + "=<" + self.types[flag].__name__.upper() + ">, "
        return help[:-2] + ")"
124

125
    def __call__(self, arg):
Jerome Mariette's avatar
Jerome Mariette committed
126
127
128
        parts = arg.split("=")
        if not self.types.has_key(parts[0]):
            raise argparse.ArgumentTypeError(parts[0] + " is an invalid flag! Available ones are: "+", ".join(self.types.keys()))
129
130
131
        if self.choices[parts[0]] != None:
            if parts[1] not in self.choices[parts[0]]:
                raise argparse.ArgumentTypeError("argument " + parts[0] + ": invalid choice: '" + parts[1] + "' (choose from " + ", ".join(self.choices[parts[0]]) + "))")
132

133
134
135
136
137
138
139
        if self.types[parts[0]] == types.BooleanType:
            return (parts[0], not self.default[parts[0]], self.required, self.excludes)
        else:
            try:
                value = self.types[parts[0]](parts[1])
            except:
                raise argparse.ArgumentTypeError("invalid " + self.types[parts[0]].__name__ + " value: '" + parts[1] + "' for sub parameter '" + parts[0] + "'")
140

141
            self.index = parts[0]
142
            return (parts[0], value, self.required, self.excludes, self.actions)
Jerome Mariette's avatar
Jerome Mariette committed
143

144
145
class MiltipleAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
146
147
148
149
150
151
152
        # what is commun within required and excludes
        exclusif_required = {}
        for exclude_group in values[0][3]:
            exclusif_required[exclude_group] = False
            for param in values[0][3][exclude_group]:
                if param in values[0][2]:
                    exclusif_required[exclude_group] = True
Jerome Mariette's avatar
Jerome Mariette committed
153
154
        given_params = []
        # first check for required parameters
155
156
        try:
            required = _copy.copy(values[0][2])
157
158
159
160
161
162
            # delete required that are exclusive
            for group in exclusif_required:
                if exclusif_required[group]:
                    for val in values[0][3][group]:
                        if val in required:
                            del required[required.index(val)]
163
            for val in values:
Jerome Mariette's avatar
Jerome Mariette committed
164
                given_params.append(val[0])
165
166
167
168
169
                if val[0] in required:
                    del required[required.index(val[0])]
        except: pass
        if len(required) == 1: parser.error(", ".join(required) + " is a required parameter!")
        elif len(required) > 1: parser.error(", ".join(required) + " are required parameters!")
Jerome Mariette's avatar
Jerome Mariette committed
170
171
172
173
174
175
176
177
        # then for exclude ones    
        for exclude_group in values[0][3]:
            found = None
            for param in values[0][3][exclude_group]:
                if param in given_params and found != None:
                    parser.error("argument '" + found + "': not allowed with argument '" + param + "'")
                    break
                elif param in given_params: found = param
178

179
180
181
182
183
184
185
186
        # check for required exclusive if one of them is in
        if len(exclusif_required.keys()) > 0:
            for group in exclusif_required:
                if exclusif_required[group]:
                    rfound = False
                    for param in values[0][3][group]:
                        if param in given_params: rfound = True
            if not rfound: parser.error("one of the arguments: " + ", ".join(values[0][3][group]) + " is required")
187

Jerome Mariette's avatar
Jerome Mariette committed
188
        # if ok add the value
189
190
191
192
193
194
195
196
197
198
199
        final_hash, final_values = {}, []
        for value in values:
            if values[0][4][value[0]] == "append" and final_hash.has_key(value[0]):
                final_hash[value[0]].append(value[1])
            elif values[0][4][value[0]] == "append":
                final_hash[value[0]]= [value[1]]
            else:
                final_hash[value[0]]= value[1]
        for param in final_hash:
            final_values.append((param, final_hash[param]))
        setattr(namespace, self.dest, final_values)
200

201

202
203
class MiltipleAppendAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
204
205
206
207
208
209
210
        # what is commun within required and excludes
        exclusif_required = {}
        for exclude_group in values[0][3]:
            exclusif_required[exclude_group] = False
            for param in values[0][3][exclude_group]:
                if param in values[0][2]:
                    exclusif_required[exclude_group] = True
Jerome Mariette's avatar
Jerome Mariette committed
211
212
        given_params = []
        # first check for required parameters
213
214
        try:
            required = _copy.copy(values[0][2])
215
216
217
218
219
220
            # delete required that are exclusive
            for group in exclusif_required:
                if exclusif_required[group]:
                    for val in values[0][3][group]:
                        if val in required:
                            del required[required.index(val)]
221
            for val in values:
Jerome Mariette's avatar
Jerome Mariette committed
222
                given_params.append(val[0])
223
224
225
226
227
                if val[0] in required:
                    del required[required.index(val[0])]
        except: pass
        if len(required) == 1: parser.error(", ".join(required) + " is a required parameter!")
        elif len(required) > 1: parser.error(", ".join(required) + " are required parameters!")
Jerome Mariette's avatar
Jerome Mariette committed
228
229
230
231
232
233
234
235
        # then for exclude ones    
        for exclude_group in values[0][3]:
            found = None
            for param in values[0][3][exclude_group]:
                if param in given_params and found != None:
                    parser.error("argument '" + found + "': not allowed with argument '" + param + "'")
                    break
                elif param in given_params: found = param
236

237
238
239
240
241
242
243
244
        # check for required exclusive if one of them is in
        if len(exclusif_required.keys()) > 0:
            for group in exclusif_required:
                if exclusif_required[group]:
                    rfound = False
                    for param in values[0][3][group]:
                        if param in given_params: rfound = True
            if not rfound: parser.error("one of the arguments: " + ", ".join(values[0][3][group]) + " is required")
Jerome Mariette's avatar
Jerome Mariette committed
245
        # if ok add the value
246
        items = _copy.copy(_ensure_value(namespace, self.dest, []))
247
248
249
250
251
252
253
254
255
256
257
        final_hash, final_values = {}, []
        for value in values:
            if values[0][4][value[0]] == "append" and final_hash.has_key(value[0]):
                final_hash[value[0]].append(value[1])
            elif values[0][4][value[0]] == "append":
                final_hash[value[0]]= [value[1]]
            else:
                final_hash[value[0]]= value[1]
        for param in final_hash:
            final_values.append((param, final_hash[param]))
        items.append(final_values)
258
        setattr(namespace, self.dest, items)
259
260
261


class AbstractParameter(object):
262

263
264
    def __init__(self, name, help, default=None, type=types.StringType, choices=None, required=False,
                 flag=None, action="store", sub_parameters=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
265

Jerome Mariette's avatar
Jerome Mariette committed
266
267
        self.name = name
        self.help = help
268
        self.action = action
Jerome Mariette's avatar
Jerome Mariette committed
269
        self.nargs = None
270
271
272
        if sub_parameters:
            self.sub_parameters = sub_parameters
        else: self.sub_parameters = []
Jerome Mariette's avatar
Jerome Mariette committed
273
        self.group = group
274
275
276
        if flag == None:
            self.flag = "--"+name.replace("_", "-")
        else: self.flag = flag
277
        if display_name == None:
278
            self.display_name = name.replace("_", " ").title()
Jerome Mariette's avatar
Jerome Mariette committed
279
        else: self.display_name = display_name
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
280
        self.required = required
281
        self.choices = choices
282
283

        # Set parameter type
Jerome Mariette's avatar
Jerome Mariette committed
284
        if type == "date":
Frédéric Escudié's avatar
Frédéric Escudié committed
285
            self.type = date
Jerome Mariette's avatar
Jerome Mariette committed
286
        elif type == "multiple":
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
287
            self.type = "multiple"
Jerome Mariette's avatar
Jerome Mariette committed
288
289
        elif isinstance(type, types.FunctionType):
            self.type = type
290
        elif type in [types.StringType, types.IntType, types.FloatType,  types.BooleanType]:
Jerome Mariette's avatar
Jerome Mariette committed
291
            self.type = type
Jerome Mariette's avatar
Jerome Mariette committed
292
293
294
        else:
            try: self.type = eval(type)
            except: self.type = types.StringType
295
296

        # Set parameter value
Jerome Mariette's avatar
Jerome Mariette committed
297
        self.default = default
298

299
    def export_to_argparse(self):
Jerome Mariette's avatar
Jerome Mariette committed
300
        if self.type == types.BooleanType and str(self.default).lower() in (False, "false",  "f", "0"):
301
302
303
            return {"help": self.help, "required": self.required, "dest": self.name, 
                    "default": False, "action": "store_true"}
        elif self.type == types.BooleanType:
304
            return {"help": self.help, "required": self.required, "dest": self.name, 
305
                    "default": True, "action": "store_false"}
Jerome Mariette's avatar
Jerome Mariette committed
306
        elif self.nargs > 1:
307
            return {"type": self.get_test_function(), "help": self.help, "required": self.required,
Jerome Mariette's avatar
Jerome Mariette committed
308
                    "dest": self.name, "default": self.default,
Jerome Mariette's avatar
Jerome Mariette committed
309
                    "action": self.action, "choices": self.choices, "nargs": "+"}
310
        else:
311
            return {"type": self.get_test_function(), "help": self.help, "required": self.required,
Jerome Mariette's avatar
Jerome Mariette committed
312
                    "dest": self.name, "default": self.default,
313
                    "action": self.action, "choices": self.choices}
314

Jerome Mariette's avatar
Jerome Mariette committed
315
316
    def get_type(self):
        return self.type.__name__
317

318
319
    def get_test_function(self):
        return create_test_function(self.type)
320

Jerome Mariette's avatar
Jerome Mariette committed
321
class AbstractIOFile(object):
322

Jerome Mariette's avatar
Jerome Mariette committed
323
324
    def __init__(self, file_format="any"):
        self.file_format = file_format
Jerome Mariette's avatar
Jerome Mariette committed
325
        self.component_nameid = None
326
        self.parent_component_nameid = []
Jerome Mariette's avatar
Jerome Mariette committed
327
328
329


class MultiParameter(dict, AbstractParameter):
Frédéric Escudié's avatar
Frédéric Escudié committed
330

Jerome Mariette's avatar
Jerome Mariette committed
331
332
333
334
335
    def __init__(self, name, help, required=False, flag=None, group="default", display_name=None):
        AbstractParameter.__init__(self, name, help, required=required, type="multiple", flag=flag, group=group, 
                                   display_name=display_name)
        return dict.__init__(self, {})

Jerome Mariette's avatar
help ok    
Jerome Mariette committed
336
337
338
    def add_sub_parameter(self, param):
        param_flag = param.flag[2:]
        if self.type == "multiple":
Jerome Mariette's avatar
Jerome Mariette committed
339
340
341
            if param.required: req = [param_flag] 
            else: req = []
            self.type = MultipleParameters({param_flag: param.type}, req, 
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
342
343
344
345
346
347
348
349
                                           {param_flag: param.choices}, {}, {param_flag: param.default},
                                           {param_flag: param.action})
            if self.action == "append":
                self.action = MiltipleAppendAction
            else:
                self.action = MiltipleAction
            self.global_help = self.help
            self.help = self.global_help + " (" + param_flag + "=<" + param.type.__name__.upper() + ">)"
Jerome Mariette's avatar
Jerome Mariette committed
350
            self.default = {}
Jerome Mariette's avatar
Jerome Mariette committed
351
            self.nargs = "+"
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
352
353
354
        elif self.type.__class__ == MultipleParameters:
            self.type.types[param_flag] = param.type
            self.type.choices[param_flag] = param.choices
355
            self.type.default[param_flag] = param.default if param != None else None
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
356
            self.type.actions[param_flag] = param.action
Jerome Mariette's avatar
Jerome Mariette committed
357
358
            if param.required:
                self.type.required.append(param_flag)
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
359
            self.help = self.global_help + self.type.get_help()
Jerome Mariette's avatar
Jerome Mariette committed
360
        param.flag = param_flag
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
361
        self.sub_parameters.append(param)
362

363
364

class MultiParameterList(list, AbstractParameter):
Frédéric Escudié's avatar
Frédéric Escudié committed
365

366
    def __init__(self, name, help, required=False, flag=None, group="default", display_name=None):
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
367
368
        AbstractParameter.__init__(self, name, help, required=required, type="multiple", flag=flag, 
                                   action="append", group=group, display_name=display_name)
369
        return list.__init__(self, [])
Jerome Mariette's avatar
Jerome Mariette committed
370

Jerome Mariette's avatar
Jerome Mariette committed
371
372
373
    def add_sub_parameter(self, param):
        param_flag = param.flag[2:]
        if self.type == "multiple":
Frédéric Escudié's avatar
Frédéric Escudié committed
374
            if param.required: req = [param_flag]
Jerome Mariette's avatar
Jerome Mariette committed
375
            else: req = []
Frédéric Escudié's avatar
Frédéric Escudié committed
376
            self.type = MultipleParameters({param_flag: param.type}, req,
Jerome Mariette's avatar
Jerome Mariette committed
377
378
379
380
381
382
383
384
385
386
387
388
389
                                           {param_flag: param.choices}, {}, {param_flag: param.default},
                                           {param_flag: param.action})
            if self.action == "append":
                self.action = MiltipleAppendAction
            else:
                self.action = MiltipleAction
            self.global_help = self.help
            self.help = self.global_help + " (" + param_flag + "=<" + param.type.__name__.upper() + ">)"
            self.default = []
            self.nargs = "+"
        elif self.type.__class__ == MultipleParameters:
            self.type.types[param_flag] = param.type
            self.type.choices[param_flag] = param.choices
390
            self.type.default[param_flag] = param.default if param != None else None
Jerome Mariette's avatar
Jerome Mariette committed
391
392
393
394
395
396
397
            self.type.actions[param_flag] = param.action
            if param.required:
                self.type.required.append(param_flag)
            self.help = self.global_help + self.type.get_help()
        param.flag = param_flag
        self.sub_parameters.append(param)

398

Frédéric Escudié's avatar
Frédéric Escudié committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
class ParameterFactory(object):
    @staticmethod
    def factory(*args, **kwargs):
        if not kwargs.has_key( "type" ):
            return StrParameter( *args, **kwargs )

        if kwargs["type"] == "int" or kwargs["type"] is types.IntType:
            return IntParameter( *args, **kwargs )
        elif kwargs["type"] == "bool" or kwargs["type"] is types.BooleanType:
            return BoolParameter( *args, **kwargs )
        elif kwargs["type"] == "float" or kwargs["type"] is types.FloatType:
            return FloatParameter( *args, **kwargs )
        elif kwargs["type"] == "date" or kwargs["type"] == date:
            return DateParameter( *args, **kwargs )
        else:
            return StrParameter( *args, **kwargs )


417
418
419
420
421
422
def noneException(*args, **kwargs):
    raise Exception( "The parameter value is None." )


class BoolParameter(int, AbstractParameter):

Frédéric Escudié's avatar
Frédéric Escudié committed
423
    def __new__(self, name, help, default=False, type=types.BooleanType, choices=None, required=False,
424
                flag=None, sub_parameters=None, group="default", display_name=None):
425
426
427
428
429
430
431
432
433
434
435
436
437
        bool_default = False if default == None else bool(default)
        val = int.__new__(self, bool_default)
        val.is_None = False
        if default == None:
            val.is_None = True
            for attr in val.__dict__:
                value = getattr(val, attr)
                if callable(value) and attr not in ["__new__", "__init__", "__int__", "__getattribute__", "__eq__", "__ne__", "__nonzero__"]:
                    setattr(val, attr, noneException)
        return val

    def __init__(self, name, help, default=None, type=types.BooleanType, choices=None, required=False,
                 flag=None, sub_parameters=None, group="default", display_name=None):
Frédéric Escudié's avatar
Frédéric Escudié committed
438
        AbstractParameter.__init__(self, name, help, flag=flag, default=bool(default), type=type, choices=choices, required=required, 
439
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)
440

Frédéric Escudié's avatar
Frédéric Escudié committed
441
442
443
444
445
    def __str__(self):
        if self.is_None:
            noneException()
        return str(bool(self))

446
447
    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
448
449
450
451
            return self.is_None
        elif self.is_None:
            return False
        else:
Frédéric Escudié's avatar
Frédéric Escudié committed
452
            return int(self) == int(bool(other))
453

454
    def __ne__(self, other):
Frédéric Escudié's avatar
Frédéric Escudié committed
455
        return not (self == other)
456

457
    def __nonzero__(self):
458
        if self.is_None:
459
            return False
460
461
462
        else:
            return self != 0

463

464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
class IntParameter(int, AbstractParameter):

    def __new__(self, name, help, default=None, type=types.IntType, choices=None, required=False,
                flag=None, sub_parameters=None, group="default", display_name=None):
        int_default = 0 if default == None else int(default)
        val = int.__new__(self, int_default)
        val.is_None = False
        if default == None:
            val.is_None = True
            for attr in val.__dict__:
                value = getattr(val, attr)
                if callable(value) and attr not in ["__new__", "__init__", "__int__", "__getattribute__", "__eq__", "__ne__", "__nonzero__"]:
                    setattr(val, attr, noneException)
        return val

    def __init__(self, name, help, default=None, type=types.IntType, choices=None, required=False,
480
                 flag=None, sub_parameters=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
481
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required, 
482
483
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)

484
485
486
487
488
489
490
491
492
    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
            return self.is_None
        elif self.is_None:
            return False
        else:
            return int(self) == int(other)

    def __ne__(self, other):
Frédéric Escudié's avatar
Frédéric Escudié committed
493
        return not (self == other)
494
495
496
497
498
499
500
501

    def __nonzero__(self):
        if self.is_None:
            return False
        else:
            return self != 0


Frédéric Escudié's avatar
Frédéric Escudié committed
502
class FloatParameter(float, AbstractParameter):
503
504
505
506

    def __new__(self, name, help, default=None, type=types.FloatType, choices=None, required=False,
                flag=None, sub_parameters=None, group="default", display_name=None):
        float_default = 0.0 if default == None else float(default)
Frédéric Escudié's avatar
Frédéric Escudié committed
507
        val = float.__new__(self, float_default)
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
        val.is_None = False
        if default == None:
            val.is_None = True
            for attr in val.__dict__:
                value = getattr(val, attr)
                if callable(value) and attr not in ["__new__", "__init__", "__float__", "__getattribute__", "__eq__", "__ne__", "__nonzero__"]:
                    setattr(val, attr, noneException)
        return val

    def __init__(self, name, help, default=None, type=types.FloatType, choices=None, required=False,
                 flag=None, sub_parameters=None, group="default", display_name=None):
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required, 
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)

    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
            return self.is_None
        elif self.is_None:
            return False
        else:
            return float(self) == float(other)

    def __ne__(self, other):
Frédéric Escudié's avatar
Frédéric Escudié committed
531
        return not (self == other)
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568

    def __nonzero__(self):
        if self.is_None:
            return False
        else:
            return self != 0.0


class StrParameter(str, AbstractParameter):

    def __new__(self, name, help, default=None, type=types.StringType, choices=None, required=False,
                flag=None, sub_parameters=None, group="default", display_name=None):
        str_default = "" if default == None else str(default)
        val = str.__new__(self, str_default)
        val.is_None = False
        if default == None:
            val.is_None = True
            for attr in val.__dict__:
                value = getattr(val, attr)
                if callable(value) and attr not in ["__new__", "__init__", "__str__", "__getattribute__", "__eq__", "__ne__", "__nonzero__"]:
                    setattr(val, attr, noneException)
        return val

    def __init__(self, name, help, default=None, type=types.StringType, choices=None, required=False,
                 flag=None, sub_parameters=None, group="default", display_name=None):
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required, 
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)

    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
            return self.is_None
        elif self.is_None:
            return False
        else:
            return str(self) == str(other)

    def __ne__(self, other):
Frédéric Escudié's avatar
Frédéric Escudié committed
569
        return not(self == other)
570
571
572
573
574
575
576
577

    def __nonzero__(self):
        if self.is_None:
            return False
        else:
            return (True if str(self) else False)


Frédéric Escudié's avatar
Frédéric Escudié committed
578
class DateParameter(datetime.datetime, AbstractParameter):
579

Frédéric Escudié's avatar
Frédéric Escudié committed
580
581
582
583
584
585
586
587
588
589
590
    def __new__(self, name, help, default=None, type=date, choices=None, required=False,
                flag=None, sub_parameters=None, group="default", display_name=None):
        date_default = datetime.datetime.today()
        if default != None and issubclass(default.__class__, datetime.datetime):
            date_default = default
        elif default != None:
            date_default = date(default)

        val = datetime.datetime.__new__(self, date_default.year, date_default.month, date_default.day)
        if default != None:
            val.is_None = False
591
        else:
Frédéric Escudié's avatar
Frédéric Escudié committed
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
            val.is_None = True
            for attr in val.__dict__:
                value = getattr(val, attr)
                if callable(value) and attr not in ["__new__", "__init__", "__getattribute__", "__eq__", "__ne__", "__nonzero__"]:
                    setattr(val, attr, noneException)
        return val

    def __init__(self, name, help, default=None, type=date, choices=None, required=False,
                 flag=None, sub_parameters=None, group="default", display_name=None):
        if default != None and not issubclass(default.__class__, datetime.datetime):
            date_default = date(default)
            default = datetime.datetime(date_default.year, date_default.month, date_default.day)
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required, 
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)

    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
            return self.is_None
        elif self.is_None:
            return False
        else:
            return datetime.date(self.year, self.month, self.day) == other

    def __ne__(self, other):
        return not( self == other )

    def __nonzero__(self):
        if self.is_None:
            return False
        else:
            return (True if datetime.date(self.year, self.month, self.day) else False)

624
625
626
627
628
629
630
631
    def __reduce__(self):
        return (DateParameter, (self.name, self.help, self.default, date, self.choices, self.required,
                 self.flag, self.sub_parameters, self.group, self.display_name), None, None, None)

    def __reduce_ex__(self, protocol):
        return (DateParameter, (self.name, self.help, self.default, date, self.choices, self.required,
                 self.flag, self.sub_parameters, self.group, self.display_name), None, None, None)

Frédéric Escudié's avatar
Frédéric Escudié committed
632
633
634
635
636

class AbstractInputFile(AbstractIOFile):
    """
     @summary : Parent of all InputFile(s) parameters.
    """
637
638
639
640
641
642
643
    
    SIZE_LIMIT_SPLITER = "__sl"
    
    def __init__(self, file_format="any", size_limit="0"):
        AbstractIOFile.__init__(self, file_format)
        self.size_limit = size_limit
    
Jerome Mariette's avatar
Jerome Mariette committed
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
    def _download_urlfile(self, input):
        try:
            uri_object = urlparse(input)
            opener = urllib2.urlopen(input)
            block_size = 8000
            jflowconf = JFlowConfigReader()
            tmp_directory = os.path.join(jflowconf.get_tmp_directory(), os.path.basename(tempfile.NamedTemporaryFile().name))
            os.mkdir(tmp_directory) 
            file_path = os.path.join(tmp_directory, os.path.basename(uri_object.path))
            local_file = open(file_path, 'wb')
            if os.path.basename(uri_object.path) is not None and os.path.basename(uri_object.path) != "":
                metadata = opener.info()
                file_size = int(metadata.getheaders("Content-Length")[0])
                while True:
                    buffer = opener.read(block_size)
                    # End of download
                    if not buffer: break
                    # Parts of download
                    local_file.write(buffer)
                local_file.close()
                logging.getLogger("AbstractInputFile.download_urlfile").debug("URL file '{0}' successfully downloaded as: {1}".format(input, file_path))
            return [file_path, True]
        except:
            return [input, False]
668

Jerome Mariette's avatar
Jerome Mariette committed
669
    def check(self, ifile):
Jerome Mariette's avatar
Jerome Mariette committed
670
671
672
673
        try:
            eval(self.file_format)
            function_exists = True
        except: function_exists = False
674
675
676
677
678
679
680
681
682
        if function_exists:
            try: 
                eval(self.file_format)(ifile)
            except jflow.InvalidFormatError as e:
                sys.stderr.write(str(e)+"\n")
                sys.exit(1)
        else:
            sys.stderr.write("Error: Invalid file format '" + self.file_format + "'!\n")
            sys.exit(1)
Frédéric Escudié's avatar
Frédéric Escudié committed
683
684
685
686
687
688
689

class AbstractOutputFile(AbstractIOFile):
    """
     @summary : Parent of all OutputFile(s) parameters.
    """
    pass

690
691
692

class InputFile(StrParameter, AbstractInputFile):

Jerome Mariette's avatar
Jerome Mariette committed
693
    def __new__(self, name, help, file_format="any", default="", type="localfile", choices=None, 
694
                required=False, flag=None, group="default", display_name=None, size_limit="0"):
695

Jerome Mariette's avatar
Jerome Mariette committed
696
697
698
        if hasattr(type, '__call__'):
            type2test = type.__name__
        else: type2test = type
699

Jerome Mariette's avatar
Jerome Mariette committed
700
701
702
        if type2test not in INPUTFILE_TYPES:
            raise ValueError("InputFile.__new__: wrong type provided: '"+type2test+"', this should be choosen between '" 
                             + "', '".join(INPUTFILE_TYPES)+"'")
703
704
705
706

        return StrParameter.__new__(self, name, help, flag=flag, default=default, type=type, choices=choices, 
                           required=required, group=group, display_name=display_name)

Jerome Mariette's avatar
Jerome Mariette committed
707
    def __init__(self, name, help, file_format="any", default="", type="localfile", choices=None, 
708
709
                required=False, flag=None, group="default", display_name=None, size_limit="0"):
        AbstractInputFile.__init__(self, file_format, size_limit)
710
        StrParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, 
711
                           required=required, group=group, display_name=display_name)
Jerome Mariette's avatar
Jerome Mariette committed
712

Jerome Mariette's avatar
Jerome Mariette committed
713
714
715
    def get_type(self):
        return self.type.__name__+AbstractInputFile.SIZE_LIMIT_SPLITER+self.size_limit

716
717
    def get_test_function(self):
        if (self.size_limit == "0"): ctype = self.type
Jerome Mariette's avatar
Jerome Mariette committed
718
        else: ctype = self.get_type()
719
720
        return create_test_function(ctype)

Jerome Mariette's avatar
Jerome Mariette committed
721
722
723
724
725
726
727
728
729
730
    def prepare_input_file(self, input):
        # handle url inputs
        new_path, is_uri = self._download_urlfile(input)
        # handle upload inputs
        try: is_local = os.path.isfile(input)
        except: is_local = False
        if not is_uri and not is_local and self.type.__name__ == "inputfile" or self.type.__name__ == "browsefile":
            jflow_config_reader = JFlowConfigReader()
            new_path = os.path.join(jflow_config_reader.get_tmp_directory(), input)
        if is_local: new_path = input
Jerome Mariette's avatar
Jerome Mariette committed
731
        self.check(new_path)
Jerome Mariette's avatar
Jerome Mariette committed
732
        return new_path
733

Jerome Mariette's avatar
Jerome Mariette committed
734

735
736
class OutputFile(StrParameter, AbstractOutputFile):

Frédéric Escudié's avatar
Frédéric Escudié committed
737
    def __new__(self, name, help, file_format="any", default="", choices=None,
738
                required=False, flag=None, group="default", display_name=None):
Frédéric Escudié's avatar
Frédéric Escudié committed
739
        return StrParameter.__new__(self, name, help, flag=flag, default=default, type="localfile", choices=choices,
740
741
                           required=required, group=group, display_name=display_name)

Frédéric Escudié's avatar
Frédéric Escudié committed
742
    def __init__(self, name, help, file_format="any", default="", choices=None,
743
                required=False, flag=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
744
        AbstractIOFile.__init__(self, file_format)
745
        StrParameter.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
746
747
                           required=required, group=group, display_name=display_name)

748

749
class ParameterList(list, AbstractParameter):
750

Jerome Mariette's avatar
Jerome Mariette committed
751
    def __init__(self, name, help, default=None, type=types.StringType, choices=None, required=False,
752
                 flag=None, sub_parameters=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
753
        if default == None: default = []
Frédéric Escudié's avatar
Frédéric Escudié committed
754
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required,
755
756
757
758
759
                                   action="append", sub_parameters=sub_parameters, group=group, display_name=display_name)
        if default.__class__.__name__ == "str":
            return list.__init__(self, [default])
        elif default.__class__.__name__ == "list":
            return list.__init__(self, default)
760

761

Frédéric Escudié's avatar
Frédéric Escudié committed
762
class InputFileList(ParameterList, AbstractInputFile):
763

Jerome Mariette's avatar
Jerome Mariette committed
764
    def __init__(self, name, help, file_format="any", default=None, type="localfile", choices=None, 
765
                 required=False, flag=None, group="default", display_name=None, size_limit="0"):
766

Jerome Mariette's avatar
Jerome Mariette committed
767
        if default == None: default = []   
Jerome Mariette's avatar
Jerome Mariette committed
768
769
770
        if hasattr(type, '__call__'):
            type2test = type.__name__
        else: type2test = type
771

Jerome Mariette's avatar
Jerome Mariette committed
772
773
774
        if type2test not in INPUTFILE_TYPES:
            raise ValueError("InputFile.__new__: wrong type provided: '"+type2test+"', this should be choosen between '" 
                             + "', '".join(INPUTFILE_TYPES)+"'")
775

776
        AbstractInputFile.__init__(self, file_format, size_limit)
Jerome Mariette's avatar
Jerome Mariette committed
777
        ParameterList.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, 
778
                               required=required, group=group, display_name=display_name)
779

780
781
782
783
        if default.__class__.__name__ == "str":
            return list.__init__(self, [default])
        elif default.__class__.__name__ == "list":
            return list.__init__(self, default)
784
785
        elif issubclass( default.__class__, InputFile ):
            return list.__init__(self, [default])
Frédéric Escudié's avatar
Frédéric Escudié committed
786
        elif issubclass( default.__class__, AbstractInputFile ):
Jerome Mariette's avatar
Jerome Mariette committed
787
            return list.__init__(self, default)
788
789
        elif issubclass( default.__class__, OutputFile ):
            return list.__init__(self, [default])
Frédéric Escudié's avatar
Frédéric Escudié committed
790
        elif issubclass( default.__class__, AbstractOutputFile ):
Jerome Mariette's avatar
Jerome Mariette committed
791
            return list.__init__(self, default)
Jerome Mariette's avatar
Jerome Mariette committed
792
793
794
795
    
    def get_type(self):
        return self.type.__name__+AbstractInputFile.SIZE_LIMIT_SPLITER+self.size_limit
    
796
797
    def get_test_function(self):
        if (self.size_limit == "0"): ctype = self.type
Jerome Mariette's avatar
Jerome Mariette committed
798
        else: ctype = self.get_type()
799
800
        return create_test_function(ctype)

Jerome Mariette's avatar
Jerome Mariette committed
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
    def prepare_input_files(self, inputs):
        path2test = inputs
        if not path2test.__class__.__name__ == "list":
            path2test = [path2test]
        new_vals, done = [], []
        # handle url inputs
        for path in path2test:
            new_url, is_uri = self._download_urlfile(path)
            if is_uri:
                new_vals.append(new_url)
                done.append(path)
        for d in done: path2test.remove(d)
        done = []
        # handle localfile
        for path in path2test:
            if os.path.isfile(path):
                new_vals.append(path)
                done.append(path)
        for d in done: path2test.remove(d)        
        # handle upload inputs
        if self.type.__name__ == "inputfile" or self.type.__name__ == "browsefile":
            for path in path2test:
                jflow_config_reader = JFlowConfigReader()
                new_vals.append(os.path.join(jflow_config_reader.get_tmp_directory(), path))
Jerome Mariette's avatar
Jerome Mariette committed
825
826
827
        # now that all files are downloaded and ok, check the format
        for cfile in new_vals:
            self.check(cfile)
Jerome Mariette's avatar
Jerome Mariette committed
828
        return new_vals
829

Frédéric Escudié's avatar
Frédéric Escudié committed
830
831
class OutputFileList(ParameterList, AbstractOutputFile):

Jerome Mariette's avatar
Jerome Mariette committed
832
833
834
    def __init__(self, name, help, file_format="any", default=None, choices=None, 
                 required=False, flag=None, group="default", display_name=None):
        if default == None: default = []
Jerome Mariette's avatar
Jerome Mariette committed
835
        AbstractIOFile.__init__(self, file_format)
Jerome Mariette's avatar
Jerome Mariette committed
836
        ParameterList.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
837
838
839
840
841
                               required=required, group=group, display_name=display_name)
        if default.__class__.__name__ == "str":
            return list.__init__(self, [default])
        elif default.__class__.__name__ == "list":
            return list.__init__(self, default)
Frédéric Escudié's avatar
Frédéric Escudié committed
842

843

Frédéric Escudié's avatar
Frédéric Escudié committed
844
845
846
847
848
849
850
851
852
853
class DynamicOutput(ParameterList, AbstractOutputFile):
    """
     @warning : with this class of output, the component become dynamic.
    """
    def update(self):
        """
         This method is used at the end of component execution to update output list.
        """
        raise NotImplementedError

854

Frédéric Escudié's avatar
Frédéric Escudié committed
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
class OutputFilesEndsWith(DynamicOutput):

    def __init__(self, name, help, output_directory, end_str, include=True, file_format="any", choices=None, 
                 required=False, flag=None, group="default", display_name=None):
        """
         @warning : with this class of output, the component become dynamic.
         @param output_directory : path to the directory where outputs will be created.
         @param end_str : the end of the files names.
         @param include : if true, the files with name terminated by end_str are added into output files.
                          If false, the files with name not terminated by end_str are added into output files.
        """
        AbstractIOFile.__init__(self, file_format)
        default = []
        ParameterList.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
                               required=required, group=group, display_name=display_name)
        self.output_directory = output_directory
        self.end_str = end_str
        self.include = include
        return list.__init__(self, default)

    def update(self):
        output_files = list()
        for file in os.listdir( self.output_directory ):
            if file.endswith( self.end_str ) and self.include :
                output_files.append( os.path.join(self.output_directory, file) )
            elif not file.endswith( self.end_str ) and not self.include:
                output_files.append( os.path.join(self.output_directory, file) )
        list.__init__(self, output_files)

884

Frédéric Escudié's avatar
Frédéric Escudié committed
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
class OutputFilesPattern(DynamicOutput):

    def __init__(self, name, help, output_directory, pattern, include=True, file_format="any", choices=None, 
                  required=False, flag=None, group="default", display_name=None):
        """
         @warning : with this class of output, the component become dynamic.
         @param output_directory : path to the directory where outputs will be created.
         @param pattern : the pattern of (a part) the file names.
         @param include : if true, the files with the pattern in file name are added into output files.
                          If false, the files with the pattern in file name are added into output files.
        """
        AbstractIOFile.__init__(self, file_format)
        default = []
        ParameterList.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
                               required=required, group=group, display_name=display_name)
        self.output_directory = output_directory
        self.pattern = pattern
        self.include = include
        return list.__init__(self, default)

    def update(self):
        output_files = list()
        for file in os.listdir( self.output_directory ):
            if self.include and re.search( self.pattern, file ) is not None:
                output_files.append( os.path.join(self.output_directory, file) )
            elif not self.include and re.search( self.pattern, file ) is None:
                output_files.append( os.path.join(self.output_directory, file) )
        return list.__init__(self, output_files)