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

module documentation
(source)

Interface definitions for `twisted.web`.

Interface | `IAccessLogFormatter` | An object which can represent an HTTP request as a line of text for inclusion in an access log file.
Interface | `IAgent` | An agent makes HTTP requests.
Interface | `IAgentEndpointFactory` | An `IAgentEndpointFactory` provides a way of constructing an endpoint used for outgoing Agent requests. This is useful in the case of needing to proxy outgoing connections, or to otherwise vary the transport used.
Interface | `IBodyProducer` | Objects which provide `IBodyProducer` write bytes to an object which provides `IConsumer` by calling its `write` method repeatedly.
Interface | `IClientRequest` | An object representing an HTTP request to make to an HTTP server.
Interface | `ICredentialFactory` | A credential factory defines a way to generate a particular kind of authentication challenge and a way to interpret the responses to these challenges. It creates `ICredentials` providers from responses. ...
Interface | `INonQueuedRequestFactory` | A factory of `IRequest` objects that does not take a ``queued`` parameter.
Interface | `IPolicyForHTTPS` | An `IPolicyForHTTPS` provides a policy for verifying the certificates of HTTPS connections, in the form of a `client connection creator` per network location.
Interface | `IRenderable` | An `IRenderable` is an object that may be rendered by the `twisted.web.template` templating system.
Interface | `IRequest` | An HTTP request.
Interface | `IResponse` | An object representing an HTTP response received from an HTTP server.
Interface | `ITemplateLoader` | A loader for templates; something usable as a value for `twisted.web.template.Element`'s `loader` attribute.
Interface | `IUsernameDigestHash` | This credential is used when a CredentialChecker has access to the hash of the username:realm:password as in an Apache .htdigest file.
Constant | `UNKNOWN_LENGTH` | An opaque object which may be used as the value of `IBodyProducer.length` to indicate that the length of the entity body is not known in advance.
Interface | `_IRequestEncoder` | An object encoding data passed to `IRequest.write`, for example for compression purpose.
Interface | `_IRequestEncoderFactory` | A factory for returing `_IRequestEncoder` instances.

UNKNOWN_LENGTH: `str` = (source)

An opaque object which may be used as the value of `IBodyProducer.length` to indicate that the length of the entity body is not known in advance.

Value

    'twisted.web.iweb.UNKNOWN_LENGTH'