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

import inspect
import os
20
import re
Jerome Mariette's avatar
Jerome Mariette committed
21
22
23
24
25
26
27
import sys
import uuid
import pkgutil
import tempfile
import pickle
import time
import threading
Jerome Mariette's avatar
Jerome Mariette committed
28
import types
Jerome Mariette's avatar
Jerome Mariette committed
29
import datetime
30
31
import logging
import traceback
Jerome Mariette's avatar
Jerome Mariette committed
32

33
from configparser import ConfigParser, NoOptionError
Jerome Mariette's avatar
Jerome Mariette committed
34
from inspect import getcallargs
35
from datetime import date as ddate
Jerome Mariette's avatar
Jerome Mariette committed
36

37
38
from collections import OrderedDict

Jerome Mariette's avatar
Jerome Mariette committed
39
import jflow
Jerome Mariette's avatar
Jerome Mariette committed
40
import jflow.utils as utils
41
from jflow.utils import validate_email
42
from pygraph.classes.digraph import digraph
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
43
44
from jflow.workflows_manager import WorkflowsManager 
from jflow.config_reader import JFlowConfigReader
45
from jflow.utils import get_octet_string_representation, get_nb_octet
46
from jflow.parameter import *
47
from cctools.util import time_format
Jerome Mariette's avatar
Jerome Mariette committed
48
49
50
51
52
53
54
55
56
57
58
59

from weaver.script import ABSTRACTIONS
from weaver.script import DATASETS
from weaver.script import FUNCTIONS
from weaver.script import NESTS
from weaver.script import OPTIONS
from weaver.script import STACKS
from weaver.nest import Nest
from weaver.options import Options
from cctools.makeflow import MakeflowLog
from cctools.makeflow.log import Node

Jerome Mariette's avatar
Jerome Mariette committed
60

61
62
63
64
65
66
67
class MINIWorkflow(object):
    
    def __init__(self, id, name, description, status, start_time, end_time, metadata, 
                 component_nameids, compts_status, errors):
        self.id = id
        self.name = name
        self.description = description
68
        self._status = status
69
70
71
72
73
74
75
76
77
78
        self.start_time = start_time
        self.end_time = end_time
        self.metadata = metadata
        self.component_nameids = component_nameids
        self.compts_status = compts_status
        self.errors = errors
        
    def get_components_nameid(self):
        return self.component_nameids

79
80
81
    def get_components_status(self):
        return self.compts_status
    
82
83
84
85
86
87
88
    def get_component_status(self, component_nameid):
        return self.compts_status[component_nameid]
    
    def get_errors(self):
        return self.errors
    
    def get_status(self):
89
        return self._status
90

91
92
class Workflow(threading.Thread):
    
Jerome Mariette's avatar
Jerome Mariette committed
93
    MAKEFLOW_LOG_FILE_NAME = "Makeflow.makeflowlog"
94
    DUMP_FILE_NAME = ".workflow.dump"
95
    STDERR_FILE_NAME = "wf_stderr.txt"
Jerome Mariette's avatar
Jerome Mariette committed
96
    WORKING = ".working"
97
    OLD_EXTENSION = ".old"
98
    DEFAULT_GROUP = "default"
99
    
100
    STATUS_PENDING = "pending"
Jerome Mariette's avatar
Jerome Mariette committed
101
102
103
104
    STATUS_STARTED = "started"
    STATUS_COMPLETED = "completed"
    STATUS_FAILED = "failed"
    STATUS_ABORTED = "aborted"
Jerome Mariette's avatar
Jerome Mariette committed
105
    STATUS_RESETED = "reseted"
106
    
Jerome Mariette's avatar
Jerome Mariette committed
107
108
109
    INPUTFILE_GRAPH_LABEL = "inputfile"
    INPUTFILES_GRAPH_LABEL = "inputfiles"
    INPUTDIRECTORY_GRAPH_LABEL = "inputdirectory"
110
111
    COMPONENT_GRAPH_LABEL = "component"
    
112
    
113
    def __init__(self, args={}, id=None, function= "process"):
Jerome Mariette's avatar
Jerome Mariette committed
114
115
116
117
        # define as a thread
        threading.Thread.__init__(self)
        self.jflow_config_reader = JFlowConfigReader()
        self.manager = WorkflowsManager()
118
        self.components_to_exec = []
119
        self.components = []
Jerome Mariette's avatar
Jerome Mariette committed
120
121
122
        self.makes = {}
        self.globals = {}
        self.options = Options()
123
124
        self._status = self.STATUS_STARTED
        self._postprocess_status = self.STATUS_PENDING
Jerome Mariette's avatar
Jerome Mariette committed
125
126
        self.start_time = None
        self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
127
        self.__step = None
Frédéric Escudié's avatar
Frédéric Escudié committed
128
        self.stderr = None
Jerome Mariette's avatar
Jerome Mariette committed
129
        self.args = args
130
        self.dynamic_component_present = False
131
132
133
        self.__to_address = None
        self.__subject = None
        self.__message = None
134
        self.function = function
135
        # intruduce --log-verbose to be able to monitor the new version of makeflow >=4.2.2
Jerome Mariette's avatar
Jerome Mariette committed
136
        self.engine_arguments = ' --log-verbose '
137
        self.component_nameids_is_init = False
Jerome Mariette's avatar
Jerome Mariette committed
138
        self.component_nameids = {}
139
        self.reseted_components = []
Jerome Mariette's avatar
Jerome Mariette committed
140
141
        # try to parse engine arguments
        try:
142
143
            type, options, limit_submission = self.jflow_config_reader.get_batch()
            if limit_submission : self.engine_arguments += ' -J ' + str(limit_submission)
Jerome Mariette's avatar
Jerome Mariette committed
144
145
146
            if type: self.engine_arguments += ' -T ' + type
            if options : self.engine_arguments += ' -B "' + options + '"'
        except: self.engine_arguments = None
147

Jerome Mariette's avatar
Jerome Mariette committed
148
        self.id = id
149
150
        self.name = self.get_name()
        self.description = self.get_description()
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
151
        self.__group = self.jflow_config_reader.get_workflow_group(self.__class__.__name__) or Workflow.DEFAULT_GROUP
152
153
154
        
        # define the parameters 
        self.params_order = []
Jerome Mariette's avatar
Jerome Mariette committed
155
156
        if self.function != None:
            self.define_parameters(self.function)
157
        # add the metadata parameter
158
        self.metadata = []
Jerome Mariette's avatar
Jerome Mariette committed
159
        
Jerome Mariette's avatar
Jerome Mariette committed
160
161
162
        if self.id is not None:
            self.directory = self.manager.get_workflow_directory(self.name, self.id)
            if not os.path.isdir(self.directory):
163
                os.makedirs(self.directory, 0o751)
Frédéric Escudié's avatar
Frédéric Escudié committed
164
            if self.stderr is None:
165
                self.stderr = self._set_stderr()
Jerome Mariette's avatar
Jerome Mariette committed
166
            self._serialize()
Jerome Mariette's avatar
Jerome Mariette committed
167
            
168
169
        self.internal_components = self._import_internal_components()
        self.external_components = self._import_external_components()
170

171
172
    def get_workflow_group(self):
        return self.__group
173
            
Jerome Mariette's avatar
Jerome Mariette committed
174
    def add_input_directory(self, name, help, default=None, required=False, flag=None, 
175
176
177
                            group="default", display_name=None, get_files_fn=None, add_to=None):
        new_param = InputDirectory(name, help, flag=flag, default=default, required=required, 
                                   group=group, display_name=display_name, get_files_fn=get_files_fn)
Jerome Mariette's avatar
Jerome Mariette committed
178
179
180
181
182
183
184
185
186
187
188
        new_param.linkTrace_nameid = name
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
189
    def add_input_file(self, name, help, file_format="any", default=None, type="inputfile", 
190
191
192
193
                       required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
194
        new_param = InputFile(name, help, flag=flag, file_format=file_format, default=default, 
195
                              type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
Frédéric Escudié's avatar
Frédéric Escudié committed
196
        new_param.linkTrace_nameid = name
197
198
199
200
201
202
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
203
        else:
204
205
206
207
            self.params_order.append(name)
            self.__setattr__(name, new_param)
            
    def add_input_file_list(self, name, help, file_format="any", default=None, type="inputfile", 
208
209
                            required=False, flag=None, group="default", display_name=None, size_limit="0", add_to=None):
        # check if the size provided is correct
210
        if default == None: default = []
211
212
        try: int(get_nb_octet(size_limit))
        except: size_limit="0"
213
214
215
216
217
218
219
        if default == None:
            inputs = []
        elif issubclass(default.__class__, list):
            inputs = [IOFile(file, file_format, name, None) for file in default]
        else:
            inputs = [IOFile(default, file_format, name, None)]
        new_param = InputFileList(name, help, flag=flag, file_format=file_format, default=inputs, 
220
                                  type=type, required=required, group=group, display_name=display_name, size_limit=size_limit)
Frédéric Escudié's avatar
Frédéric Escudié committed
221
        new_param.linkTrace_nameid = name
222
223
224
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
225
                self.__getattribute__(add_to).add_sub_parameter(new_param)
226
227
228
229
230
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
231
232
            
    def add_multiple_parameter(self, name, help, required=False, flag=None, group="default", display_name=None):
233
        self.params_order.append(name)
234
235
236
237
238
239
        new_param = MultiParameter(name, help, flag=flag, required=required, group=group, display_name=display_name)
        self.__setattr__(name, new_param)

    def add_multiple_parameter_list(self, name, help, required=False, flag=None, group="default", display_name=None):
        self.params_order.append(name)
        new_param = MultiParameterList(name, help, flag=flag, required=required, group=group, display_name=display_name)
240
241
        self.__setattr__(name, new_param)
    
242
    def add_parameter(self, name, help, default=None, type=str, choices=None, 
243
                      required=False, flag=None, group="default", display_name=None, add_to=None):
244
        new_param = ParameterFactory.factory(name, help, flag=flag, default=default, type=type, choices=choices, 
245
246
247
248
249
250
251
                              required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
                self.__getattribute__(add_to).add_sub_parameter(new_param)
            except: pass
        # otherwise, add it to the class itself
252
        else:
253
254
255
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
256
    def add_parameter_list(self, name, help, default=None, type=str, choices=None, 
257
258
259
                           required=False, flag=None, group="default", display_name=None, add_to=None):
        if default == None: default = []
        new_param = ParameterList(name, help, flag=flag, default=default, type=type, choices=choices, 
260
261
262
263
                                  required=required, group=group, display_name=display_name)
        # if this input should be added to a particular parameter
        if add_to:
            try:
Jerome Mariette's avatar
help ok    
Jerome Mariette committed
264
                self.__getattribute__(add_to).add_sub_parameter(new_param)
265
266
267
268
269
270
            except: pass
        # otherwise, add it to the class itself
        else:
            self.params_order.append(name)
            self.__setattr__(name, new_param)
    
Jerome Mariette's avatar
Jerome Mariette committed
271
    def add_exclusion_rule(self, *args2exclude):
Jerome Mariette's avatar
Jerome Mariette committed
272
        # first of all, does this parameter exist
Jerome Mariette's avatar
Jerome Mariette committed
273
274
275
276
277
278
279
280
281
282
283
284
        params2exclude = []
        for arg2exclude in args2exclude:
            try:
                params2exclude.append(self.__getattribute__(arg2exclude))
            except: pass
        # everything is ok, let's go
        if len(params2exclude) == len(args2exclude):
            new_group = "exclude-"+uuid.uuid4().hex[:5]
            for paramsexclude in params2exclude:
                paramsexclude.group = new_group
        # it might be a mutliple param rule
        else:
285
            self._log("Exclusion rule cannot be applied within a MultiParameter or a MultiParameterList", raisee=True)
Jerome Mariette's avatar
Jerome Mariette committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
        # save this for MultiParameter internal exclusion rules, works on command line, not supported on gui
#             for attribute_value in self.__dict__.values():
#                 if issubclass(attribute_value.__class__, MultiParameter) or issubclass(attribute_value.__class__, MultiParameterList):
#                     params2exclude = []
#                     for sub_param in attribute_value.sub_parameters:
#                         if sub_param.name in args2exclude:
#                             params2exclude.append(sub_param)
#                     if len(params2exclude) == len(args2exclude):
#                         new_group = "exclude-"+uuid.uuid4().hex[:5]
#                         flags2exclude = []
#                         for paramsexclude in params2exclude:
#                             paramsexclude.group = new_group
#                             flags2exclude.append(paramsexclude.flag)
#                         attribute_value.type.excludes[new_group] = flags2exclude
#                         break
301

Frédéric Escudié's avatar
Frédéric Escudié committed
302
    def _prepare_parameter(self, args, parameter, key="name"):
303
304
        new_param = None
        # Retrieve value
305
        if parameter.__getattribute__(key) in args:
Frédéric Escudié's avatar
Frédéric Escudié committed
306
            value = args[parameter.__getattribute__(key)]
Jerome Mariette's avatar
Jerome Mariette committed
307
        elif parameter.default != None:
308
309
310
311
            value = parameter.default
        else:
            value = None
        # Set new parameter
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
312
        if parameter.__class__ in [StrParameter, IntParameter, FloatParameter, BoolParameter, DateParameter, PasswordParameter]:
Frédéric Escudié's avatar
Frédéric Escudié committed
313
            if value == "" and parameter.__class__ in [IntParameter, FloatParameter, BoolParameter, DateParameter] : value = None # from GUI
314
315
316
317
            new_param = ParameterFactory.factory( parameter.name, parameter.help, default=value, type=parameter.type, choices=parameter.choices, 
                                                  required=parameter.required, flag=parameter.flag, group=parameter.group, 
                                                  display_name=parameter.display_name )
        elif parameter.__class__ ==  ParameterList:
318
            if value == "" : value = [] # from GUI
319
320
321
322
            new_param = ParameterList( parameter.name, parameter.help, default=value, type=parameter.type, choices=parameter.choices,
                                       required=parameter.required, flag=parameter.flag, sub_parameters=parameter.sub_parameters,
                                       group=parameter.group, display_name=parameter.display_name )
        elif parameter.__class__ == InputFileList:
323
            if value == "" : value = [] # from GUI
324
            iovalues = []
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
325
            prepared_files = parameter.prepare(value)
326
            for file in prepared_files:
327
328
                iovalues.append(IOFile(file, parameter.file_format, parameter.linkTrace_nameid, None))
            new_param = InputFileList( parameter.name, parameter.help, file_format=parameter.file_format, default=iovalues,
329
330
                                       type=parameter.type, choices=parameter.choices, required=parameter.required, flag=parameter.flag,
                                       group=parameter.group, display_name=parameter.display_name, size_limit=parameter.size_limit )
331
            new_param.linkTrace_nameid = parameter.linkTrace_nameid            
332
        elif parameter.__class__ == InputFile:
333
            if value == "" : value = None # from GUI
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
334
            prepared_file = parameter.prepare(value)
335
            new_param = InputFile( parameter.name, parameter.help, file_format=parameter.file_format, default=prepared_file,
336
337
                                   type=parameter.type, choices=parameter.choices, required=parameter.required, flag=parameter.flag, 
                                   group=parameter.group, display_name=parameter.display_name )
338
            new_param.linkTrace_nameid = parameter.linkTrace_nameid
Jerome Mariette's avatar
Jerome Mariette committed
339
340
        elif parameter.__class__ == InputDirectory:
            if value == "" : value = None # from GUI
Ibouniyamine Nabihoudine's avatar
Ibouniyamine Nabihoudine committed
341
            prepared_directory = parameter.prepare(value)
342
            new_param = InputDirectory( parameter.name, parameter.help, default=prepared_directory, choices=parameter.choices, 
Jerome Mariette's avatar
Jerome Mariette committed
343
                                        required=parameter.required, flag=parameter.flag, group=parameter.group, 
344
                                        display_name=parameter.display_name, get_files_fn=parameter.get_files_fn)
Jerome Mariette's avatar
Jerome Mariette committed
345
            new_param.linkTrace_nameid = parameter.linkTrace_nameid
346
347
348
349
        else:
            raise Exception( "Unknown class '" +  parameter.__class__.__name__ + "' for parameter.")
        return new_param

350
351
352
    def _set_parameters(self, args):
        parameters = self.get_parameters()
        for param in parameters:
353
            new_param = None
354
            if param.__class__ == MultiParameter:
355
                new_param = MultiParameter(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
356
                new_param.sub_parameters = param.sub_parameters
357
                if param.name in args:
358
359
360
361
362
363
                    sub_args = {}
                    for sarg in args[param.name]:
                        sub_args[sarg[0]] = sarg[1]
                    for sub_param in param.sub_parameters:
                        new_sub_parameter = self._prepare_parameter(sub_args, sub_param, "flag")
                        new_param[new_sub_parameter.name] = new_sub_parameter
364
            elif param.__class__ == MultiParameterList:
365
                new_param = MultiParameterList(param.name, param.help, required=param.required, flag=param.flag, group=param.group, display_name=param.display_name)
366
                new_param.sub_parameters = param.sub_parameters
367
                if param.name in args:
368
369
370
371
372
373
374
375
376
                    for idx, sargs in enumerate(args[param.name]):
                        new_multi_param = MultiParameter(param.name + '_' + str(idx), '', required=False, flag=None, group="default", display_name=None)
                        sub_args = {}
                        for sarg in sargs:
                            sub_args[sarg[0]] = sarg[1]
                        for sub_param in param.sub_parameters:
                            new_sub_param = self._prepare_parameter(sub_args, sub_param, "flag")
                            new_multi_param[new_sub_param.name] = new_sub_param
                        new_param.append(new_multi_param)
377
            else:
378
                new_param = self._prepare_parameter(args, param)
379
            self.__setattr__(param.name, new_param)
Frédéric Escudié's avatar
Frédéric Escudié committed
380

Jerome Mariette's avatar
Jerome Mariette committed
381
    def get_execution_graph(self):
382
        gr = digraph()
383
384
        # build a all_nodes table to store all nodes
        all_nodes = {}
385
        for ioparameter in list(self.__dict__.values()):
386
387
            if issubclass(ioparameter.__class__, InputFile):
                gr.add_node(ioparameter.name)
Jerome Mariette's avatar
Jerome Mariette committed
388
                gr.add_node_attribute(ioparameter.name, self.INPUTFILE_GRAPH_LABEL)
389
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
390
                all_nodes[ioparameter.name] = None
391
392
            elif issubclass(ioparameter.__class__, InputFileList):
                gr.add_node(ioparameter.name)
Jerome Mariette's avatar
Jerome Mariette committed
393
394
395
396
397
398
                gr.add_node_attribute(ioparameter.name, self.INPUTFILES_GRAPH_LABEL)
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
                all_nodes[ioparameter.name] = None
            elif issubclass(ioparameter.__class__, InputDirectory):
                gr.add_node(ioparameter.name)
                gr.add_node_attribute(ioparameter.name, self.INPUTDIRECTORY_GRAPH_LABEL)
399
                gr.add_node_attribute(ioparameter.name, ioparameter.display_name)
400
                all_nodes[ioparameter.name] = None
Philippe Bardou's avatar
Philippe Bardou committed
401
            elif issubclass(ioparameter.__class__, MultiParameter):
Jerome Mariette's avatar
Jerome Mariette committed
402
403
404
405
406
407
408
409
410
411
                for subparam in ioparameter.sub_parameters:
                    gr.add_node(subparam.name)
                    all_nodes[subparam.name] = None
                    if issubclass(subparam.__class__, InputFile):
                        gr.add_node_attribute(subparam.name, self.INPUTFILE_GRAPH_LABEL)
                    elif issubclass(subparam.__class__, InputFileList):
                        gr.add_node_attribute(subparam.name, self.INPUTFILES_GRAPH_LABEL)
                    elif issubclass(subparam.__class__, InputDirectory):
                        gr.add_node_attribute(subparam.name, self.INPUTDIRECTORY_GRAPH_LABEL)
                    gr.add_node_attribute(subparam.name, subparam.display_name)
Philippe Bardou's avatar
Philippe Bardou committed
412
413
414
415
416
417
418
419
420
            elif issubclass(ioparameter.__class__, MultiParameterList):
                for subparam in ioparameter.sub_parameters:
                    gr.add_node(subparam.name)
                    all_nodes[subparam.name] = None                        
                    if issubclass(subparam.__class__, InputDirectory):
                        gr.add_node_attribute(subparam.name, self.INPUTDIRECTORY_GRAPH_LABEL)
                    else:
                        gr.add_node_attribute(subparam.name, self.INPUTFILES_GRAPH_LABEL)
                    gr.add_node_attribute(subparam.name, subparam.display_name)
421
        for cpt in self.components:
422
423
            gr.add_node(cpt.get_nameid())
            gr.add_node_attribute(cpt.get_nameid(), self.COMPONENT_GRAPH_LABEL)
424
            gr.add_node_attribute(cpt.get_nameid(), cpt.get_nameid())
425
            all_nodes[cpt.get_nameid()] = None
Jerome Mariette's avatar
Jerome Mariette committed
426
        for cpt in self.components:
427
            for ioparameter in list(cpt.__dict__.values()):
Jerome Mariette's avatar
Jerome Mariette committed
428
                if issubclass( ioparameter.__class__, InputFile ) or issubclass( ioparameter.__class__, InputFileList) or issubclass( ioparameter.__class__, InputDirectory):
Frédéric Escudié's avatar
Frédéric Escudié committed
429
430
                    for parent in ioparameter.parent_linkTrace_nameid:
                        try: gr.add_edge((parent, ioparameter.linkTrace_nameid))
Frédéric Escudié's avatar
Frédéric Escudié committed
431
                        except: pass
432
433
434
435
                elif issubclass( ioparameter.__class__, InputObject) or issubclass( ioparameter.__class__, InputObjectList):
                    for parent in ioparameter.parent_linkTrace_nameid:
                        try: gr.add_edge((parent, ioparameter.linkTrace_nameid))
                        except: pass
436
437
        # check if all nodes are connected
        for edge in gr.edges():
438
            if edge[0] in all_nodes:
439
                del all_nodes[edge[0]]
440
            if edge[1] in all_nodes:
441
442
                del all_nodes[edge[1]]
        # then remove all unconnected nodes: to delete inputs not defined by the user
443
        for orphan_node in list(all_nodes.keys()):
444
            gr.del_node(orphan_node)
445
        return gr
Frédéric Escudié's avatar
Frédéric Escudié committed
446

Jerome Mariette's avatar
Jerome Mariette committed
447
448
    def delete(self):
        if self.get_status() in [self.STATUS_COMPLETED, self.STATUS_FAILED, self.STATUS_ABORTED]:
Jerome Mariette's avatar
Jerome Mariette committed
449
            utils.robust_rmtree(self.directory)
Jerome Mariette's avatar
Jerome Mariette committed
450

451
    @staticmethod
452
    def config_parser(arg_lines):
453
454
        for arg in arg_lines:
            yield arg
455
456
457
458
            
    @staticmethod
    def get_status_under_text_format(workflow, detailed=False, display_errors=False, html=False):
        if workflow.start_time: start_time = time.asctime(time.localtime(workflow.start_time))
459
        else: start_time = "-"
460
461
        if workflow.start_time and workflow.end_time: elapsed_time = str(workflow.end_time-workflow.start_time)
        elif workflow.start_time: elapsed_time = str(time.time()-workflow.start_time)
462
        else: elapsed_time = "-"
Jerome Mariette's avatar
Jerome Mariette committed
463
        elapsed_time = "-" if elapsed_time == "-" else str(datetime.timedelta(seconds=int(str(elapsed_time).split(".")[0])))
464
        if workflow.end_time: end_time = time.asctime(time.localtime(workflow.end_time))
465
466
467
        else: end_time = "-"
        if detailed:
            # Global
468
469
            title = "Workflow #" + utils.get_nb_string(workflow.id) + " (" + workflow.name + ") is " + \
                    workflow.get_status() + ", time elapsed: " + str(elapsed_time) + " (from " + start_time + \
470
471
                    " to " + end_time + ")"
            worflow_errors = ""
472
            error = workflow.get_errors()
473
            if error is not None:
Jerome Mariette's avatar
Jerome Mariette committed
474
475
                if html: worflow_errors = "Workflow Error :\n  <span style='color:#ff0000'>" + error["location"] + "\n    " + "\n    ".join(error["msg"]) + "</span>"
                else: worflow_errors = "Workflow Error :\n  \033[91m" + error["location"] + "\n    " + "\n    ".join(error["msg"]) + "\033[0m"
476
477
478
            # By components
            components_errors = ""
            status = "Components Status :\n"
479
            components_status = workflow.get_components_status()
480
            for i, component in enumerate(workflow.get_components_nameid()):
481
                status_info = components_status[component]
482
483
484
485
486
487
488
489
490
491
492
                try: perc_waiting = (status_info["waiting"]*100.0)/status_info["tasks"]
                except: perc_waiting = 0
                try: perc_running = (status_info["running"]*100.0)/status_info["tasks"]
                except: perc_running = 0
                try: perc_failed = (status_info["failed"]*100.0)/status_info["tasks"]
                except: perc_failed = 0
                try: perc_aborted = (status_info["aborted"]*100.0)/status_info["tasks"]
                except: perc_aborted = 0
                try: perc_completed = (status_info["completed"]*100.0)/status_info["tasks"]
                except: perc_completed = 0
                
Jerome Mariette's avatar
Jerome Mariette committed
493
494
495
                if status_info["running"] > 0: 
                    if html: running = "<span style='color:#3b3bff'>running:" + str(status_info["running"]) + "</span>"
                    else: running = "\033[94mrunning:" + str(status_info["running"]) + "\033[0m"
496
                else: running = "running:" + str(status_info["running"])
Jerome Mariette's avatar
Jerome Mariette committed
497
498
499
                if status_info["waiting"] > 0: 
                    if html: waiting = "<span style='color:#ffea00'>waiting:" + str(status_info["waiting"]) + "</span>"
                    else: waiting = "\033[93mwaiting:" + str(status_info["waiting"]) + "\033[0m"
500
                else: waiting = "waiting:" + str(status_info["waiting"])            
Jerome Mariette's avatar
Jerome Mariette committed
501
502
503
                if status_info["failed"] > 0: 
                    if html: failed = "<span style='color:#ff0000'>failed:" + str(status_info["failed"]) + "</span>"
                    else: failed = "\033[91mfailed:" + str(status_info["failed"]) + "\033[0m"
504
                else: failed = "failed:" + str(status_info["failed"])
Jerome Mariette's avatar
Jerome Mariette committed
505
506
507
                if status_info["aborted"] > 0: 
                    if html: aborted = "<span style='color:#ff01ba'>aborted:" + str(status_info["aborted"]) + "</span>"
                    else: aborted = "\033[95maborted:" + str(status_info["aborted"]) + "\033[0m"
508
                else: aborted = "aborted:" + str(status_info["aborted"])
Jerome Mariette's avatar
Jerome Mariette committed
509
510
511
                if status_info["completed"] == status_info["tasks"] and status_info["completed"] > 0: 
                    if html: completed = "<span style='color:#14ac00'>completed:" + str(status_info["completed"]) + "</span>"
                    else: completed = "\033[92mcompleted:" + str(status_info["completed"]) + "\033[0m"
512
513
514
                else: completed = "completed:" + str(status_info["completed"])
                
                if display_errors and len(status_info["failed_commands"]) > 0:
515
516
                    if components_errors == "":
                        components_errors = "Failed Commands :\n"
517
                    components_errors += "  - " + component + " :\n    " + "\n    ".join(status_info["failed_commands"]) + "\n"
518
519
520
                status += "  - " + component + ", time elapsed " + time_format(status_info["time"]) + \
                    " (total:" + str(status_info["tasks"]) + ", " + waiting + ", " + running + ", " + failed + \
                    ", " + aborted + ", " + completed + ")"
521
                if i<len(workflow.get_components_nameid())-1: status += "\n"
522
523
524
            # Format str
            pretty_str = title
            pretty_str += ("\n" + worflow_errors) if worflow_errors != "" else ""
525
526
            if len(workflow.get_components_nameid()) > 0:
                pretty_str += ("\n" + status) if status != "" else ""
527
                pretty_str += ("\n" + components_errors[:-1]) if components_errors != "" else ""
Jerome Mariette's avatar
Jerome Mariette committed
528
529
            if html: return pretty_str.replace("\n", "<br />")
            else: return pretty_str
530
        else:
531
532
            pretty_str = utils.get_nb_string(workflow.id) + "\t" + workflow.name + "\t"
            if workflow.get_status() == Workflow.STATUS_STARTED:
Jerome Mariette's avatar
Jerome Mariette committed
533
                pretty_str += "\033[94m"
534
            elif workflow.get_status() == Workflow.STATUS_COMPLETED:
Jerome Mariette's avatar
Jerome Mariette committed
535
                pretty_str += "\033[92m"
536
            elif workflow.get_status() == Workflow.STATUS_FAILED:
Jerome Mariette's avatar
Jerome Mariette committed
537
                pretty_str += "\033[91m"
538
            elif workflow.get_status() == Workflow.STATUS_ABORTED:
Jerome Mariette's avatar
Jerome Mariette committed
539
                pretty_str += "\033[91m"
540
            elif workflow.get_status() == Workflow.STATUS_RESETED:
Jerome Mariette's avatar
Jerome Mariette committed
541
                pretty_str += "\033[3m"
542
            pretty_str += workflow.get_status() + "\033[0m"
Jerome Mariette's avatar
Jerome Mariette committed
543
544
            pretty_str += "\t" + elapsed_time + "\t" + start_time + "\t" + end_time
            return pretty_str
545
    
546
    def get_errors(self):
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
        if os.path.isfile(self.stderr):
            error = {
                "title"     : "",
                "msg"       : list(),
                "traceback" : list()
            }
            line_idx = 0
            FH_stderr = open( self.stderr )
            lines = FH_stderr.readlines()
            while line_idx < len(lines):
                if lines[line_idx].strip().startswith("##"):
                    error["title"]     = lines[line_idx].rstrip()
                    error["msg"]       = list()
                    error["traceback"] = list()
                    # skip all lines before the traceback
                    while not lines[line_idx].startswith("Traceback"):
                        line_idx += 1
                    # skip : "Traceback (most recent call last):"
                    line_idx += 1    
                    while lines[line_idx] != lines[line_idx].lstrip():
                        error["traceback"].append({ 
                                                   "location" : lines[line_idx].strip(),
                                                   "line"     : lines[line_idx].strip()
                        })
                        line_idx += 2
                    # Error message
                    while line_idx < len(lines) and not lines[line_idx].strip().startswith("##"):
                        try:
                            error["msg"].append( lines[line_idx].strip().split(":", 1)[1][1:] )
                        except:
                            error["msg"].append( lines[line_idx].strip() )
                        line_idx += 1
                    line_idx -= 1
                line_idx += 1
            FH_stderr.close()
            last_stack_location = ""
            if len(error["traceback"]) > 0:
                last_stack_location = error["traceback"][-1]["location"].strip()
                return { "msg" : error["msg"], "location" : last_stack_location }
            else:
                return None
Frédéric Escudié's avatar
Frédéric Escudié committed
588
589
        else:
            return None
590
591
592
593
594
595
596

    def get_description_per_components(self):
        dag = self.get_execution_graph()
        descriptions = {}
        for current_components in self.components:
            descriptions[current_components.get_nameid()] = current_components.get_description()
        return descriptions
597
                
598
    def get_outputs_per_components(self):
599
        outputs_files = OrderedDict()
600
        for current_components in self.components:
Philippe Bardou's avatar
Philippe Bardou committed
601
            #status = self.get_component_status(current_components.get_nameid())
602
            outputs_files[current_components.get_nameid()] = current_components.get_output_files()
Philippe Bardou's avatar
Philippe Bardou committed
603
            #outputs_files["0"] = status["completed"]
604
605
        return outputs_files
    
Jerome Mariette's avatar
Jerome Mariette committed
606
607
    def __setstate__(self, state):
        self.__dict__ = state.copy()
608
        self.external_components = self._import_external_components()
Jerome Mariette's avatar
Jerome Mariette committed
609
610
611
612
613
614
615
        threading.Thread.__init__(self, name=self.name)
        
    def __getstate__(self):
        """
        Threading uses Lock Object, do not consider these objects when serializing a workflow
        """
        odict = self.__dict__.copy()
616
        del odict['_started']
617
618
619
620
        if '_tstate_lock' in odict: # python 3.4
            del odict['_tstate_lock']
        else: # python 3.2
            del odict['_block']
621
622
        del odict['_stderr']
        if 'external_components' in odict:
623
            del odict['external_components']
Jerome Mariette's avatar
Jerome Mariette committed
624
625
        return odict
    
626
627
628
629
630
631
632
633
    def set_to_address(self, to_address):
        self.__to_address = to_address

    def set_subject(self, subject):
        self.__subject = subject

    def set_message(self, message):
        self.__message = message
634
635
636
637

    def _get_cleaned_email_placeholders(self, text):
        """
        @summary: Returns the text after replacement of placeholders by the corresponding workflow values (method or attribute).
Frédéric Escudié's avatar
Frédéric Escudié committed
638
                  Placeholders must be an attribute or a method of the workflow between three sharps: ###attribute### or ###method()###.
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
                  You can add "|date" after the attribute or the method to convert a timestamp in human readable date.
                  Examples: ###id### is replaced by wf.id ; ###get_status()### is replaced by wf.get_status() ; ###start_time|date### is rplaced by wf.start_time in date format.
        @param text: [str] The text containing placeholders.
        @return: [str] The text with placeholders replaced by her real value.
        """
        new_text = text
        placeholders = re.findall("\#\#\#([^\#]+)\#\#\#", text)
        for placeholder in placeholders:
            try:
                placeholder_value = ""
                placeholder_key = placeholder
                is_date = False
                if placeholder.endswith("|date"):
                    placeholder_key = placeholder[:-5]
                    is_date = True
                # Get value
                if placeholder_key.endswith("()"):
                    placeholder_value = str(getattr(self, placeholder_key[:-2])())
                else:
                    placeholder_value = str(getattr(self, placeholder_key))
                # Apply date format
                if is_date:
                    jflow_date_format = self.jflow_config_reader.get_date_format()
                    placeholder_value = time.strftime(jflow_date_format + " %H:%M:%S", time.gmtime(float(placeholder_value)))
                new_text = new_text.replace("###" + placeholder + "###", placeholder_value)
            except:
                pass
        return new_text

668
669
    def _send_email(self):
        import smtplib
670
        from email.mime.text import MIMEText
671
        smtps, smtpp, froma, fromp, toa, subject, message = self.jflow_config_reader.get_email_options()
672
673
674
675
676
        
        if self.__to_address: toa = self.__to_address
        if self.__subject: subject = self.__subject
        if self.__message: message = self.__message
        
677
        if smtps and smtpp and froma and fromp:
678
679
            if not toa: toa = froma
            if validate_email(froma) and validate_email(toa):
680
681
682
683
684
                try:
                    # Open a plain text file for reading.  For this example, assume that
                    # the text file contains only ASCII characters.
                    # Create a text/plain message
                    if not message:
685
                        message = Workflow.get_status_under_text_format(self, True, True, True)
686
                    message = self._get_cleaned_email_placeholders( message )
Jerome Mariette's avatar
Jerome Mariette committed
687
                    msg = MIMEText(message, 'html')
688
689
                    me = froma
                    you = toa
690
691
692
                    if not subject:
                        subject = "JFlow - Workflow #" + str(self.id) + " is " + self.get_status()
                    subject = self._get_cleaned_email_placeholders( subject )
693
694
695
696
697
698
699
                    msg['Subject'] = subject
                    msg['From'] = me
                    msg['To'] = you
                    # Send the message via our own SMTP server, but don't include the
                    # envelope header.
                    s = smtplib.SMTP(smtps, smtpp)
                    s.ehlo()
Jerome Mariette's avatar
Jerome Mariette committed
700
701
702
703
704
                    # if the SMTP server does not provides TLS or identification
                    try:
                        s.starttls()
                        s.login(me, fromp)
                    except smtplib.SMTPHeloError:
Jerome Mariette's avatar
Jerome Mariette committed
705
                        self._log("The server didn't reply properly to the HELO greeting.", level="warning", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
706
                    except smtplib.SMTPAuthenticationError:
Jerome Mariette's avatar
Jerome Mariette committed
707
                        self._log("The server didn't accept the username/password combination.", level="warning", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
708
                    except smtplib.SMTPException:
Jerome Mariette's avatar
Jerome Mariette committed
709
                        self._log("No suitable authentication method was found, or the server does not support the STARTTLS extension.", level="warning", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
710
                    except RuntimeError:
Jerome Mariette's avatar
Jerome Mariette committed
711
                        self._log("SSL/TLS support is not available to your Python interpreter.", level="warning", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
712
                    except:
Jerome Mariette's avatar
Jerome Mariette committed
713
                        self._log("Unhandled error when sending mail.", level="warning", traceback=traceback.format_exc(chain=False))
Jerome Mariette's avatar
Jerome Mariette committed
714
715
716
                    finally:
                        s.sendmail(me, [you], msg.as_string())
                        s.close()
717
                except:
Jerome Mariette's avatar
Jerome Mariette committed
718
                    self._log("Impossible to connect to smtp server '" + smtps + "'", level="warning", traceback=traceback.format_exc(chain=False))
719
    
720
721
722
723
    def get_parameters_per_groups(self):
        name = self.get_name()
        description = self.get_description()
        parameters = self.get_parameters()
724
725
        pgparameters, parameters_order = {}, []
        for param in parameters:
Jerome Mariette's avatar
Jerome Mariette committed
726
            if param.group not in parameters_order: parameters_order.append(param.group)
727
            if param.group in pgparameters:
728
                pgparameters[param.group].append(param)
Jerome Mariette's avatar
Jerome Mariette committed
729
            else:
730
731
                pgparameters[param.group] = [param]
        return [pgparameters, parameters_order]
Jerome Mariette's avatar
Jerome Mariette committed
732
    
733
734
735
    def get_parameters(self):
        params = []
        for param in self.params_order:
736
            for attribute_value in list(self.__dict__.values()):
737
738
739
740
                if (issubclass(attribute_value.__class__, AbstractParameter)) and param == attribute_value.name:
                    params.append(attribute_value)
        return params
    
741
    def get_exec_path(self, software):
742
743
744
745
746
        exec_path = self.jflow_config_reader.get_exec(software)
        if exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "../bin", software)
        elif exec_path is None and os.path.isfile(os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)):
            exec_path = os.path.join(os.path.dirname(inspect.getfile(self.__class__)), "bin", software)
747
        elif exec_path is None and utils.which(software) == None:
748
            raise Exception("'" + software + "' path connot be retrieved either in the PATH and in the application.properties file!")
749
750
751
        elif exec_path is None and utils.which(software) != None: 
            exec_path = software
        elif exec_path != None and not os.path.isfile(exec_path):
752
            raise Exception("'" + exec_path + "' set for '" + software + "' does not exists, please provide a valid path!")
753
        return exec_path
754
    
Jerome Mariette's avatar
Jerome Mariette committed
755
756
    def add_component(self, component_name, args=[], kwargs={}, component_prefix="default"):
        # first build and check if this component is OK
757
        if component_name in self.internal_components or component_name in self.external_components:
758
            
759
            if component_name in self.internal_components:
Jerome Mariette's avatar
Jerome Mariette committed
760
                my_pckge = __import__(self.internal_components[component_name], globals(), locals(), [component_name])
761
762
763
764
765
766
767
768
769
770
771
772
773
                # build the object and define required field
                cmpt_object = getattr(my_pckge, component_name)()
                cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
                cmpt_object.prefix = component_prefix
                if kwargs: cmpt_object.define_parameters(**kwargs)
                else: cmpt_object.define_parameters(*args)
            # external components
            else :
                cmpt_object = self.external_components[component_name]()
                cmpt_object.output_directory = self.get_component_output_directory(component_name, component_prefix)
                cmpt_object.prefix = component_prefix
                # can't use positional arguments with external components
                cmpt_object.define_parameters(**kwargs)
774
775
            
            # there is a dynamic component
776
            if cmpt_object.is_dynamic():
777
778
779
780
                self.dynamic_component_present = True
                # if already init, add the component to the list and check if weaver should be executed
                if self.component_nameids_is_init:
                    # add the component
781
                    self.components_to_exec.append(cmpt_object)
782
                    self.components.append(cmpt_object)
783
784
785
786
787
788
789
790
791
                    self._execute_weaver()
                    # update outputs
                    for output in cmpt_object.get_dynamic_outputs():
                        output.update()
                else:
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
                    self.component_nameids[cmpt_object.get_nameid()] = None
792
                    self.components_to_exec = []
793
                    self.components = []
794
795
796
            else:
                if self.component_nameids_is_init:
                    # add the component
797
                    self.components_to_exec.append(cmpt_object)
798
                    self.components.append(cmpt_object)
799
                elif not self.component_nameids_is_init and not self.dynamic_component_present:
Jerome Mariette's avatar
Jerome Mariette committed
800
801
802
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
803
                    self.components_to_exec.append(cmpt_object)
804
                    self.components.append(cmpt_object)
805
806
807
808
809
810
                else:
                    if self._component_is_duplicated(cmpt_object):
                        raise ValueError("Component " + cmpt_object.__class__.__name__ + " with prefix " + 
                                            cmpt_object.prefix + " already exist in this pipeline!")
                    self.component_nameids[cmpt_object.get_nameid()] = None

811
812
            return cmpt_object
        else:
813
            raise ImportError(component_name + " component cannot be loaded, available components are: {0}".format(
814
                                           ", ".join(list(self.internal_components.keys()) + list(self.external_components.keys()))))
Jerome Mariette's avatar
Jerome Mariette committed
815
816
817
818
819
820
821
822
    
    def pre_process(self):
        pass
    
    def process(self):
        """ 
        Run the workflow, has to be implemented by subclasses
        """
823
        raise NotImplementedError( "Workflow.process() must be implemented in " + self.__class__.__name__ )
824
825
826

    def get_name(self):
        """ 
827
        Return the workflow name.
828
        """
Jerome Mariette's avatar
Jerome Mariette committed
829
        return self.__class__.__name__.lower()
830
831
832
833
834
    
    def get_description(self):
        """ 
        Return the workflow description, has to be implemented by subclasses
        """
835
        raise NotImplementedError( "Workflow.get_description() must be implemented in " + self.__class__.__name__ )
836
    
837
    def define_parameters(self, function="process"):
838
839
840
        """ 
        Define the workflow parameters, has to be implemented by subclasses
        """
841
        raise NotImplementedError( "Workflow.define_parameters() must be implemented in " + self.__class__.__name__ )
Jerome Mariette's avatar
Jerome Mariette committed
842
843
844
845
846
847
848
849
850
851
852
853
    
    def post_process(self):
        pass
    
    def get_temporary_file(self, suffix=".txt"):
        tempfile_name = os.path.basename(tempfile.NamedTemporaryFile(suffix=suffix).name)
        return os.path.join(self.jflow_config_reader.get_tmp_directory(), tempfile_name)

    def get_component_output_directory(self, component_name, component_prefix):
        return os.path.join(self.directory, component_name + "_" + component_prefix)
    
    def get_components_nameid(self):
854
        return list(self.component_nameids.keys())
Jerome Mariette's avatar
Jerome Mariette committed
855
    
Jerome Mariette's avatar
Jerome Mariette committed
856
857
    def wf_execution_wrapper(self):
        getattr(self, self.function)()
Jerome Mariette's avatar
Jerome Mariette committed
858
    
Jerome Mariette's avatar
Jerome Mariette committed
859
860
861
862
    def run(self):
        """
        Only require for Threading
        """
863
864
        try:
            # if this is the first time the workflow run
865
            if self.__step == None:
866
                self.start_time = time.time()
Jerome Mariette's avatar
Jerome Mariette committed
867
                self.__step = 0
868
869
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
870
                self.end_time = None
Jerome Mariette's avatar
Jerome Mariette committed
871
872
                # if some args are provided, let's fill the parameters
                self._set_parameters(self.args)
873
                self._serialize()
874
            # if pre_processing has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
875
            if self.__step == 0:
876
877
878
                self.pre_process()
                self.__step = 1
                self._serialize()
879
            # if collecting components and running workflow has not been done yet
Jerome Mariette's avatar
Jerome Mariette committed
880
            if self.__step == 1:
881
882
883
884
885
886
887
888
889
890
891
892
893
                self.reseted_components = []
                self.components = []
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
                self._serialize()
                self.wf_execution_wrapper()
                self.component_nameids_is_init = True
                if self.dynamic_component_present:
                    self.__step = 2
                else:
                    self._execute_weaver()
                    self.__step = 3
                self._serialize()
894
            # if the workflow was a dynamic one
Jerome Mariette's avatar
Jerome Mariette committed
895
            if self.__step == 2:
896
897
898
899
900
901
902
903
904
905
                self.reseted_components = []
                self.components = []
                self._status = self.STATUS_STARTED
                self._postprocess_status = self.STATUS_PENDING
                self._serialize()
                self.wf_execution_wrapper()
                if len(self.components_to_exec) > 0:
                    self._execute_weaver()
                self.__step = 3
                self._serialize()