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

class documentation

`class StaticProducer: (source)`

Known subclasses: `twisted.web.static.MultipleRangeStaticProducer`, `twisted.web.static.NoRangeStaticProducer`, `twisted.web.static.SingleRangeStaticProducer`

Implements interfaces: `twisted.internet.interfaces.IPullProducer`

View In Hierarchy

Superclass for classes that implement the business of producing.

Method | `__init__` | Initialize the instance.
Method | `resumeProducing` | Produce data for the consumer a single time.
Method | `start` | Undocumented
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): (source)
overridden in `twisted.web.static.MultipleRangeStaticProducer`, `twisted.web.static.SingleRangeStaticProducer`

Initialize the instance.

def resumeProducing(self): (source)
from `twisted.internet.interfaces.IPullProducer`
overridden in `twisted.web.static.MultipleRangeStaticProducer`, `twisted.web.static.NoRangeStaticProducer`, `twisted.web.static.SingleRangeStaticProducer`

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)
overridden in `twisted.web.static.MultipleRangeStaticProducer`, `twisted.web.static.NoRangeStaticProducer`, `twisted.web.static.SingleRangeStaticProducer`

Undocumented

def stopProducing(self): (source)
from `twisted.internet.interfaces.IProducer`

Stop producing data.

`twisted.internet.interfaces.IProducer.stopProducing` is called when our consumer has died, and subclasses also call this method when they are done producing data.

fileObject = (source)

The file the contents of which to write to the request.

request = (source)

The `IRequest` to write the contents of the file to.