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`.`wsgi`.`WSGIResource``

class documentation

`class WSGIResource: (source)`

Constructor: `WSGIResource(reactor, threadpool, application)`

Implements interfaces: `twisted.web.resource.IResource`

View In Hierarchy

An `IResource` implementation which delegates responsibility for all resources hierarchically inferior to it to a WSGI application.

Method | `__init__` | Undocumented
Method | `getChildWithDefault` | Reject attempts to retrieve a child resource. All path segments beyond the one which refers to this resource are handled by the WSGI application object.
Method | `putChild` | Reject attempts to add a child resource to this resource. The WSGI application object handles all path segments beneath this resource, so `IResource` children can never be found.
Method | `render` | Turn the request into the appropriate `environ` `dict` suitable to be passed to the WSGI application object and then pass it on.
Class Variable | `isLeaf` | Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.
Instance Variable | `_application` | The WSGI application object.
Instance Variable | `_reactor` | An `IReactorThreads` provider which will be passed on to `_WSGIResponse` to schedule calls in the I/O thread.
Instance Variable | `_threadpool` | A `ThreadPool` which will be passed on to `_WSGIResponse` to run the WSGI application object.

def __init__(self, reactor, threadpool, application): (source)

Undocumented

def getChildWithDefault(self, name, request): (source)
from `twisted.web.resource.IResource`

Reject attempts to retrieve a child resource. All path segments beyond the one which refers to this resource are handled by the WSGI application object.

def putChild(self, path, child): (source)
from `twisted.web.resource.IResource`

Reject attempts to add a child resource to this resource. The WSGI application object handles all path segments beneath this resource, so `IResource` children can never be found.

def render(self, request): (source)
from `twisted.web.resource.IResource`

Turn the request into the appropriate `environ` `dict` suitable to be passed to the WSGI application object and then pass it on.

The WSGI application object is given almost complete control of the rendering process. `NOT_DONE_YET` will always be returned in order and response completion will be dictated by the application object, as will the status, headers, and the response body.

isLeaf: `bool` = (source)
from `twisted.web.resource.IResource`

Signal if this IResource implementor is a "leaf node" or not. If True, getChildWithDefault will not be called on this Resource.

_application = (source)

The WSGI application object.

_reactor = (source)

An `IReactorThreads` provider which will be passed on to `_WSGIResponse` to schedule calls in the I/O thread.

_threadpool = (source)

A `ThreadPool` which will be passed on to `_WSGIResponse` to run the WSGI application object.