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`.`zipstream`.`_FileEntry``

class documentation

`class _FileEntry: (source)`

Known subclasses: `twisted.python.zipstream.DeflatedZipFileEntry`, `twisted.python.zipstream.ZipFileEntry`

View In Hierarchy

Abstract superclass of both compressed and uncompressed variants of file-like objects within a zip archive.

Method | `__enter__` | Undocumented
Method | `__exit__` | Undocumented
Method | `__init__` | Create a `_FileEntry` from a `ChunkingZipFile`.
Method | `__iter__` | Returns an iterator (so self)
Method | `__next__` | Implement next as file does (like readline, except raises StopIteration at EOF)
Method | `close` | Close self (file-like object)
Method | `isatty` | Returns false because zip files should not be ttys
Method | `readline` | Read a line.
Method | `readlines` | Returns a list of all the lines
Method | `xreadlines` | Returns an iterator (so self)
Instance Variable | `chunkingZipFile` | a chunking zip file.
Instance Variable | `closed` | File-like 'closed' attribute; True before this file has been closed, False after.
Instance Variable | `finished` | An older, broken synonym for 'closed'. Do not touch this, please.
Instance Variable | `fp` | the underlying file object (that contains pkzip data). Do not touch this, please. It will quite likely move or go away.
Instance Variable | `length` | The number of bytes within the zip file that represent this file. (This is the size on disk, not the number of decompressed bytes which will result from reading it.)

def __enter__(self): (source)

Undocumented

def __exit__(self, exc_type, exc_value, traceback): (source)

Undocumented

def __init__(self, chunkingZipFile, length): (source)
overridden in `twisted.python.zipstream.DeflatedZipFileEntry`, `twisted.python.zipstream.ZipFileEntry`

Create a `_FileEntry` from a `ChunkingZipFile`.

def __iter__(self): (source)

Returns an iterator (so self)

def __next__(self): (source)

Implement next as file does (like readline, except raises StopIteration at EOF)

def close(self): (source)

Close self (file-like object)

def isatty(self): (source)

Returns false because zip files should not be ttys

def readline(self): (source)

Read a line.

def readlines(self): (source)

Returns a list of all the lines

def xreadlines(self): (source)

Returns an iterator (so self)

chunkingZipFile: `ChunkingZipFile` = (source)

a chunking zip file.

closed: `bool` = (source)

File-like 'closed' attribute; True before this file has been closed, False after.

finished: `int` = (source)
overridden in `twisted.python.zipstream.DeflatedZipFileEntry`, `twisted.python.zipstream.ZipFileEntry`

An older, broken synonym for 'closed'. Do not touch this, please.

fp = (source)

the underlying file object (that contains pkzip data). Do not touch this, please. It will quite likely move or go away.

length = (source)

The number of bytes within the zip file that represent this file. (This is the size on disk, not the number of decompressed bytes which will result from reading it.)