twisted.python.zippath.ZipPath : API documentation

class documentation

class twisted.python.zippath.ZipPath(AbstractFilePath): (source)

Known subclasses: twisted.python.zippath.ZipArchive

Implements interfaces: twisted.python.filepath.IFilePath

I represent a file or directory contained within a zip file.

Method	__init__	Don't construct me directly. Use `ZipArchive.child()`.
Instance Variable	archive	Undocumented
Instance Variable	pathInArchive	Undocumented
Instance Variable	path	Undocumented
Method	__cmp__	Undocumented
Method	__repr__	Undocumented
Property	sep	Return a zip directory separator.
Method	parent	A file path for the directory containing the file at this file path.
Method	child	Return a new ZipPath representing a path in `self.archive` which is a child of this path.
Method	sibling	Return a `FilePath` with the same directory as this instance but with a basename of `path`.
Method	exists	Check if this file path exists.
Method	isdir	Check if this file path refers to a directory.
Method	isfile	Check if this file path refers to a regular file.
Method	islink	Undocumented
Method	listdir	Undocumented
Method	splitext	Return a value similar to that returned by `os.path.splitext`.
Method	basename	Retrieve the final component of the file path's path (everything after the final path separator).
Method	dirname	Undocumented
Method	open	Opens this file path with the given mode.
Method	changed	Clear any cached information about the state of this path on disk.
Method	getsize	Retrieve this file's size.
Method	getAccessTime	Retrieve this file's last access-time. This is the same as the last access time for the archive.
Method	getModificationTime	Retrieve this file's last modification time. This is the time of modification recorded in the zipfile.
Method	getStatusChangeTime	Retrieve this file's last modification time. This name is provided for compatibility, and returns the same value as getmtime.

Inherited from AbstractFilePath:

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

def __init__(self, archive, pathInArchive): (source)

overridden in twisted.python.zippath.ZipArchive

Don't construct me directly. Use ZipArchive.child().

Parameters	archive	a `ZipArchive` instance.
	pathInArchive	a ZIP_PATH_SEP-separated string.

archive = (source)

overridden in twisted.python.zippath.ZipArchive

Undocumented

pathInArchive = (source)

overridden in twisted.python.zippath.ZipArchive

Undocumented

path = (source)

overridden in twisted.python.zippath.ZipArchive

Undocumented

def __cmp__(self, other): (source)

Undocumented

def __repr__(self): (source)

overridden in twisted.python.zippath.ZipArchive

Undocumented

Returns Undocumented (type: str)

@property
sep = (source)

from twisted.python.filepath.IFilePath

Return a zip directory separator.

Returns Undocumented (type: The same type as self.path.)

def parent(self): (source)

from twisted.python.filepath.IFilePath

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

def child(self, path): (source)

from twisted.python.filepath.IFilePath

overridden in twisted.python.zippath.ZipArchive

Return a new ZipPath representing a path in self.archive which is a child of this path.

Note Requesting the ".." (or other special name) child will not cause InsecurePath to be raised since these names do not have any special meaning inside a zip archive. Be particularly careful with the path attribute (if you absolutely must use it) as this means it may include special names with special meaning outside of the context of a zip archive.

def sibling(self, path): (source)

from twisted.python.filepath.IFilePath

overrides twisted.python.filepath.AbstractFilePath.sibling

Return a FilePath with the same directory as this instance but with a basename of path.

Parameters	path	The basename of the `FilePath` to return. (type: `str`)
Returns	The sibling path. (type: `FilePath`)

def exists(self): (source)

from twisted.python.filepath.IFilePath

overridden in twisted.python.zippath.ZipArchive

Check if this file path exists.

Returns True if the file at this file path exists, False otherwise. (type: bool)

def isdir(self): (source)

from twisted.python.filepath.IFilePath

Check if this file path refers to a directory.

Returns True if the file at this file path is a directory, False otherwise.

def isfile(self): (source)

from twisted.python.filepath.IFilePath

Check if this file path refers to a regular file.

Returns True if the file at this file path is a regular file, False otherwise.

def islink(self): (source)

Undocumented

def listdir(self): (source)

Undocumented

def splitext(self): (source)

Return a value similar to that returned by os.path.splitext.

def basename(self): (source)

from twisted.python.filepath.IFilePath

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

Returns the base name of this file path. (type: str)

def dirname(self): (source)

Undocumented

def open(self, mode='r'): (source)

from twisted.python.filepath.IFilePath

Opens this file path with the given mode.

Returns	a file-like object.
Raises	Exception	if this file path cannot be opened.

def changed(self): (source)

from twisted.python.filepath.IFilePath

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

def getsize(self): (source)

from twisted.python.filepath.IFilePath

Retrieve this file's size.

Returns file size, in bytes

def getAccessTime(self): (source)

from twisted.python.filepath.IFilePath

overridden in twisted.python.zippath.ZipArchive

Retrieve this file's last access-time. This is the same as the last access time for the archive.

Returns a number of seconds since the epoch

def getModificationTime(self): (source)

from twisted.python.filepath.IFilePath

overridden in twisted.python.zippath.ZipArchive

Retrieve this file's last modification time. This is the time of modification recorded in the zipfile.

Returns a number of seconds since the epoch.

def getStatusChangeTime(self): (source)

from twisted.python.filepath.IFilePath

overridden in twisted.python.zippath.ZipArchive

Retrieve this file's last modification time. This name is provided for compatibility, and returns the same value as getmtime.

Returns a number of seconds since the epoch.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.