Package SCons :: Package Node :: Module FS

Module FS

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]

FileBuildInfoFileToCsigMappingError

EntryProxyAttributeError
An AttributeError subclass for recording and displaying the name of the underlying Entry involved in an AttributeError exception.

_Null

DiskChecker

EntryProxy

Base
A generic class for file system entries. This class is for when we don't know yet whether the entry being looked up is a file or a directory. Instances of this class can morph into either Dir or File objects by a later, more precise lookup.

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.

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

LocalFS
This class implements an abstraction layer for operations involving a local file system. Essentially, this wraps any function in the os, os.path or shutil modules that we use to actually go do anything with or to the local file system.

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
This is info loaded from sconsign.

File
A class for files in a file system.

FileFinder

Functions

[hide private]

sconsign_none(node)

source code

sconsign_dir(node)
Return the .sconsign file info for this directory, creating it first if necessary.

source code

save_strings(val)

source code

_my_splitdrive(p)

source code

initialize_do_splitdrive()

source code

needs_normpath_match(...)
match(string[, pos[, endpos]]) --> match object or None. Matches zero or more characters at the beginning of the string

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)
Relative paths cause problems with symbolic links, so we use absolute paths, which may be a problem for people who want to move their soft-linked src-trees around. Those people should use the 'hard-copy' mode, softlinks cannot be used for that; at least I have no idea how ...

source code

LocalString(target, source, env)

source code

UnlinkFunc(target, source, env)

source code

MkdirFunc(target, source, env)

source code

get_MkdirBuilder()

source code

_my_normcase(x)

source code

do_diskcheck_match(node, predicate, errorfmt)

source code

ignore_diskcheck_match(node, predicate, errorfmt)

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=None)
Find a node corresponding to either a derived file or a file that exists already.

source code

invalidate_node_memos(targets)
Invalidate the memoized values of all Nodes (files or directories) that are associated with the given entries. Has been added to clear the cache of nodes affected by a direct execution of an action (e.g. Delete/Copy/Chmod). Existing Node caches become inconsistent if the action is run through Execute(). The argument targets can be a single Node object or filename, or a sequence of Nodes/filenames. source code

Variables

[hide private]

__revision__ = 'src/engine/SCons/Node/FS.py 3a41ed6b288cee8d08...

print_duplicate = 0

_sconsign_map = {0: <__builtin__.function object>, 1: <__built...

default_max_drift = 172800

Save_Strings = None
hash(x)

do_splitdrive = False

needs_normpath_check = re.compile(r'(?x).*//|(.*/)?\.\.(?:/|$)...

Valid_Duplicates = ['hard-soft-copy', 'soft-hard-copy', 'hard-...

Link_Funcs = []

Link = <SCons.Action.FunctionAction object>

LocalCopy = <SCons.Action.FunctionAction object>

Unlink = <SCons.Action.FunctionAction object>

Mkdir = <SCons.Action.FunctionAction object>

MkdirBuilder = None
hash(x)

_null = <SCons.Node.FS._Null object>

_is_cygwin = False

diskcheck_match = <SCons.Node.FS.DiskChecker object>

diskcheckers = [<SCons.Node.FS.DiskChecker object>]

node_bwcomp = {'abspath': <unbound method Base.get_abspath>, '...

glob_magic_check = re.compile(r'[\*\?\[]')

default_fs = None
hash(x)

OS_SEP = '/'

UNC_PREFIX = '//'

__package__ = 'SCons.Node'

has_unc = False

os_sep_is_slash = True

Function Details

[hide private]

find_file(filename, paths, verbose=None)

source code

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.

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.

Variables Details

[hide private]

revision

Value:

'src/engine/SCons/Node/FS.py 3a41ed6b288cee8d085373ad7fa02894e1903864 
2019-01-23 17:30:35 bdeegan'

_sconsign_map

Value:

{0: <__builtin__.function object>, 1: <__builtin__.function object>}

needs_normpath_check

Value:

re.compile(r'(?x).*//|(.*/)?\.\.(?:/|$)|\./|.*/\.(?:/|$)')

Valid_Duplicates

Value:

['hard-soft-copy', 'soft-hard-copy', 'hard-copy', 'soft-copy', 'copy']

node_bwcomp

Value:

{'abspath': <unbound method Base.get_abspath>,
 'labspath': <unbound method Base.get_labspath>,
 'path': <unbound method Base.get_internal_path>,
 'path_elements': <unbound method Base.get_path_elements>,
 'suffix': <unbound method Base.get_suffix>,
 'tpath': <unbound method Base.get_tpath>}