Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`python`.`zippath`.`ZipArchive``

class documentation

`class ZipArchive(ZipPath): (source)`

View In Hierarchy

I am a `FilePath`-like object which can wrap a zip archive as if it were a directory.

It works similarly to `FilePath` in `bytes` and `unicode` handling -- instantiating with a `bytes` will return a "bytes mode" `ZipArchive`, and instantiating with a `unicode` will return a "text mode" `ZipArchive`. Methods that return new `ZipArchive` or `ZipPath` instances will be in the mode of the argument to the creator method, converting if required.

Method | `__init__` | Create a ZipArchive, treating the archive at archivePathname as a zip file.
Method | `__repr__` | Undocumented
Method | `child` | Create a ZipPath pointing at a path within the archive.
Method | `exists` | Returns `True` if the underlying archive exists.
Method | `getAccessTime` | Return the archive file's last access time.
Method | `getModificationTime` | Return the archive file's modification time.
Method | `getStatusChangeTime` | Return the archive file's status change time.
Instance Variable | `childmap` | Undocumented
Instance Variable | `path` | Undocumented
Instance Variable | `pathInArchive` | Undocumented
Instance Variable | `zipfile` | Undocumented
Property | `archive` | Undocumented

Inherited from `ZipPath`:

Method | `__cmp__` | Undocumented
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 | `dirname` | Undocumented
Method | `getsize` | Retrieve this file's size.
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 | `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` | Return a `FilePath` with the same directory as this instance but with a basename of `path`.
Method | `splitext` | Return a value similar to that returned by `os.path.splitext`.
Property | `sep` | Return a zip directory separator.

Inherited from `AbstractFilePath` (via `ZipPath`):

Method | `__hash__` | Hash the same as another `FilePath` with the same path as mine.
Method | `children` | List the children of this path object.
Method | `descendant` | Retrieve a child or child's child of this path.
Method | `getatime` | Deprecated. Use getAccessTime instead.
Method | `getContent` | Retrieve the contents of the file at this path.
Method | `getctime` | Deprecated. Use getStatusChangeTime instead.
Method | `getmtime` | Deprecated. Use getModificationTime instead.
Method | `parents` | Retrieve an iterator of all the ancestors of this path.
Method | `segmentsFrom` | Return a list of segments between a child and its ancestor.
Method | `walk` | Yield myself, then each of my children, and each of those children's children in turn.

def __init__(self, archivePathname): (source)
overrides `twisted.python.zippath.ZipPath.__init__`

Create a ZipArchive, treating the archive at archivePathname as a zip file.

Parameters
archivePathname | a `bytes` or `unicode`, naming a path in the filesystem.

def __repr__(self): (source)
overrides `twisted.python.zippath.ZipPath.__repr__`

Undocumented

Returns
`str` | Undocumented

def child(self, path): (source)
from `twisted.python.filepath.IFilePath`
overrides `twisted.python.zippath.ZipPath.child`

Create a ZipPath pointing at a path within the archive.

Parameters
path | a `bytes` or `unicode` with no path separators in it (either '/' or the system path separator, if it's different).

def exists(self): (source)
from `twisted.python.filepath.IFilePath`
overrides `twisted.python.zippath.ZipPath.exists`

Returns `True` if the underlying archive exists.

def getAccessTime(self): (source)
from `twisted.python.filepath.IFilePath`
overrides `twisted.python.zippath.ZipPath.getAccessTime`

Return the archive file's last access time.

def getModificationTime(self): (source)
from `twisted.python.filepath.IFilePath`
overrides `twisted.python.zippath.ZipPath.getModificationTime`

Return the archive file's modification time.

def getStatusChangeTime(self): (source)
from `twisted.python.filepath.IFilePath`
overrides `twisted.python.zippath.ZipPath.getStatusChangeTime`

Return the archive file's status change time.

childmap: `Dict[str, Dict[str, int]]` = (source)

Undocumented

path = (source)
overrides `twisted.python.zippath.ZipPath.path`

Undocumented

pathInArchive = (source)
overrides `twisted.python.zippath.ZipPath.pathInArchive`

Undocumented

zipfile = (source)

Undocumented

@property
archive = (source)
overrides `twisted.python.zippath.ZipPath.archive`

Undocumented