twisted.python.filepath.IFilePath

interface documentation

class IFilePath(Interface): (source)

Known implementations: twisted.python.filepath.FilePath, twisted.python.zippath.ZipPath

View In Hierarchy

File path object.

A file path represents a location for a file-like-object and can be organized into a hierarchy; a file path can can children which are themselves file paths.

A file path has a name which unique identifies it in the context of its parent (if it has one); a file path can not have two children with the same name. This name is referred to as the file path's "base name".

A series of such names can be used to locate nested children of a file path; such a series is referred to as the child's "path", relative to the parent. In this case, each name in the path is referred to as a "path segment"; the child's base name is the segment in the path.

When representing a file path as a string, a "path separator" is used to delimit the path segments within the string. For a file system path, that would be os.sep.

Note that the values of child names may be restricted. For example, a file system path will not allow the use of the path separator in a name, and certain names (e.g. "." and "..") may be reserved or have special meanings.

Present Since
12.1
Method basename Retrieve the final component of the file path's path (everything after the final path separator).
Method changed Clear any cached information about the state of this path on disk.
Method child Obtain a direct child of this file path. The child may or may not exist.
Method children List the children of this path object.
Method exists Check if this file path exists.
Method getAccessTime Retrieve the time that this file was last accessed.
Method getModificationTime Retrieve the time of last access from this file.
Method getsize Retrieve the size of this file in bytes.
Method getStatusChangeTime Retrieve the time of the last status change for this file.
Method isdir Check if this file path refers to a directory.
Method isfile Check if this file path refers to a regular file.
Method open Opens this file path with the given mode.
Method parent A file path for the directory containing the file at this file path.
Method sibling A file path for the directory containing the file at this file path.
Attribute sep The path separator to use in string representations
def basename() -> Union[str, bytes]: (source)

Retrieve the final component of the file path's path (everything after the final path separator).

Returns
Union[str, bytes]the base name of this file path.
Note
In implementors, the return type should be generic, i.e. AbstractFilePath[str].basename() is a str. However, Interface objects cannot be generic as of this writing.
def changed(): (source)

Clear any cached information about the state of this path on disk.

def child(name: AnyStr) -> IFilePath: (source)

Obtain a direct child of this file path. The child may or may not exist.

Parameters
name:AnyStrthe name of a child of this path. name must be a direct child of this path and may not contain a path separator.
Returns
IFilePaththe child of this path with the given name.
Raises
InsecurePathif name describes a file path that is not a direct child of this file path.
def children() -> Iterable[IFilePath]: (source)

List the children of this path object.

Returns
Iterable[IFilePath]a sequence of the children of the directory at this file path.
Raises
Exceptionif the file at this file path is not a directory.
def exists() -> bool: (source)

Check if this file path exists.

Returns
boolTrue if the file at this file path exists, False otherwise.
def getAccessTime() -> float: (source)

Retrieve the time that this file was last accessed.

Returns
floata number of seconds from the epoch.
def getModificationTime() -> float: (source)

Retrieve the time of last access from this file.

Returns
floata number of seconds from the epoch.
def getsize() -> int: (source)

Retrieve the size of this file in bytes.

Returns
intthe size of the file at this file path in bytes.
Raises
Exceptionif the size cannot be obtained.
def getStatusChangeTime() -> float: (source)

Retrieve the time of the last status change for this file.

Returns
floata number of seconds from the epoch.
def isdir() -> bool: (source)

Check if this file path refers to a directory.

Returns
boolTrue if the file at this file path is a directory, False otherwise.
def isfile() -> bool: (source)

Check if this file path refers to a regular file.

Returns
boolTrue if the file at this file path is a regular file, False otherwise.
def open(mode: FileMode = 'r') -> IO[bytes]: (source)

Opens this file path with the given mode.

Returns
IO[bytes]a file-like object.
Raises
Exceptionif this file path cannot be opened.
def parent() -> IFilePath: (source)

A file path for the directory containing the file at this file path.

def sibling(name: AnyStr) -> IFilePath: (source)

A file path for the directory containing the file at this file path.

Parameters
name:AnyStrthe name of a sibling of this path. name must be a direct sibling of this path and may not contain a path separator.
Returns
IFilePatha sibling file path of this one.
sep = (source)

The path separator to use in string representations