twisted.python.filepath.AbstractFilePath(object)
class documentationtwisted.python.filepath
View Source
(View In Hierarchy)
Known subclasses: twisted.python.filepath.FilePath, twisted.python.zippath.ZipPath
Method | getContent | Retrieve the contents of the file at this path. |
Method | parents | Retrieve an iterator of all the ancestors of this path. |
Method | children | List the children of this path object. |
Method | walk | Yield myself, then each of my children, and each of those children's children in turn. |
Method | sibling | Return a FilePath with
the same directory as this instance but with a basename of
path . |
Method | descendant | Retrieve a child or child's child of this path. |
Method | segmentsFrom | Return a list of segments between a child and its ancestor. |
Method | __hash__ | Hash the same as another FilePath with
the same path as mine. |
Method | getmtime | Deprecated. Use getModificationTime instead. |
Method | getatime | Deprecated. Use getAccessTime instead. |
Method | getctime | Deprecated. Use getStatusChangeTime instead. |
Retrieve the contents of the file at this path.
Returns | the contents of the file (type: bytes ) |
Retrieve an iterator of all the ancestors of this path.
Returns | an iterator of all the ancestors of this path, from the most recent (its immediate parent) to the root of its filesystem. |
List the children of this path object.
Returns | an iterable of all currently-existing children of this object. | |
Raises | OSError | If an error occurs while listing the directory. If the error is 'serious', meaning that the operation failed due to an access violation, exhaustion of some kind of resource (file descriptors or memory), OSError or a platform-specific variant will be raised. |
UnlistableError | If the inability to list the directory is due to this path not existing or
not being a directory, the more specific OSError subclass UnlistableError
is raised instead. |
Yield myself, then each of my children, and each of those children's children in turn.
The optional argument descend
is a predicate that takes a
FilePath, and determines whether or not that FilePath is
traversed/descended into. It will be called with each path for which
isdir
returns True
. If descend
is
not specified, all directories will be traversed (including symbolic links
which refer to directories).
Parameters | descend | A one-argument callable that will return True for FilePaths that should be traversed, False otherwise. |
Returns | a generator yielding FilePath-like objects. |
Return a list of segments between a child and its ancestor.
For example, in the case of a path X representing /a/b/c/d and a path Y
representing /a/b, Y.segmentsFrom(X)
will return ['c',
'd']
.
Parameters | ancestor | an instance of the same class as self, ostensibly an ancestor of self. |
Returns | a list of strs | |
Raises | ValueError if the 'ancestor' parameter is not actually an ancestor, i.e. a path for /x/y/z is passed as an ancestor for /a/b/c/d. |