SCons.Node.FS.Entry

Package SCons :: Package Node :: Module FS :: Class Entry

[show private | hide private]

Class Entry

Node --+    
       |    
    Base --+
           |
          Entry

This is the class for generic Node.FS entries--that is, things that could be a File or a Dir, but we're just not sure yet. Consequently, the methods in this class really exist just to transform their associated object into the right class when the time comes, and then call the same-named method in the transformed class.

Method Summary
	`changed_since_last_build(self, target, prev_ni)` Must be overridden in a specific subclass to return True if this Node (a dependency) has changed since the last time it was used to build the specified target.
	`disambiguate(self, must_exist)`
	`diskcheck_match(self)`
	`exists(self)` Return if the Entry exists.
	`get_contents(self)` Fetch the contents of the entry.
	`must_be_same(self, klass)` Called to make sure a Node is a Dir.
	`new_ninfo(self)`
	`rel_path(self, other)`
	`rfile(self)` We're a generic Entry, but the caller is actually looking for a File at this point, so morph into one.
	`scanner_key(self)`
	`_glob1(self, pattern, ondisk, source, strings)`
Inherited from Base
	`__init__(self, name, directory, fs)` Initialize a generic Node.FS.Base object.
	`__str__(self)` A Node.FS.Base object's string representation is its path name.
	`for_signature(self)` Return a string representation of the Node that will always be the same for this particular Node, no matter what.
	`get_abspath(self)` Get the absolute path of the file.
	`get_dir(self)`
	`get_path(self, dir)` Return path relative to the current working directory of the Node.FS.Base object that owns us.
	`get_subst_proxy(self)` This method is expected to return an object that will function exactly like this Node, except that it implements any additional special features that we would like to be in effect for Environment variable substitution.
	`get_suffix(self)`
	`getmtime(self)`
	`getsize(self)`
	`is_under(self, dir)`
	`isdir(self)`
	`isfile(self)`
	`islink(self)`
	`RDirs(self, pathlist)` Search for a list of directories in the Repository list.
	`rentry(self)`
	`rexists(self)` Does this node exist locally or in a repositiory?
	`Rfindalldirs(self, pathlist)` Return all of the directories for a given path list, including corresponding "backing" directories in any repositories.
	`rstr(self)` A Node.FS.Base object's string representation is its path name.
	`set_local(self)`
	`set_src_builder(self, builder)` Set the source code builder for this node.
	`src_builder(self)` Fetch the source code builder for this node.
	`srcnode(self)` If this node is in a build path, return the node corresponding to its source file.
	`stat(self)`
	`target_from_source(self, prefix, suffix, splitext)` Generates a target entry that corresponds to this entry (usually a source file) with the specified prefix and suffix.
	`_get_str(self)`
	`_Rfindalldirs_key(self, pathlist)`
	`_save_str(self)`
Inherited from Node
	`add_dependency(self, depend)` Adds dependencies.
	`add_ignore(self, depend)` Adds dependencies to ignore.
	`add_prerequisite(self, prerequisite)` Adds prerequisites
	`add_source(self, source)` Adds sources.
	`add_to_implicit(self, deps)`
	`add_to_waiting_parents(self, node)` Returns the number of nodes added to our waiting parents list: 1 if we add a unique waiting parent, 0 if not.
	`add_to_waiting_s_e(self, node)`
	`add_wkid(self, wkid)` Add a node to the list of kids waiting to be evaluated
	`all_children(self, scan)` Return a list of all the node's direct children.
	`alter_targets(self)` Return a list of alternate targets for this Node.
	`build(self, **kw)` Actually build the node.
	`builder_set(self, builder)`
	`built(self)` Called just after this node is successfully built.
	`call_for_all_waiting_parents(self, func)`
	`changed(self, node)` Returns if the node is up-to-date with respect to the BuildInfo stored last time it was built.
	`children(self, scan)` Return a list of the node's direct children, minus those that are ignored by this node.
	`children_are_up_to_date(self)` Alternate check for whether the Node is current: If all of our children were up-to-date, then this Node was up-to-date, too.
	`clear(self)` Completely clear a Node of all its cached state (so that it can be re-evaluated by interfaces that do continuous integration builds).
	`clear_memoized_values(self)`
	`Decider(self, function)`
	`del_binfo(self)` Delete the build info from this node.
	`do_not_ignore(self, node)`
	`do_not_store_info(self)`
	`env_set(self, env, safe)`
	`executor_cleanup(self)` Let the executor clean up any cached information.
	`explain(self)`
	`get_binfo(self)` Fetch a node's build information.
	`get_build_env(self)` Fetch the appropriate Environment to build this node.
	`get_build_scanner_path(self, scanner)` Fetch the appropriate scanner path for this node.
	`get_builder(self, default_builder)` Return the set builder, or a specified default value
	`get_cachedir_csig(self)`
	`get_csig(self)`
	`get_env(self)`
	`get_env_scanner(self, env, kw)`
	`get_executor(self, create)` Fetch the action executor for this node.
	`get_found_includes(self, env, scanner, path)` Return the scanned include lines (implicit dependencies) found in this node.
	`get_implicit_deps(self, env, scanner, path)` Return a list of implicit dependencies for this node.
	`get_ninfo(self)`
	`get_source_scanner(self, node)` Fetch the source scanner for the specified node
	`get_state(self)`
	`get_stored_implicit(self)` Fetch the stored implicit dependencies
	`get_stored_info(self)`
	`get_string(self, for_signature)` This is a convenience function designed primarily to be used in command generators (i.e., CommandGeneratorActions or Environment variables that are callable), which are called with a for_signature argument that is nonzero if the command generator is being called to generate a signature for the command line, which determines if we should rebuild or not.
	`get_target_scanner(self)`
	`has_builder(self)` Return whether this Node has a builder or not.
	`has_explicit_builder(self)` Return whether this Node has an explicit builder
	`is_derived(self)` Returns true iff this node is derived (i.e.
	`is_literal(self)` Always pass the string representation of a Node to the command interpreter literally.
	`is_up_to_date(self)` Default check for whether the Node is current: unknown Node subtypes are always out of date, so they will always get built.
	`make_ready(self)` Get a Node ready for evaluation.
	`missing(self)`
	`multiple_side_effect_has_builder(self)` Return whether this Node has a builder or not.
	`new_binfo(self)`
	`postprocess(self)` Clean up anything we don't need to hang onto after we've been built.
	`prepare(self)` Prepare for this Node to be built.
	`remove(self)` Remove this Node: no-op by default.
	`render_include_tree(self)` Return a text representation, suitable for displaying to the user, of the include tree for the sources of this node.
	`reset_executor(self)` Remove cached executor; forces recompute when needed.
	`retrieve_from_cache(self)` Try to retrieve the node's content from a cache
	`scan(self)` Scan this node's dependents for implicit dependencies.
	`select_scanner(self, scanner)` Selects a scanner for this Node.
	`set_always_build(self, always_build)` Set the Node's always_build value.
	`set_executor(self, executor)` Set the action executor for this node.
	`set_explicit(self, is_explicit)`
	`set_nocache(self, nocache)` Set the Node's nocache value.
	`set_noclean(self, noclean)` Set the Node's noclean value.
	`set_precious(self, precious)` Set the Node's precious value.
	`set_state(self, state)`
	`state_has_changed(self, target, prev_ni)`
	`store_info(self)` Make the build signature permanent (that is, store it in the .sconsign file or equivalent).
	`visited(self)` Called just after this node has been visited (with or without a build).
	`_add_child(self, collection, dict, child)` Adds 'child' to 'collection', first checking 'dict' to see if it's already present.
	`_all_children_get(self)`
	`_children_get(self)`
	`_children_reset(self)`

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

Method Details

changed_since_last_build(self, target, prev_ni)

Must be overridden in a specific subclass to return True if this Node (a dependency) has changed since the last time it was used to build the specified target. prev_ni is this Node's state (for example, its file timestamp, length, maybe content signature) as of the last time the target was built.

Note that this method is called through the dependency, not the target, because a dependency Node must be able to use its own logic to decide if it changed. For example, File Nodes need to obey if we're configured to use timestamps, but Python Value Nodes never use timestamps and always use the content. If this method were called through the target, then each Node's implementation of this method would have to have more complicated logic to handle all the different Node types on which it might depend.

Overrides:: SCons.Node.Node.changed_since_last_build (inherited documentation)

exists(self)

Return if the Entry exists. Check the file system to see what we should turn into first. Assume a file if there's no directory.

Overrides:: SCons.Node.FS.Base.exists

get_contents(self)

Fetch the contents of the entry.

Since this should return the real contents from the file system, we check to see into what sort of subclass we should morph this Entry.

must_be_same(self, klass)

Called to make sure a Node is a Dir. Since we're an Entry, we can morph into one.

Overrides:: SCons.Node.FS.Base.must_be_same

rfile(self)

We're a generic Entry, but the caller is actually looking for a File at this point, so morph into one.

Overrides:: SCons.Node.FS.Base.rfile

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

http://epydoc.sf.net