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`.`web`.`static`.`SingleRangeStaticProducer``

class documentation

`class SingleRangeStaticProducer(StaticProducer): (source)`

View In Hierarchy

A `StaticProducer` that writes a single chunk of a file to the request.

Method | `__init__` | Initialize the instance.
Method | `resumeProducing` | Produce data for the consumer a single time.
Method | `start` | Undocumented
Instance Variable | `bytesWritten` | Undocumented
Instance Variable | `offset` | Undocumented
Instance Variable | `size` | Undocumented

Inherited from `StaticProducer`:

Method | `stopProducing` | Stop producing data.
Instance Variable | `fileObject` | The file the contents of which to write to the request.
Instance Variable | `request` | The `IRequest` to write the contents of the file to.

def __init__(self, request, fileObject, offset, size): (source)
overrides `twisted.web.static.StaticProducer.__init__`

Initialize the instance.

Parameters
request | See `StaticProducer`.
fileObject | See `StaticProducer`.
offset | The offset into the file of the chunk to be written.
size | The size of the chunk to write.

def resumeProducing(self): (source)
from `twisted.internet.interfaces.IPullProducer`
overrides `twisted.web.static.StaticProducer.resumeProducing`

Produce data for the consumer a single time.

This tells a producer to produce data for the consumer once (not repeatedly, once only). Typically this will be done by calling the consumer's `write` method a single time with produced data. The producer should produce data before returning from `resumeProducing()`, that is, it should not schedule a deferred write.

def start(self): (source)
overrides `twisted.web.static.StaticProducer.start`

Undocumented

bytesWritten: `int` = (source)

Undocumented

offset = (source)

Undocumented

size = (source)

Undocumented