SCons.Node.FS

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

# Module FS

source code

scons.Node.FS

File system nodes.

These Nodes represent the canonical external objects that people think of when they think of building software: files and directories.

This holds a "default_fs" variable that should be initialized with an FS that can be used by scripts or modules looking for the canonical default.

Classes | [hide private]
| _Null
| DiskChecker
| EntryProxy
| Base A generic class for file system entries.
| 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.
| _classEntry 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.
| LocalFS
| FS
| DirNodeInfo The generic base class for signature information for a Node.
| DirBuildInfo The generic base class for build information for a Node.
| Dir A class for directories in a file system.
| RootDir A class for the root directory of a file system.
| FileNodeInfo The generic base class for signature information for a Node.
| FileBuildInfo The generic base class for build information for a Node.
| File A class for files in a file system.
| FileFinder

Functions | [hide private]
save_strings(val) | source code
initialize_do_splitdrive() | source code
initialize_normpath_check() Initialize the normpath_check regular expression. | source code
_hardlink_func(fs, src, dst) | source code
_softlink_func(fs, src, dst) | source code
_copy_func(fs, src, dest) | source code
set_duplicate(duplicate) | source code
LinkFunc(target, source, env) | source code
LocalString(target, source, env) | source code
UnlinkFunc(target, source, env) | source code
MkdirFunc(target, source, env) | source code
get_MkdirBuilder() | source code
get_DefaultSCCSBuilder() | source code
get_DefaultRCSBuilder() | source code
_my_normcase(x) | source code
do_diskcheck_match(node, predicate, errorfmt) | source code
ignore_diskcheck_match(node, predicate, errorfmt) | source code
do_diskcheck_rcs(node, name) | source code
ignore_diskcheck_rcs(node, name) | source code
do_diskcheck_sccs(node, name) | source code
ignore_diskcheck_sccs(node, name) | source code
set_diskcheck(list) | source code
diskcheck_types() | source code
has_glob_magic(s) | source code
get_default_fs() | source code
find_file(filename, paths, verbose=False) find_file(str, [Dir()]) -> [nodes] filename - a filename to find paths - a list of directory path *nodes* to search in. | source code

Variables | [hide private]
| __revision__ = ``'``src/engine/SCons/Node/FS.py 2725 2008/03/31 12``...``
| default_max_drift = `172800`
| Save_Strings = `False`
| do_splitdrive = `False`
| needs_normpath_check = `False`
| Valid_Duplicates = ``[``'``hard-soft-copy``'``,` `'``soft-hard-copy``'``,` `'``hard-``...``
| Link_Funcs = ``[``]``
| Link = `SCons.Action.Action(LinkFunc, None)`
| LocalCopy = `SCons.Action.Action(LinkFunc, LocalString)`
| Unlink = `SCons.Action.Action(UnlinkFunc, None)`
| Mkdir = `SCons.Action.Action(MkdirFunc, None, presub= None)`
| MkdirBuilder = `False`
| _null = `_Null()`
| DefaultSCCSBuilder = `False`
| DefaultRCSBuilder = `False`
| _is_cygwin = `False`
| diskcheck_match = `<SCons.Node.FS.DiskChecker instance at 0xf1a`...``
| diskcheck_rcs = `DiskChecker('rcs', do_diskcheck_rcs, ignore_di`...``
| diskcheck_sccs = `DiskChecker('sccs', do_diskcheck_sccs, ignore`...``
| diskcheckers = `[diskcheck_match, diskcheck_rcs, diskcheck_sccs,]`
| glob_magic_check = `re.compile(r'`[`\*\?\[`]`')`
| default_fs = `False`

Function Details | [hide private]

### initialize_normpath_check() | source code
Initialize the normpath_check regular expression. This function is used by the unit tests to re-initialize the pattern when testing for behavior with different values of os.sep.

### find_file(filename, paths, verbose=False) | source code
    find_file(str, [Dir()]) -> [nodes]

    filename - a filename to find
    paths - a list of directory path *nodes* to search in.  Can be
            represented as a list, a tuple, or a callable that is
            called with no arguments and returns the list or tuple.

    returns - the node created from the found file.

    Find a node corresponding to either a derived file or a file
    that exists already.

    Only the first file found is returned, and none is returned
    if no file is found.

Variables Details | [hide private]

  ### __revision__ Value:
      'src/engine/SCons/Node/FS.py 2725 2008/03/31 12:52:02 knight'

  ### Valid_Duplicates Value:
      ['hard-soft-copy', 'soft-hard-copy', 'hard-copy', 'soft-copy', 'copy']

  ### diskcheck_match Value:
      DiskChecker('match', do_diskcheck_match, ignore_diskcheck_match)

  ### diskcheck_rcs Value:
      DiskChecker('rcs', do_diskcheck_rcs, ignore_diskcheck_rcs)

  ### diskcheck_sccs Value:
      DiskChecker('sccs', do_diskcheck_sccs, ignore_diskcheck_sccs)