Package SCons :: Package Node :: Module FS :: Class FS
[show private | hide private]
[frames | no frames]

Class FS

LocalFS --+
          |
         FS


Method Summary
  __init__(self, path)
Initialize the Node.FS subsystem.
  build_dir_target_climb(self, orig, dir, tail)
Create targets in corresponding build directories
  BuildDir(self, build_dir, src_dir, duplicate)
Link the supplied build directory to the source directory for purposes of building files.
  chdir(self, dir, change_os_dir)
Change the current working directory for lookups.
  Dir(self, name, directory, create)
Lookup or create a Dir node with the specified name.
  Entry(self, name, directory, create)
Lookup or create a generic Entry node with the specified name.
  File(self, name, directory, create)
Lookup or create a File node with the specified name.
  get_max_drift(self)
  get_root(self, drive)
Returns the root directory for the specified drive, creating it if necessary.
  getcwd(self)
  Glob(self, pathname, ondisk, source, strings, cwd)
Globs
  Repository(self, *dirs)
Specify Repository directories to search.
  set_max_drift(self, max_drift)
  set_SConstruct_dir(self, dir)
    Inherited from LocalFS
  chmod(self, path, mode)
  copy(self, src, dst)
  copy2(self, src, dst)
  exists(self, path)
  getmtime(self, path)
  getsize(self, path)
  isdir(self, path)
  isfile(self, path)
  islink(self, path)
  link(self, src, dst)
  listdir(self, path)
  lstat(self, path)
  makedirs(self, path)
  mkdir(self, path)
  open(self, path)
  readlink(self, file)
  rename(self, old, new)
  stat(self, path)
  symlink(self, src, dst)
  unlink(self, path)

Class Variable Summary
list memoizer_counters = []

Method Details

__init__(self, path=None)
(Constructor)

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.

build_dir_target_climb(self, orig, dir, tail)

Create targets in corresponding build directories

Climb the directory tree, and look up path names relative to any linked build 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.

BuildDir(self, build_dir, src_dir, duplicate=1)

Link the supplied build directory to the source directory for purposes of building files.

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.

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

Lookup 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.

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

Lookup 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.

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

Lookup 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.

get_root(self, drive)

Returns the root directory for the specified drive, creating it if necessary.

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

Globs

This is mainly a shim layer

Repository(self, *dirs)

Specify Repository directories to search.


Class Variable Details

memoizer_counters

Type:
list
Value:
[]                                                                     

Generated by Epydoc 2.1 on Wed Dec 12 09:39:32 2007 http://epydoc.sf.net