Package SCons :: Package Script :: Module SConscript' :: Class SConsEnvironment

Class SConsEnvironment

                         object --+        
                                  |        
Environment.SubstitutionEnvironment --+    
                                      |    
                       Environment.Base --+
                                          |
                                         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.

Note that not all of the methods of this class have corresponding global functions, there are some private methods.

Instance Methods

[hide private]

_exceeds_version(self, major, minor, v_major, v_minor)
Return 1 if 'major' and 'minor' are greater than the version in 'v_major' and 'v_minor', and 0 otherwise.

source code

_get_major_minor_revision(self, version_string)
Split a version string into major, minor and (optionally) revision parts.

source code

_get_SConscript_filenames(self, ls, kw)
Convert the parameters passed to SConscript() calls into a list of files and export variables. If the parameters are invalid, throws SCons.Errors.UserError. Returns a tuple (l, e) where l is a list of SConscript filenames and e is a list of exports.

source code

Configure(self, *args, **kw)

source code

Default(self, *targets)

source code

EnsureSConsVersion(self, major, minor, revision=0)
Exit abnormally if the SCons version is not late enough.

source code

EnsurePythonVersion(self, major, minor)
Exit abnormally if the Python version is not late enough.

source code

Exit(self, value=0)

source code

Export(self, *vars, **kw)

source code

GetLaunchDir(self)

source code

GetOption(self, name)

source code

Help(self, text, append=False)

source code

Import(self, *vars)

source code

SConscript(self, *ls, **kw)
Execute SCons configuration files.

source code

SConscriptChdir(self, flag)

source code

SetOption(self, name, value)

source code

Inherited from Environment.Base: Action, AddPostAction, AddPreAction, Alias, AlwaysBuild, Append, AppendENVPath, AppendUnique, BuildDir, Builder, CacheDir, Clean, Clone, Command, Copy, Decider, Depends, Detect, Dictionary, Dir, Dump, Entry, Environment, Execute, File, FindFile, FindInstalledFiles, FindIxes, FindSourceFiles, Flatten, GetBuildPath, Glob, Ignore, Literal, Local, NoCache, NoClean, ParseConfig, ParseDepends, Platform, Precious, Prepend, PrependENVPath, PrependUnique, Pseudo, PyPackageDir, Replace, ReplaceIxes, Repository, Requires, SConsignFile, Scanner, SetDefault, SideEffect, SourceCode, SourceSignatures, Split, TargetSignatures, Tool, Value, VariantDir, WhereIs, __init__, get_CacheDir, get_builder, get_factory, get_scanner, get_src_sig_type, get_tgt_sig_type, scanner_map_delete

Inherited from Environment.Base (private): _canonicalize, _changed_build, _changed_content, _changed_source, _changed_timestamp_match, _changed_timestamp_newer, _changed_timestamp_then_content, _copy2_from_cache, _copy_from_cache, _find_toolpath_dir, _gsm, _update

Inherited from Environment.SubstitutionEnvironment: AddMethod, MergeFlags, Override, ParseFlags, RemoveMethod, __contains__, __delitem__, __eq__, __getitem__, __setitem__, arg2nodes, backtick, get, gvars, has_key, items, lvars, subst, subst_kw, subst_list, subst_path, subst_target_source

Inherited from Environment.SubstitutionEnvironment (private): _init_special

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

_get_major_minor_revision(self, version_string)

source code

Split a version string into major, minor and (optionally) revision parts.

This is complicated by the fact that a version string can be something like 3.2b1.

Configure(self, *args, **kw)

source code

Overrides: Environment.Base.Configure

SConscript(self, *ls, **kw)

source code

Execute SCons configuration files.

Parameters:
    *ls (str or list): configuration file(s) to execute.

Keyword arguments:
    dirs (list): execute SConscript in each listed directory.
    name (str): execute script 'name' (used only with 'dirs').
    exports (list or dict): locally export variables the
      called script(s) can import.
    variant_dir (str): mirror sources needed for the build in
     a variant directory to allow building in it.
    duplicate (bool): physically duplicate sources instead of just
      adjusting paths of derived files (used only with 'variant_dir')
      (default is True).
    must_exist (bool): fail if a requested script is missing
      (default is False, default is deprecated).

Returns:
    list of variables returned by the called script

Raises:
    UserError: a script is not found and such exceptions are enabled.