SCons.Script.SConscript'

Module SConscript'

SCons.Script.SConscript

This module defines the Python API provided to SConscript and SConstruct files.

Classes

Frame
A frame on the SConstruct/SConscript call stack

SConsEnvironment
An Environment subclass that contains all of the methods that are particular to the wrapper SCons interface and which aren't (or shouldn't be) part of the build engine itself.

DefaultEnvironmentCall
A class that implements "global function" calls of Environment methods by fetching the specified method from the DefaultEnvironment's class. Note that this uses an intermediate proxy class instead of calling the DefaultEnvironment method directly so that the proxy can override the subst() method and thereby prevent expansion of construction variables (since from the user's point of view this was called as a global function, with no associated construction environment).

Functions

[hide private]

get_calling_namespaces()
Return the locals and globals for the function that called into this module in the current call stack.

source code

compute_exports(exports)
Compute a dictionary of exports given one of the parameters to the Export() function or the exports argument to SConscript().

source code

Return(*vars, **kw)

source code

handle_missing_SConscript(f, must_exist=None)
Take appropriate action on missing file in SConscript() call.

source code

_SConscript(fs, *files, **kw)

source code

SConscript_exception(file=<epydoc.docintrospecter._DevNull object>)
Print an exception stack trace just for the SConscript file(s). This will show users who have Python errors where the problem is, without cluttering the output with all of the internal calls leading up to where we exec the SConscript.

source code

annotate(node)
Annotate a node with the stack frame describing the SConscript file and line number that created it.

source code

Configure(*args, **kw)

source code

get_DefaultEnvironmentProxy()

source code

BuildDefaultGlobals()
Create a dictionary containing all the default globals for SConstruct and SConscript files.

source code

Variables

[hide private]

__revision__ = 'src/engine/SCons/Script/SConscript.py 3a41ed6b...

launch_dir = '/home/bdeegan/devel/scons/git/as_scons'

GlobalDict = None
hash(x)

global_exports = {}

sconscript_chdir = 1

call_stack = []

stack_bottom = '% Stack boTTom %'

_DefaultEnvironmentProxy = None
hash(x)

__package__ = 'SCons.Script'

Function Details

[hide private]

handle_missing_SConscript(f, must_exist=None)

source code

Take appropriate action on missing file in SConscript() call.

Print a warning or raise an exception on missing file. On first warning, print a deprecation message.

Args:

f (str): path of missing configuration file must_exist (bool): raise exception if file does not exist

Raises:

UserError if 'must_exist' is True or if global: SCons.Script._no_missing_sconscript is True.

Variables Details

[hide private]

revision

Value:

'src/engine/SCons/Script/SConscript.py 3a41ed6b288cee8d085373ad7fa0289
4e1903864 2019-01-23 17:30:35 bdeegan'