module documentation
(source)

Object-oriented filesystem path representation.
Interface IFilePath File path object.
Class AbstractFilePath Abstract implementation of an IFilePath; must be completed by a subclass.
Class FilePath I am a path on the filesystem that only permits 'downwards' access.
Class InsecurePath Error that is raised when the path provided to FilePath is invalid.
Class LinkError An error with symlinks - either that there are cyclical symlinks or that symlink are not supported on this platform.
Class Permissions A class representing read/write/execute permissions. Instantiate with any portion of the file's mode that includes the permission bits.
Class RWX A class representing read/write/execute permissions for a single user category (i.e. user/owner, group, or other/world). Instantiate with three boolean values: readable? writable? executable?.
Class UnlistableError An exception which is used to distinguish between errors which mean 'this is not a directory you can list' and other, more catastrophic errors.
Variable islink Undocumented
Function _asFilesystemBytes Return path as a string of bytes suitable for use on this system's filesystem.
Function _asFilesystemText Return path as a string of unicode suitable for use on this system's filesystem.
Function _coerceToFilesystemEncoding Return a newpath that is suitable for joining to path.
Function _secureEnoughString Compute a string usable as a new, temporary filename.
Function _stub_islink Always return False if the operating system does not support symlinks.
Variable _CREATE_FLAGS Undocumented
islink = (source)

Undocumented

def _asFilesystemBytes(path, encoding=''): (source)
Return path as a string of bytes suitable for use on this system's filesystem.
Parameters
path:bytes or unicodeThe path to be made suitable.
encoding:strThe encoding to use if coercing to bytes. If none is given, sys.getfilesystemencoding is used.
Returns
bytesbytes
def _asFilesystemText(path, encoding=None): (source)
Return path as a string of unicode suitable for use on this system's filesystem.
Parameters
path:bytes or unicodeThe path to be made suitable.
encodingThe encoding to use if coercing to unicode. If none is given, sys.getfilesystemencoding is used.
Returns
unicode
def _coerceToFilesystemEncoding(path, newpath, encoding=None): (source)
Return a newpath that is suitable for joining to path.
Parameters
pathThe path that it should be suitable for joining to.
newpathThe new portion of the path to be coerced if needed.
encodingIf coerced, the encoding that will be used.
def _secureEnoughString(path): (source)
Compute a string usable as a new, temporary filename.
Parameters
pathThe path that the new temporary filename should be able to be concatenated with.
Returns
the type of pathA pseudorandom, 16 byte string for use in secure filenames.
def _stub_islink(path): (source)
Always return False if the operating system does not support symlinks.
Parameters
path:strA path string.
Returns
boolFalse
_CREATE_FLAGS = (source)

Undocumented