SCons.Script.Main

Package SCons :: Package Script :: Module Main

[show private | hide private]

Module SCons.Script.Main

SCons.Script

This file implements the main() function used by the scons script.

Architecturally, this *is* the scons script, and will likely only be
called from the external "scons" wrapper.  Consequently, anything here
should not be, or be considered, part of the build engine.  If it's
something that we expect other software to want to use, it should go in
some other module.  If it's specific to the "scons" script invocation,
it goes here.

Classes
`BuildTask`	An SCons build task.
`CleanTask`	An SCons clean task.
`CountStats`
`FakeOptionParser`	A do-nothing option parser, used for the initial OptionsParser variable.
`MemStats`
`Progressor`
`QuestionTask`	An SCons task for the -q (question) option.
`Stats`
`TreePrinter`

Exceptions
`SConsPrintHelpException`

Function Summary
	`AddOption(args, *kw)`
	`find_deepest_user_frame(tb)` Find the deepest stack frame that is not part of SCons.
	`GetBuildFailures()`
	`GetOption(name)`
	`main()`
	`Progress(args, *kw)`
	`SetOption(name, value)`
	`version_string(label, module)`
	`_create_path(plist)`
	`_exec_main(parser, values)`
	`_load_site_scons_dir(topdir, site_dir_name)` Load the site_scons dir under topdir.
	`_main(parser)`
	`_scons_internal_error()` Handle all errors but user errors.
	`_scons_internal_warning(e)` Slightly different from _scons_user_warning in that we use the current call stack rather than sys.exc_info() to get our stack trace.
	`_scons_syntax_error(e)` Handle syntax errors.
	`_scons_user_error(e)` Handle user errors.
	`_scons_user_warning(e)` Handle user warnings.
	`_SConstruct_exists(dirname, repositories)` This function checks that an SConstruct file exists in a directory.
	`_set_debug_values(options)`
	`_setup_warn(arg)` The --warn option.

Function Details

find_deepest_user_frame(tb)

Find the deepest stack frame that is not part of SCons.

Input is a "pre-processed" stack trace in the form returned by traceback.extract_tb() or traceback.extract_stack()

_load_site_scons_dir(topdir, site_dir_name=None)

Load the site_scons dir under topdir. Adds site_scons to sys.path, imports site_scons/site_init.py, and adds site_scons/site_tools to default toolpath.

_scons_internal_error()

Handle all errors but user errors. Print out a message telling the user what to do in this case and print a normal trace.

_scons_internal_warning(e)

Slightly different from _scons_user_warning in that we use the current call stack rather than sys.exc_info() to get our stack trace. This is used by the warnings framework to print warnings.

_scons_syntax_error(e)

Handle syntax errors. Print out a message and show where the error occurred.

_scons_user_error(e)

Handle user errors. Print out a message and a description of the error, along with the line number and routine where it occured. The file and line number will be the deepest stack frame that is not part of SCons itself.

_scons_user_warning(e)

Handle user warnings. Print out a message and a description of the warning, along with the line number and routine where it occured. The file and line number will be the deepest stack frame that is not part of SCons itself.

_SConstruct_exists(dirname='', repositories=[])

This function checks that an SConstruct file exists in a directory. If so, it returns the path of the file. By default, it checks the current directory.

_setup_warn(arg)

The --warn option. An argument to this option should be of the form <warning-class> or no-<warning-class>. The warning class is munged in order to get an actual class name from the SCons.Warnings module to enable or disable. The supplied <warning-class> is split on hyphens, each element is captialized, then smushed back together. Then the string "SCons.Warnings." is added to the front and "Warning" is added to the back to get the fully qualified class name.

For example, --warn=deprecated will enable the SCons.Warnings.DeprecatedWarning class.

--warn=no-dependency will disable the SCons.Warnings.DependencyWarning class.

As a special case, --warn=all and --warn=no-all will enable or disable (respectively) the base class of all warnings, which is SCons.Warning.Warning.

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

http://epydoc.sf.net