SCons.SConf.SConfBuildTask

Package SCons :: Module SConf :: Class SConfBuildTask

[show private | hide private]

Class SConfBuildTask

Task --+
       |
      SConfBuildTask

This is almost the same as SCons.Script.BuildTask. Handles SConfErrors correctly and knows about the current cache_mode.

Method Summary
	`collect_node_states(self)`
	`display(self, message)` Hook to allow the calling interface to display a message.
	`display_cached_string(self, bi)` Logs the original builder messages, given the SConfBuildInfo instance bi.
	`execute(self)` Called to execute the task.
	`failed(self)` Default action when a task fails: stop the build.
Inherited from Task
	`__init__(self, tm, targets, top, node)`
	`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(self)` Called when the task has been successfully executed and the Taskmaster instance wants to call the Node's callback methods.
	`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.
	`get_target(self)` Fetch the target being built or updated by this task.
	`make_ready(self)` Marks all targets in a task ready for execution if any target is not current.
	`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.
	`prepare(self)` Called just before the task is executed.

Method Details

display(self, message)

Hook to allow the calling interface to display a message.

This hook gets called as part of preparing a task for execution (that is, a Node to be built). As part of figuring out what Node should be built next, the actually target list may be altered, along with a message describing the alteration. The calling interface can subclass Task and provide a concrete implementation of this method to see those messages.

Overrides:: SCons.Taskmaster.Task.display (inherited documentation)

display_cached_string(self, bi)

Logs the original builder messages, given the SConfBuildInfo instance bi.

execute(self)

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

failed(self)

Default action when a task fails: stop the build.

Overrides:: SCons.Taskmaster.Task.failed (inherited documentation)

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

http://epydoc.sf.net