SCons.Script.Main.CleanTask

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

[show private | hide private]

Class CleanTask

Task --+
       |
      CleanTask

An SCons clean task.

Method Summary
	`execute(self)`
	`executed(self)` Called when the task has been successfully executed and the Taskmaster instance doesn't want to call the Node's callback methods.
	`fs_delete(self, path, pathstr, remove)`
	`make_ready(self)` Marks all targets in a task ready for execution.
	`prepare(self)` Called just before the task is executed.
	`remove(self)`
	`show(self)`
Inherited from Task
	`__init__(self, tm, targets, top, node)`
	`display(self, message)` Hook to allow the calling interface to display a message.
	`exc_clear(self)` Clears any recorded exception.
	`exc_info(self)` Returns info about a recorded exception.
	`exception_set(self, exception)` Records an exception to be raised at the appropriate time.
	`executed_with_callbacks(self)` Called when the task has been successfully executed and the Taskmaster instance wants to call the Node's callback methods.
	`executed_without_callbacks(self)` Called when the task has been successfully executed and the Taskmaster instance doesn't want to call the Node's callback methods.
	`fail_continue(self)` Explicit continue-the-build failure.
	`fail_stop(self)` Explicit stop-the-build failure.
	`failed(self)` Default action when a task fails: stop the build.
	`get_target(self)` Fetch the target being built or updated by this task.
	`make_ready_all(self)` Marks all targets in a task ready for execution.
	`make_ready_current(self)` Marks all targets in a task ready for execution if any target is not current.
	`postprocess(self)` Post-processes a task after it's been executed.
	`_exception_raise(self)` Raises a pending exception that was recorded while getting a Task ready for execution.
	`_no_exception_to_raise(self)`

Method Details

executed(self)

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

make_ready(self)

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.

prepare(self)

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:: SCons.Taskmaster.Task.prepare (inherited documentation)

Generated by Epydoc 2.1 on Wed Dec 12 09:39:31 2007

http://epydoc.sf.net