parameter.py 40.8 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
import os
25
import fnmatch
Jerome Mariette's avatar
Jerome Mariette committed
26
import tempfile
27
from argparse import _ensure_value
Jerome Mariette's avatar
Jerome Mariette committed
28
import urllib2
29
import copy as _copy
Jerome Mariette's avatar
Jerome Mariette committed
30
from urlparse import urlparse
31

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

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

Jerome Mariette's avatar
Jerome Mariette committed
39
40

# define all input type available
41
INPUTFILE_TYPES = ["inputfile", "localfile", "urlfile", "browsefile", "regexpfile"]
Jerome Mariette's avatar
Jerome Mariette committed
42
43
44
45
46
47
48
49
50
51

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:
Jerome Mariette's avatar
Jerome Mariette committed
52
        raise argparse.ArgumentTypeError("File '" + file + "' does not exists! Please provide a valid file path!")
53

Jerome Mariette's avatar
Jerome Mariette committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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!")
69

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

79
80
81
82
83
84
85
86
def regexpfile(file_pattern):
    folder, pattern = file_pattern.rsplit(':')
    files = list()
    for item in os.listdir(folder):
        if os.path.isfile(os.path.join(folder, item)) and fnmatch.fnmatch(item, pattern):
            files.append( localfile(os.path.join(folder, item)) )
    return files

87
88
def create_test_function(itype):
    try: itype = itype.encode('ascii','ignore')
Jerome Mariette's avatar
Jerome Mariette committed
89
    except: pass
90
    try:
91
        ctype, csizel = itype.split(AbstractInputFile.SIZE_LIMIT_SPLITER)
92
        def inner_function(ifile):
Jerome Mariette's avatar
Jerome Mariette committed
93
94
            # first eval the asked type
            returned_value = eval(ctype)(ifile)
95
96
97
98
99
100
            # if 0 unlimited size
            if csizel != "0":
                # first test the size of the file
                uri_object = urlparse(ifile)
                if uri_object.scheme == '':
                    isize = os.path.getsize(ifile)
101
102
                    if isize > int(get_nb_octet(csizel)):
                        raise argparse.ArgumentTypeError("File '" + ifile + "' (size=" + get_octet_string_representation(isize) + ") exceeds size limits: " + csizel + ".")
103
104
105
106
107
108
109
110
111
                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!")
112
            # then test the type
Jerome Mariette's avatar
Jerome Mariette committed
113
            return returned_value
114
115
116
        inner_function.__name__ = ctype+AbstractInputFile.SIZE_LIMIT_SPLITER+csizel
        return inner_function
    except:
117
118
119
120
        if type(itype) == str:
            return eval(itype)
        else:
            return itype
121

Jerome Mariette's avatar
Jerome Mariette committed
122
class MultipleParameters(object):
123
    def __init__(self, types, required, choices, excludes, default, actions):
Jerome Mariette's avatar
Jerome Mariette committed
124
        self.types = types
125
        self.choices = choices
Jerome Mariette's avatar
Jerome Mariette committed
126
        self.excludes = excludes
127
        self.default = default
128
        self.actions = actions
Jerome Mariette's avatar
Jerome Mariette committed
129
        self.index = None
130
        self.required = required
Jerome Mariette's avatar
Jerome Mariette committed
131
        self.__name__ = "MultipleParameters"
132

Jerome Mariette's avatar
help ok    
Jerome Mariette committed
133
134
135
136
137
    def get_help(self):
        help = " ("
        for flag in self.types.keys():
            help += flag + "=<" + self.types[flag].__name__.upper() + ">, "
        return help[:-2] + ")"
138

139
    def __call__(self, arg):
Jerome Mariette's avatar
Jerome Mariette committed
140
141
142
        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()))
143
144
145
        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]]) + "))")
146

147
148
149
150
151
152
153
        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] + "'")
154

155
            self.index = parts[0]
156
            return (parts[0], value, self.required, self.excludes, self.actions)
Jerome Mariette's avatar
Jerome Mariette committed
157

158
159
class MiltipleAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
160
161
162
163
164
165
166
        # 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
167
168
        given_params = []
        # first check for required parameters
169
170
        try:
            required = _copy.copy(values[0][2])
171
172
173
174
175
176
            # 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)]
177
            for val in values:
Jerome Mariette's avatar
Jerome Mariette committed
178
                given_params.append(val[0])
179
180
181
182
183
                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
184
185
186
187
188
189
190
191
        # 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
192

193
194
195
196
197
198
199
200
        # 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")
201

Jerome Mariette's avatar
Jerome Mariette committed
202
        # if ok add the value
203
204
205
206
207
208
209
210
211
212
213
        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)
214

215

216
217
class MiltipleAppendAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
218
219
220
221
222
223
224
        # 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
225
226
        given_params = []
        # first check for required parameters
227
228
        try:
            required = _copy.copy(values[0][2])
229
230
231
232
233
234
            # 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)]
235
            for val in values:
Jerome Mariette's avatar
Jerome Mariette committed
236
                given_params.append(val[0])
237
238
239
240
241
                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
242
243
244
245
246
247
248
249
        # 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
250

251
252
253
254
255
256
257
258
        # 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
259
        # if ok add the value
260
        items = _copy.copy(_ensure_value(namespace, self.dest, []))
261
262
263
264
265
266
267
268
269
270
271
        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)
272
        setattr(namespace, self.dest, items)
273
274
275


class AbstractParameter(object):
276

277
278
    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
279

Jerome Mariette's avatar
Jerome Mariette committed
280
281
        self.name = name
        self.help = help
282
        self.action = action
Jerome Mariette's avatar
Jerome Mariette committed
283
        self.nargs = None
284
285
286
        if sub_parameters:
            self.sub_parameters = sub_parameters
        else: self.sub_parameters = []
Jerome Mariette's avatar
Jerome Mariette committed
287
        self.group = group
288
289
290
        if flag == None:
            self.flag = "--"+name.replace("_", "-")
        else: self.flag = flag
291
        if display_name == None:
292
            self.display_name = name.replace("_", " ").title()
Jerome Mariette's avatar
Jerome Mariette committed
293
        else: self.display_name = display_name
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
294
        self.required = required
295
        self.choices = choices
296
297

        # Set parameter type
Jerome Mariette's avatar
Jerome Mariette committed
298
        if type == "date":
Frédéric Escudié's avatar
Frédéric Escudié committed
299
            self.type = date
Jerome Mariette's avatar
Jerome Mariette committed
300
        elif type == "multiple":
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
301
            self.type = "multiple"
Jerome Mariette's avatar
Jerome Mariette committed
302
303
        elif isinstance(type, types.FunctionType):
            self.type = type
304
        elif type in [types.StringType, types.IntType, types.FloatType,  types.BooleanType]:
Jerome Mariette's avatar
Jerome Mariette committed
305
            self.type = type
Jerome Mariette's avatar
Jerome Mariette committed
306
307
308
        else:
            try: self.type = eval(type)
            except: self.type = types.StringType
309
310

        # Set parameter value
Jerome Mariette's avatar
Jerome Mariette committed
311
        self.default = default
312

313
    def export_to_argparse(self):
Jerome Mariette's avatar
Jerome Mariette committed
314
        if self.type == types.BooleanType and str(self.default).lower() in (False, "false",  "f", "0"):
315
316
317
            return {"help": self.help, "required": self.required, "dest": self.name, 
                    "default": False, "action": "store_true"}
        elif self.type == types.BooleanType:
318
            return {"help": self.help, "required": self.required, "dest": self.name, 
319
                    "default": True, "action": "store_false"}
Jerome Mariette's avatar
Jerome Mariette committed
320
        elif self.nargs > 1:
321
            return {"type": self.get_test_function(), "help": self.help, "required": self.required,
Jerome Mariette's avatar
Jerome Mariette committed
322
                    "dest": self.name, "default": self.default,
Jerome Mariette's avatar
Jerome Mariette committed
323
                    "action": self.action, "choices": self.choices, "nargs": "+"}
324
        else:
325
            return {"type": self.get_test_function(), "help": self.help, "required": self.required,
Jerome Mariette's avatar
Jerome Mariette committed
326
                    "dest": self.name, "default": self.default,
327
                    "action": self.action, "choices": self.choices}
328

Jerome Mariette's avatar
Jerome Mariette committed
329
330
    def get_type(self):
        return self.type.__name__
331

332
333
    def get_test_function(self):
        return create_test_function(self.type)
334

Jerome Mariette's avatar
Jerome Mariette committed
335
class AbstractIOFile(object):
336

Jerome Mariette's avatar
Jerome Mariette committed
337
338
    def __init__(self, file_format="any"):
        self.file_format = file_format
Jerome Mariette's avatar
Jerome Mariette committed
339
        self.component_nameid = None
340
        self.parent_component_nameid = []
Jerome Mariette's avatar
Jerome Mariette committed
341
342
343


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

Jerome Mariette's avatar
Jerome Mariette committed
345
346
347
348
349
    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
350
351
352
    def add_sub_parameter(self, param):
        param_flag = param.flag[2:]
        if self.type == "multiple":
Jerome Mariette's avatar
Jerome Mariette committed
353
354
355
            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
356
357
358
359
360
361
362
363
                                           {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
364
            self.default = {}
Jerome Mariette's avatar
Jerome Mariette committed
365
            self.nargs = "+"
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
366
367
368
        elif self.type.__class__ == MultipleParameters:
            self.type.types[param_flag] = param.type
            self.type.choices[param_flag] = param.choices
369
            self.type.default[param_flag] = param.default if param != None else None
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
370
            self.type.actions[param_flag] = param.action
Jerome Mariette's avatar
Jerome Mariette committed
371
372
            if param.required:
                self.type.required.append(param_flag)
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
373
            self.help = self.global_help + self.type.get_help()
Jerome Mariette's avatar
Jerome Mariette committed
374
        param.flag = param_flag
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
375
        self.sub_parameters.append(param)
376

377
378

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

380
    def __init__(self, name, help, required=False, flag=None, group="default", display_name=None):
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
381
382
        AbstractParameter.__init__(self, name, help, required=required, type="multiple", flag=flag, 
                                   action="append", group=group, display_name=display_name)
383
        return list.__init__(self, [])
Jerome Mariette's avatar
Jerome Mariette committed
384

Jerome Mariette's avatar
Jerome Mariette committed
385
386
387
    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
388
            if param.required: req = [param_flag]
Jerome Mariette's avatar
Jerome Mariette committed
389
            else: req = []
Frédéric Escudié's avatar
Frédéric Escudié committed
390
            self.type = MultipleParameters({param_flag: param.type}, req,
Jerome Mariette's avatar
Jerome Mariette committed
391
392
393
394
395
396
397
398
399
400
401
402
403
                                           {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
404
            self.type.default[param_flag] = param.default if param != None else None
Jerome Mariette's avatar
Jerome Mariette committed
405
406
407
408
409
410
411
            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)

412

Frédéric Escudié's avatar
Frédéric Escudié committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
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 )


431
432
433
434
435
436
437
def none_decorator(fn):
    def new_func(*args, **kwargs):
        if args[0].is_None:
            raise Exception("The parameter '" + args[0].name + "' is None.")
        else:
            return fn(*args, **kwargs)
    return new_func
438
439
440
441


class BoolParameter(int, AbstractParameter):

Frédéric Escudié's avatar
Frédéric Escudié committed
442
    def __new__(self, name, help, default=False, type=types.BooleanType, choices=None, required=False,
443
                flag=None, sub_parameters=None, group="default", display_name=None):
444
445
        bool_default = False if default == None else bool(default)
        val = int.__new__(self, bool_default)
446
447
448
449
450
451
        val.is_None = False if default != None else True
        for attr in bool.__dict__:
            func = getattr(bool, attr)
            if callable(func) and attr not in ["__new__", "__init__", "__bool__", "__getattribute__", "__setattribute__",
                                               "__eq__", "__ne__", "__nonzero__", "__str__", "__repr__"]:
                setattr(BoolParameter, attr, none_decorator(func))
452
453
454
455
        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
456
        AbstractParameter.__init__(self, name, help, flag=flag, default=bool(default), type=type, choices=choices, required=required, 
457
                                   action="store", sub_parameters=sub_parameters, group=group, display_name=display_name)
458

Frédéric Escudié's avatar
Frédéric Escudié committed
459
460
    def __str__(self):
        if self.is_None:
461
            return str(None)
Frédéric Escudié's avatar
Frédéric Escudié committed
462
463
        return str(bool(self))

464
465
466
    def __repr__(self):
        return str(self)

467
468
    def __eq__(self, other):
        if other.__class__.__name__ == "NoneType":
469
470
471
472
            return self.is_None
        elif self.is_None:
            return False
        else:
Frédéric Escudié's avatar
Frédéric Escudié committed
473
            return int(self) == int(bool(other))
474

475
    def __ne__(self, other):
Frédéric Escudié's avatar
Frédéric Escudié committed
476
        return not (self == other)
477

478
    def __nonzero__(self):
479
        if self.is_None:
480
            return False
481
482
483
        else:
            return self != 0

484

485
486
487
488
489
490
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)
491
492
493
494
495
496
        val.is_None = False if default != None else True
        for attr in int.__dict__:
            func = getattr(int, attr)
            if callable(func) and attr not in ["__new__", "__init__", "__int__", "__getattribute__", "__setattribute__",
                                               "__eq__", "__ne__", "__nonzero__", "__str__", "__repr__"]:
                setattr(IntParameter, attr, none_decorator(func))
497
498
499
        return val

    def __init__(self, name, help, default=None, type=types.IntType, choices=None, required=False,
500
                 flag=None, sub_parameters=None, group="default", display_name=None):
501
502
        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 )
503

504
505
506
507
508
    def __str__(self):
        if self.is_None:
            return str(None)
        return str(int(self))

509
510
511
    def __repr__(self):
        return str(self)

512
513
514
515
516
517
518
519
520
    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
521
        return not (self == other)
522
523
524
525
526
527
528
529

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


Frédéric Escudié's avatar
Frédéric Escudié committed
530
class FloatParameter(float, AbstractParameter):
531
532
533
534

    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
535
        val = float.__new__(self, float_default)
536
537
538
539
540
541
        val.is_None = False if default != None else True
        for attr in float.__dict__:
            func = getattr(float, attr)
            if callable(func) and attr not in ["__new__", "__init__", "__float__", "__getattribute__", "__setattribute__", 
                                               "__eq__", "__ne__", "__nonzero__", "__str__", "__repr__"]:
                setattr(FloatParameter, attr, none_decorator(func))
542
543
544
545
546
547
548
        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)

549
550
551
552
553
    def __str__(self):
        if self.is_None:
            return str(None)
        return str(float(self))

554
555
556
    def __repr__(self):
        return str(self)

557
558
559
560
561
562
563
564
565
    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
566
        return not (self == other)
567
568
569
570
571
572
573
574
575
576
577
578
579
580

    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)
581
582
583
584
585
586
        val.is_None = False if default != None else True
        for attr in str.__dict__:
            func = getattr(str, attr)
            if callable(func) and attr not in ["__new__", "__init__", "__str__", "__getattribute__", "__setattribute__",
                                               "__eq__", "__ne__", "__nonzero__", "__repr__"]:
                setattr(StrParameter, attr, none_decorator(func))
587
588
589
590
591
592
593
        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)

594
595
596
597
598
    def __str__(self):
        if self.is_None:
            return str(None)
        return str.__str__(self)

599
600
601
602
603
    def __repr__(self):
        if self.is_None:
            return str(None)
        return "'" + str(self) + "'"

604
605
606
607
608
609
610
611
612
    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
613
        return not(self == other)
614
615
616
617
618
619
620
621

    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
622
class DateParameter(datetime.datetime, AbstractParameter):
623

Frédéric Escudié's avatar
Frédéric Escudié committed
624
625
626
627
628
629
630
631
    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)
632
633
634
635
636
637
        val.is_None = False if default != None else True
        for attr in datetime.datetime.__dict__:
            func = getattr(datetime.datetime, attr)
            if callable(func) and attr not in ["__new__", "__init__", "__getattribute__", "__setattribute__",
                                               "__eq__", "__ne__", "__nonzero__", "__str__", "__repr__"]:
                setattr(DateParameter, attr, none_decorator(func))
Frédéric Escudié's avatar
Frédéric Escudié committed
638
639
640
641
642
643
644
645
646
647
        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)

648
649
650
651
652
    def __str__(self):
        if self.is_None:
            return str(None)
        return datetime.datetime.__str__(self)

653
654
655
    def __repr__(self):
        return str(self)

Frédéric Escudié's avatar
Frédéric Escudié committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
    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)

673
674
675
676
677
678
679
680
    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
681
682
683
684
685

class AbstractInputFile(AbstractIOFile):
    """
     @summary : Parent of all InputFile(s) parameters.
    """
686
687
688
689
690
691
692
    
    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
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
    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]
717

Jerome Mariette's avatar
Jerome Mariette committed
718
    def check(self, ifile):
Jerome Mariette's avatar
Jerome Mariette committed
719
720
721
722
        try:
            eval(self.file_format)
            function_exists = True
        except: function_exists = False
723
724
725
726
727
728
729
730
731
        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
732
733
734
735
736
737
738

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

739
740
741

class InputFile(StrParameter, AbstractInputFile):

Jerome Mariette's avatar
Jerome Mariette committed
742
    def __new__(self, name, help, file_format="any", default="", type="localfile", choices=None, 
743
                required=False, flag=None, group="default", display_name=None, size_limit="0"):
Jerome Mariette's avatar
Jerome Mariette committed
744
745
746
        if hasattr(type, '__call__'):
            type2test = type.__name__
        else: type2test = type
747

Jerome Mariette's avatar
Jerome Mariette committed
748
749
750
        if type2test not in INPUTFILE_TYPES:
            raise ValueError("InputFile.__new__: wrong type provided: '"+type2test+"', this should be choosen between '" 
                             + "', '".join(INPUTFILE_TYPES)+"'")
751
752
753
754

        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
755
    def __init__(self, name, help, file_format="any", default="", type="localfile", choices=None, 
756
757
                required=False, flag=None, group="default", display_name=None, size_limit="0"):
        AbstractInputFile.__init__(self, file_format, size_limit)
758
        StrParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, 
759
                           required=required, group=group, display_name=display_name)
Jerome Mariette's avatar
Jerome Mariette committed
760

Jerome Mariette's avatar
Jerome Mariette committed
761
762
763
    def get_type(self):
        return self.type.__name__+AbstractInputFile.SIZE_LIMIT_SPLITER+self.size_limit

764
765
    def get_test_function(self):
        if (self.size_limit == "0"): ctype = self.type
Jerome Mariette's avatar
Jerome Mariette committed
766
        else: ctype = self.get_type()
767
768
        return create_test_function(ctype)

Jerome Mariette's avatar
Jerome Mariette committed
769
    def prepare_input_file(self, input):
770
771
        if input == None:
            return None
Jerome Mariette's avatar
Jerome Mariette committed
772
773
774
775
776
777
778
779
780
        # 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
781
        self.check(new_path)
Jerome Mariette's avatar
Jerome Mariette committed
782
        return new_path
783

Jerome Mariette's avatar
Jerome Mariette committed
784

785
786
class OutputFile(StrParameter, AbstractOutputFile):

Frédéric Escudié's avatar
Frédéric Escudié committed
787
    def __new__(self, name, help, file_format="any", default="", choices=None,
788
                required=False, flag=None, group="default", display_name=None):
Frédéric Escudié's avatar
Frédéric Escudié committed
789
        return StrParameter.__new__(self, name, help, flag=flag, default=default, type="localfile", choices=choices,
790
791
                           required=required, group=group, display_name=display_name)

Frédéric Escudié's avatar
Frédéric Escudié committed
792
    def __init__(self, name, help, file_format="any", default="", choices=None,
793
                required=False, flag=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
794
        AbstractIOFile.__init__(self, file_format)
795
        StrParameter.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
796
797
                           required=required, group=group, display_name=display_name)

798

799
class ParameterList(list, AbstractParameter):
800

Jerome Mariette's avatar
Jerome Mariette committed
801
    def __init__(self, name, help, default=None, type=types.StringType, choices=None, required=False,
802
                 flag=None, sub_parameters=None, group="default", display_name=None):
Jerome Mariette's avatar
Jerome Mariette committed
803
        if default == None: default = []
Frédéric Escudié's avatar
Frédéric Escudié committed
804
        AbstractParameter.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, required=required,
805
806
807
808
809
                                   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)
810

811

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

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

Jerome Mariette's avatar
Jerome Mariette committed
817
        if default == None: default = []   
Jerome Mariette's avatar
Jerome Mariette committed
818
819
820
        if hasattr(type, '__call__'):
            type2test = type.__name__
        else: type2test = type
821

Jerome Mariette's avatar
Jerome Mariette committed
822
823
824
        if type2test not in INPUTFILE_TYPES:
            raise ValueError("InputFile.__new__: wrong type provided: '"+type2test+"', this should be choosen between '" 
                             + "', '".join(INPUTFILE_TYPES)+"'")
825

826
        AbstractInputFile.__init__(self, file_format, size_limit)
Jerome Mariette's avatar
Jerome Mariette committed
827
        ParameterList.__init__(self, name, help, flag=flag, default=default, type=type, choices=choices, 
828
                               required=required, group=group, display_name=display_name)
829

830
831
832
833
        if default.__class__.__name__ == "str":
            return list.__init__(self, [default])
        elif default.__class__.__name__ == "list":
            return list.__init__(self, default)
834
835
        elif issubclass( default.__class__, InputFile ):
            return list.__init__(self, [default])
Frédéric Escudié's avatar
Frédéric Escudié committed
836
        elif issubclass( default.__class__, AbstractInputFile ):
Jerome Mariette's avatar
Jerome Mariette committed
837
            return list.__init__(self, default)
838
839
        elif issubclass( default.__class__, OutputFile ):
            return list.__init__(self, [default])
Frédéric Escudié's avatar
Frédéric Escudié committed
840
        elif issubclass( default.__class__, AbstractOutputFile ):
Jerome Mariette's avatar
Jerome Mariette committed
841
            return list.__init__(self, default)
Jerome Mariette's avatar
Jerome Mariette committed
842
843
844
845
    
    def get_type(self):
        return self.type.__name__+AbstractInputFile.SIZE_LIMIT_SPLITER+self.size_limit
    
846
847
    def get_test_function(self):
        if (self.size_limit == "0"): ctype = self.type
Jerome Mariette's avatar
Jerome Mariette committed
848
        else: ctype = self.get_type()
849
850
        return create_test_function(ctype)

Jerome Mariette's avatar
Jerome Mariette committed
851
    def prepare_input_files(self, inputs):
Jerome Mariette's avatar
Jerome Mariette committed
852
        path2test = _copy.deepcopy(inputs)
Jerome Mariette's avatar
Jerome Mariette committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
        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
875
876
877
        # 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
878
        return new_vals
879

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

Jerome Mariette's avatar
Jerome Mariette committed
882
883
884
    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
885
        AbstractIOFile.__init__(self, file_format)
Jerome Mariette's avatar
Jerome Mariette committed
886
        ParameterList.__init__(self, name, help, flag=flag, default=default, type="localfile", choices=choices, 
887
888
889
890
891
                               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
892

893

Frédéric Escudié's avatar
Frédéric Escudié committed
894
895
896
897
898
899
900
901
902
903
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

904

Frédéric Escudié's avatar
Frédéric Escudié committed
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
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)

934

Frédéric Escudié's avatar
Frédéric Escudié committed
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
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)