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

class documentation

`class DeflatedZipFileEntry(_FileEntry): (source)`

View In Hierarchy

File-like object used to read a deflated entry in a ZipFile

Method | `__init__` | Create a `_FileEntry` from a `ChunkingZipFile`.
Method | `read` | Undocumented
Method | `tell` | Undocumented
Instance Variable | `buffer` | Undocumented
Instance Variable | `decomp` | Undocumented
Instance Variable | `finished` | Undocumented
Instance Variable | `readBytes` | Undocumented
Instance Variable | `returnedBytes` | Undocumented

Inherited from `_FileEntry`:

Method | `__enter__` | Undocumented
Method | `__exit__` | Undocumented
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 | `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 __init__(self, chunkingZipFile, length): (source)
overrides `twisted.python.zipstream._FileEntry.__init__`

Create a `_FileEntry` from a `ChunkingZipFile`.

def read(self, n=None): (source)

Undocumented

def tell(self): (source)

Undocumented

buffer: `bytes` = (source)

Undocumented

decomp = (source)

Undocumented

finished: `int` = (source)
overrides `twisted.python.zipstream._FileEntry.finished`

Undocumented

readBytes: `int` = (source)

Undocumented

returnedBytes: `int` = (source)

Undocumented