Package SCons :: Package Script :: Module Main :: Class CleanTask

Class CleanTask

       object --+        
                |        
  Taskmaster.Task --+    
                    |    
Taskmaster.AlwaysTask --+
                        |
                       CleanTask

An SCons clean task.

Instance Methods

[hide private]

fs_delete(self, path, pathstr, remove=1)

source code

show(self)

source code

remove(self)
Called to execute the task.

source code

execute(self)
Called to execute the task.

source code

executed(self)
Called when the task has been successfully executed and the Taskmaster instance doesn't want to call the Node's callback methods.

source code

make_ready(self)
Marks all targets in a task ready for execution.

source code

prepare(self)
Called just before the task is executed.

source code

Inherited from Taskmaster.AlwaysTask: needs_execute

Inherited from Taskmaster.Task: __init__, display, exc_clear, exc_info, exception_set, executed_with_callbacks, executed_without_callbacks, fail_continue, fail_stop, failed, get_target, make_ready_all, make_ready_current, postprocess, trace_message

Inherited from Taskmaster.Task (private): _exception_raise, _no_exception_to_raise

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

execute(self)

source code


Called to execute the task.

This method is called from multiple threads in a parallel build,
so only do thread safe stuff here.  Do thread unsafe stuff in
prepare(), executed() or failed().

Overrides: Taskmaster.Task.execute: (inherited documentation)

executed(self)

source code


Called when the task has been successfully executed
and the Taskmaster instance doesn't want to call
the Node's callback methods.

Overrides: Taskmaster.Task.executed_with_callbacks

make_ready(self)

source code


Marks all targets in a task ready for execution.

This is used when the interface needs every target Node to be
visited--the canonical example being the "scons -c" option.

Overrides: Taskmaster.Task.make_ready_current

prepare(self)

source code


Called just before the task is executed.

This is mainly intended to give the target Nodes a chance to
unlink underlying files and make all necessary directories before
the Action is actually called to build the targets.

Overrides: Taskmaster.Task.prepare: (inherited documentation)