SCons.Environment.OverrideEnvironment

Package SCons :: Module Environment :: Class OverrideEnvironment

[show private | hide private]

Class OverrideEnvironment

SubstitutionEnvironment --+    
                          |    
                       Base --+
                              |
                             OverrideEnvironment

A proxy that overrides variables in a wrapped construction environment by returning values from an overrides dictionary in preference to values from the underlying subject environment.

This is a lightweight (I hope) proxy that passes through most use of attributes to the underlying Environment.Base class, but has just enough additional methods defined to act like a real construction environment with overridden values. It can wrap either a Base construction environment, or another OverrideEnvironment, which can in turn nest arbitrary OverrideEnvironments...

Note that we do not call the underlying base class (SubsitutionEnvironment) initialization, because we get most of those from proxying the attributes of the subject construction environment. But because we subclass SubstitutionEnvironment, this class also has inherited arg2nodes() and subst*() methods; those methods can't be proxied because they need this object's methods to fetch the values from the overrides dictionary.

Method Summary
	`__init__(self, subject, overrides)`
	`__delitem__(self, key)`
	`__getattr__(self, name)`
	`__getitem__(self, key)`
	`__setattr__(self, name, value)`
	`__setitem__(self, key, value)`
	`Dictionary(self)` Emulates the items() method of dictionaries.
	`get(self, key, default)` Emulates the get() method of dictionaries.
	`gvars(self)`
	`has_key(self, key)`
	`items(self)` Emulates the items() method of dictionaries.
	`lvars(self)`
	`Replace(self, **kw)` Replace existing construction variables in an Environment with new construction variables and/or values.
	`_update(self, dict)` Update an environment's values directly, bypassing the normal checks that occur when users try to set items.
Inherited from Base
	`Action(self, args, *kw)`
	`AddPostAction(self, files, action)`
	`AddPreAction(self, files, action)`
	`Alias(self, target, source, action, **kw)`
	`AlwaysBuild(self, *targets)`
	`Append(self, **kw)` Append values to existing construction variables in an Environment.
	`AppendENVPath(self, name, newpath, envname, sep)` Append path elements to the path 'name' in the 'ENV' dictionary for this environment.
	`AppendUnique(self, **kw)` Append values to existing construction variables in an Environment, if they're not already there.
	`BuildDir(self, build_dir, src_dir, duplicate)`
	`Builder(self, **kw)`
	`CacheDir(self, path)`
	`Clean(self, targets, files)`
	`Clone(self, tools, toolpath, **kw)` Return a copy of a construction Environment.
	`Command(self, target, source, action, **kw)` Builds the supplied target files from the supplied source files using the supplied action.
	`Configure(self, args, *kw)`
	`Copy(self, args, *kw)`
	`Decider(self, function)`
	`Depends(self, target, dependency)` Explicity specify that 'target's depend on 'dependency'.
	`Detect(self, progs)` Return the first available program in progs.
	`Dir(self, name, args, *kw)`
	`Dump(self, key)` Using the standard Python pretty printer, dump the contents of the scons build environment to stdout.
	`Entry(self, name, args, *kw)`
	`Environment(self, **kw)`
	`Execute(self, action, args, *kw)` Directly execute an action through an Environment
	`File(self, name, args, *kw)`
	`FindFile(self, file, dirs)`
	`FindInstalledFiles(self)` returns the list of all targets of the Install and InstallAs Builder.
	`FindIxes(self, paths, prefix, suffix)` Search a list of paths for something that matches the prefix and suffix.
	`FindSourceFiles(self, node)` returns a list of all source files.
	`Flatten(self, sequence)`
	`get_builder(self, name)` Fetch the builder with the specified name from the environment.
	`get_CacheDir(self)`
	`get_factory(self, factory, default)` Return a factory function for creating Nodes for this construction environment.
	`get_scanner(self, skey)` Find the appropriate scanner given a key (usually a file suffix).
	`get_src_sig_type(self)`
	`get_tgt_sig_type(self)`
	`GetBuildPath(self, files)`
	`Glob(self, pattern, ondisk, source, strings)`
	`Ignore(self, target, dependency)` Ignore a dependency.
	`Literal(self, string)`
	`Local(self, *targets)`
	`NoCache(self, *targets)` Tags a target so that it will not be cached
	`NoClean(self, *targets)` Tags a target so that it will not be cleaned by -c
	`ParseConfig(self, command, function, unique)` Use the specified function to parse the output of the command in order to modify the current environment.
	`ParseDepends(self, filename, must_exist, only_one)` Parse a mkdep-style file for explicit dependencies.
	`Platform(self, platform)`
	`Precious(self, *targets)`
	`Prepend(self, **kw)` Prepend values to existing construction variables in an Environment.
	`PrependENVPath(self, name, newpath, envname, sep)` Prepend path elements to the path 'name' in the 'ENV' dictionary for this environment.
	`PrependUnique(self, **kw)` Append values to existing construction variables in an Environment, if they're not already there.
	`ReplaceIxes(self, path, old_prefix, old_suffix, new_prefix, new_suffix)` Replace old_prefix with new_prefix and old_suffix with new_suffix.
	`Repository(self, dirs, *kw)`
	`Requires(self, target, prerequisite)` Specify that 'prerequisite' must be built before 'target', (but 'target' does not actually depend on 'prerequisite' and need not be rebuilt if it changes).
	`Scanner(self, args, *kw)`
	`scanner_map_delete(self, kw)` Delete the cached scanner map (if we need to).
	`SConsignFile(self, name, dbm_module)`
	`SetDefault(self, **kw)`
	`SideEffect(self, side_effect, target)` Tell scons that side_effects are built as side effects of building targets.
	`SourceCode(self, entry, builder)` Arrange for a source code builder for (part of) a tree.
	`SourceSignatures(self, type)`
	`Split(self, arg)` This function converts a string or list into a list of strings or Nodes.
	`TargetSignatures(self, type)`
	`Tool(self, tool, toolpath, **kw)`
	`Value(self, value, built_value)`
	`WhereIs(self, prog, path, pathext, reject)` Find prog in the path.
	`_changed_build(self, dependency, target, prev_ni)`
	`_changed_content(self, dependency, target, prev_ni)`
	`_changed_source(self, dependency, target, prev_ni)`
	`_changed_timestamp_match(self, dependency, target, prev_ni)`
	`_changed_timestamp_newer(self, dependency, target, prev_ni)`
	`_changed_timestamp_then_content(self, dependency, target, prev_ni)`
	`_copy2_from_cache(self, src, dst)`
	`_copy_from_cache(self, src, dst)`
	`_find_toolpath_dir(self, tp)`
	`_gsm(self)`
Inherited from SubstitutionEnvironment
	`__cmp__(self, other)`
	`AddMethod(self, function, name)` Adds the specified function as a method of this construction environment with the specified name.
	`arg2nodes(self, args, node_factory, lookup_list, **kw)`
	`backtick(self, command)`
	`MergeFlags(self, args, unique)` Merge the dict in args into the construction variables.
	`Override(self, overrides)` Produce a modified environment whose variables are overriden by the overrides dictionaries.
	`ParseFlags(self, *flags)` Parse the set of flags and return a dict with the flags placed in the appropriate entry.
	`RemoveMethod(self, function)` Removes the specified function's MethodWrapper from the added_methods list, so we don't re-bind it when making a clone.
	`subst(self, string, raw, target, source, conv)` Recursively interpolates construction variables from the Environment into the specified string, returning the expanded result.
	`subst_kw(self, kw, raw, target, source)`
	`subst_list(self, string, raw, target, source, conv)` Calls through to SCons.Subst.scons_subst_list().
	`subst_path(self, path, target, source)` Substitute a path list, turning EntryProxies into Nodes and leaving Nodes (and other objects) as-is.
	`subst_target_source(self, string, raw, target, source, conv)` Recursively interpolates construction variables from the Environment into the specified string, returning the expanded result.
	`_init_special(self)` Initial the dispatch tables for special handling of special construction variables.

Class Variable Summary
Inherited from Base
`list`	`memoizer_counters` = `[<SCons.Memoize.CountValue instance ...`

Method Details

Dictionary(self)

Emulates the items() method of dictionaries.

Overrides:: SCons.Environment.Base.Dictionary

get(self, key, default=None)

Emulates the get() method of dictionaries.

Overrides:: SCons.Environment.SubstitutionEnvironment.get

items(self)

Emulates the items() method of dictionaries.

Overrides:: SCons.Environment.SubstitutionEnvironment.items

Replace(self, **kw)

Replace existing construction variables in an Environment with new construction variables and/or values.

Overrides:: SCons.Environment.Base.Replace (inherited documentation)

_update(self, dict)

Update an environment's values directly, bypassing the normal checks that occur when users try to set items.

Overrides:: SCons.Environment.Base._update

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

http://epydoc.sf.net