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

Class FS

object --+    
         |    
   LocalFS --+
             |
            FS

Instance Methods

[hide private]

__init__(self, path=None)
Initialize the Node.FS subsystem.

source code

set_SConstruct_dir(self, dir)

source code

get_max_drift(self)

source code

set_max_drift(self, max_drift)

source code

getcwd(self)

source code

chdir(self, dir, change_os_dir=0)
Change the current working directory for lookups. If change_os_dir is true, we will also change the "real" cwd to match.

source code

get_root(self, drive)
Returns the root directory for the specified drive, creating it if necessary.

source code

_lookup(self, p, directory, fsclass, create=1)
The generic entry point for Node lookup with user-supplied data.

source code

Entry(self, name, directory=None, create=1)
Look up or create a generic Entry node with the specified name. If the name is a relative path (begins with ./, ../, or a file name), then it is looked up relative to the supplied directory node, or to the top level directory of the FS (supplied at construction time) if no directory is supplied.

source code

File(self, name, directory=None, create=1)
Look up or create a File node with the specified name. If the name is a relative path (begins with ./, ../, or a file name), then it is looked up relative to the supplied directory node, or to the top level directory of the FS (supplied at construction time) if no directory is supplied.

source code

Dir(self, name, directory=None, create=True)
Look up or create a Dir node with the specified name. If the name is a relative path (begins with ./, ../, or a file name), then it is looked up relative to the supplied directory node, or to the top level directory of the FS (supplied at construction time) if no directory is supplied.

source code

VariantDir(self, variant_dir, src_dir, duplicate=1)
Link the supplied variant directory to the source directory for purposes of building files.

source code

Repository(self, *dirs)
Specify Repository directories to search.

source code

PyPackageDir(self, modulename)
Locate the directory of a given python module name

source code

variant_dir_target_climb(self, orig, dir, tail)
Create targets in corresponding variant directories

source code

Glob(self, pathname, ondisk=True, source=True, strings=False, exclude=None, cwd=None)
Globs

source code

Inherited from LocalFS: chmod, copy, copy2, exists, getmtime, getsize, isdir, isfile, islink, link, listdir, lstat, makedirs, mkdir, open, readlink, rename, stat, symlink, unlink

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]

init(self, path=None)
(Constructor)

source code

Initialize the Node.FS subsystem.

The supplied path is the top of the source tree, where we expect to find the top-level build file. If no path is supplied, the current directory is the default.

The path argument must be a valid absolute path.

Overrides: object.__init__

_lookup(self, p, directory, fsclass, create=1)

source code

The generic entry point for Node lookup with user-supplied data.

This translates arbitrary input into a canonical Node.FS object of the specified fsclass. The general approach for strings is to turn it into a fully normalized absolute path and then call the root directory's lookup_abs() method for the heavy lifting.

If the path name begins with '#', it is unconditionally interpreted relative to the top-level directory of this FS. '#' is treated as a synonym for the top-level SConstruct directory, much like '~' is treated as a synonym for the user's home directory in a UNIX shell. So both '#foo' and '#/foo' refer to the 'foo' subdirectory underneath the top-level SConstruct directory.

If the path name is relative, then the path is looked up relative to the specified directory, or the current directory (self._cwd, typically the SConscript directory) if the specified directory is None.

File(self, name, directory=None, create=1)

source code

Look up or create a File node with the specified name. If the name is a relative path (begins with ./, ../, or a file name), then it is looked up relative to the supplied directory node, or to the top level directory of the FS (supplied at construction time) if no directory is supplied.

This method will raise TypeError if a directory is found at the specified path.

Dir(self, name, directory=None, create=True)

source code

Look up or create a Dir node with the specified name. If the name is a relative path (begins with ./, ../, or a file name), then it is looked up relative to the supplied directory node, or to the top level directory of the FS (supplied at construction time) if no directory is supplied.

This method will raise TypeError if a normal file is found at the specified path.

PyPackageDir(self, modulename)

source code

Locate the directory of a given python module name

For example scons might resolve to Windows: C:Python27Libsite-packagesscons-2.5.1 Linux: /usr/lib/scons

This can be useful when we want to determine a toolpath based on a python module name

variant_dir_target_climb(self, orig, dir, tail)

source code

Create targets in corresponding variant directories

Climb the directory tree, and look up path names relative to any linked variant directories we find.

Even though this loops and walks up the tree, we don't memoize the return value because this is really only used to process the command-line targets.

Glob(self, pathname, ondisk=True, source=True, strings=False, exclude=None, cwd=None)

source code

Globs

This is mainly a shim layer

Class FS

__init__(self, path=None) (Constructor)

_lookup(self, p, directory, fsclass, create=1)

File(self, name, directory=None, create=1)

Dir(self, name, directory=None, create=True)

PyPackageDir(self, modulename)

variant_dir_target_climb(self, orig, dir, tail)

Glob(self, pathname, ondisk=True, source=True, strings=False, exclude=None, cwd=None)

init(self, path=None)
(Constructor)