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`.`distrib`.`Request``

class documentation

`class Request(pb.RemoteCopy, server.Request): (source)`

Constructor: `Request(*args, **kw)`

View In Hierarchy

A request which was received by a `ResourceSubscription` and sent via PB to a distributed node.

Method | `fail` | Undocumented
Method | `registerProducer` | Register a producer.
Method | `setCopyableState` | Initialize this `twisted.web.distrib.Request` based on the copied state so that it closely resembles a `twisted.web.server.Request`.
Method | `unregisterProducer` | Unregister the producer.
Method | `write` | Write the given bytes to the response body.
Instance Variable | `content` | A file-like object giving the request body. This may be a file on disk, an `io.BytesIO`, or some other type. The implementation is free to decide on a per-request basis.
Instance Variable | `_write` | Undocumented

Inherited from `RemoteCopy`:

Method | `unjellyFor` | Perform the inverse operation of `Jellyable.jellyFor`.
Instance Variable | `__dict__` | Undocumented

Inherited from `Unjellyable` (via `RemoteCopy`):

Method | `setStateFor` | Undocumented

Inherited from `Request` (via `RemoteCopy`, `Unjellyable`):

Method | `__init__` | No summary
Method | `childLink` | Return the text that links to a child of the requested resource.
Method | `finish` | Override `http.Request.finish` for possible encoding.
Method | `getRootURL` | Get a previously-remembered URL.
Method | `getSession` | Check if there is a session cookie, and if not, create it.
Method | `getStateToCopyFor` | Gather state to send when I am serialized for a particular perspective.
Method | `gotLength` | Called when HTTP channel got length of content in this request.
Method | `prePathURL` | At any time during resource traversal or resource rendering, returns an absolute URL to the most nested resource which has yet been reached.
Method | `process` | Process a request.
Method | `processingFailed` | Finish this request with an indication that processing failed and possibly display a traceback.
Method | `rememberRootURL` | Remember the currently-processed part of the URL for later recalling.
Method | `render` | Ask a resource to render itself.
Method | `sibLink` | Return the text that links to a sibling of the requested resource.
Method | `URLPath` | No summary
Method | `view_addCookie` | Remote version of addCookie; same interface.
Method | `view_finish` | Remote version of finish; same interface.
Method | `view_registerProducer` | Remote version of registerProducer; same interface. (requires a remote producer.)
Method | `view_setETag` | Remote version of setETag; same interface.
Method | `view_setHeader` | Remote version of setHeader; same interface.
Method | `view_setLastModified` | Remote version of setLastModified; same interface.
Method | `view_setResponseCode` | Remote version of setResponseCode; same interface.
Method | `view_unregisterProducer` | Undocumented
Method | `view_write` | Remote version of write; same interface.
Class Variable | `__pychecker__` | Undocumented
Instance Variable | `appRootURL` | Undocumented
Instance Variable | `defaultContentType` | A `bytes` giving the default Content-Type value to send in responses if no other value is set. `None` disables the default.
Instance Variable | `postpath` | The URL path segments which have not (yet) been processed during resource traversal, as a list of `bytes`.
Instance Variable | `prepath` | The URL path segments which have been processed during resource traversal, as a list of `bytes`.
Instance Variable | `site` | Undocumented
Property | `session` | If a session has already been created or looked up with `Request.getSession`, this will return that object. (This will always be the session that matches the security of the request; so if `forceNotSecure`...
Method | `_handleStar` | Handle receiving a request whose path is '*'.
Method | `_prePathURL` | Undocumented
Class Variable | `_inFakeHead` | Undocumented
Instance Variable | `_encoder` | Undocumented
Instance Variable | `_insecureSession` | The `Session` object representing state that will be transmitted over plain-text HTTP.
Instance Variable | `_log` | Undocumented
Instance Variable | `_secureSession` | The `Session` object representing the state that will be transmitted only over HTTPS.

Inherited from `Copyable` (via `RemoteCopy`, `Unjellyable`, `Request`):

Method | `getStateToCopy` | Gather state to send when I am serialized for a peer.
Method | `getTypeToCopy` | Determine what type tag to send for me.
Method | `getTypeToCopyFor` | Determine what type tag to send for me.
Method | `jellyFor` | Assemble type tag and state to copy for this broker.

Inherited from `Serializable` (via `RemoteCopy`, `Unjellyable`, `Request`, `Copyable`):

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `RemoteCopy`, `Unjellyable`, `Request`, `Copyable`, `Serializable`):

Method | `getStateFor` | Undocumented

Inherited from `Request` (via `RemoteCopy`, `Unjellyable`, `Request`, `Copyable`, `Serializable`, `Jellyable`):

Method | `__eq__` | Determines if two requests are the same object.
Method | `__hash__` | A `Request` is hashable so that it can be used as a mapping key.
Method | `__repr__` | Return a string description of the request including such information as the request method and request URI.
Method | `addCookie` | Set an outgoing HTTP cookie.
Method | `connectionLost` | There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore.
Method | `getAllHeaders` | Return dictionary mapping the names of all received headers to the last value received for each.
Method | `getClientAddress` | Return the address of the client who submitted this request.
Method | `getClientIP` | Return the IP address of the client who submitted this request.
Method | `getCookie` | Get a cookie that was sent from the network.
Method | `getHeader` | Get an HTTP request header.
Method | `getHost` | Get my originally requesting transport's host.
Method | `getPassword` | Return the HTTP password sent with this request, if any.
Method | `getRequestHostname` | Get the hostname that the HTTP client passed in to the request.
Method | `getUser` | Return the HTTP user sent with this request, if any.
Method | `handleContentChunk` | Write a chunk of data.
Method | `isSecure` | Return `True` if this request is using a secure transport.
Method | `loseConnection` | Pass the loseConnection through to the underlying channel.
Method | `noLongerQueued` | Notify the object that it is no longer queued.
Method | `notifyFinish` | Notify when the response to this request has finished.
Method | `parseCookies` | Parse cookie headers.
Method | `redirect` | Utility function that does a redirect.
Method | `requestReceived` | Called by channel when all data has been received.
Method | `setETag` | Set an `entity tag` for the outgoing response.
Method | `setHeader` | Set an HTTP response header. Overrides any previously set values for this header.
Method | `setHost` | Change the host and port the request thinks it's using.
Method | `setLastModified` | Set the `Last-Modified` time for the response to this request.
Method | `setResponseCode` | Set the HTTP response code.
Instance Variable | `args` | A mapping of decoded query argument names as `bytes` to corresponding query argument values as `list`s of `bytes`. For example, for a URI with `foo=bar&foo=baz&quux=spam` as its query part `args` will be `{b'foo': [b'bar', b'baz'], b'quux': [b'spam']}`...
Instance Variable | `channel` | Undocumented
Instance Variable | `chunked` | Undocumented
Instance Variable | `client` | Undocumented
Instance Variable | `clientproto` | Undocumented
Instance Variable | `code` | Undocumented
Instance Variable | `code_message` | Undocumented
Instance Variable | `cookies` | The cookies that will be sent in the response.
Instance Variable | `etag` | Undocumented
Instance Variable | `finished` | Undocumented
Instance Variable | `host` | Undocumented
Instance Variable | `lastModified` | Undocumented
Instance Variable | `method` | The HTTP method that was used, e.g. `b'GET'`.
Instance Variable | `notifications` | A `list` of `Deferred`s which are waiting for notification that the response to this request has been finished (successfully or with an error). Don't use this attribute directly, instead use the `Request.notifyFinish`...
Instance Variable | `password` | Undocumented
Instance Variable | `path` | The encoded path of the request URI (not including query arguments), e.g. `b'/a/b%20/c'`.
Instance Variable | `producer` | Undocumented
Instance Variable | `queued` | Undocumented
Instance Variable | `received_cookies` | Undocumented
Instance Variable | `requestHeaders` | All received HTTP request headers.
Instance Variable | `responseHeaders` | All HTTP response headers to be sent.
Instance Variable | `sentLength` | Undocumented
Instance Variable | `startedWriting` | Undocumented
Instance Variable | `streamingProducer` | Undocumented
Instance Variable | `transport` | Undocumented
Instance Variable | `uri` | The full encoded URI which was requested (including query arguments), e.g. `b'/a/b%20/c?q=v'`.
Instance Variable | `user` | Undocumented
Method | `_authorize` | Undocumented
Method | `_cleanup` | Called when have finished responding and are no longer queued.
Instance Variable | `_disconnected` | A flag which is `False` until the connection over which this request was received is closed and which is `True` after that.
Instance Variable | `_forceSSL` | Undocumented

Inherited from `Componentized` (via `RemoteCopy`, `Unjellyable`, `Request`, `Copyable`, `Serializable`, `Jellyable`, `Request`):

Method | `__conform__` | Undocumented
Method | `addAdapter` | Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method | `addComponent` | Add a component to me, for all appropriate interfaces.
Method | `getComponent` | Create or retrieve an adapter for the given interface.
Method | `locateAdapterClass` | Undocumented
Method | `removeComponent` | Remove the given component from me entirely, for all interfaces for which it has been registered.
Method | `setAdapter` | Cache a provider for the given interface, by adapting `self` using the given adapter class.
Method | `setComponent` | Cache a provider of the given interface.
Method | `unsetComponent` | Remove my component specified by the given interface class.
Class Variable | `persistenceVersion` | Undocumented
Instance Variable | `_adapterCache` | Undocumented

def fail(self, failure): (source)

Undocumented

def registerProducer(self, producer, streaming): (source)
from `twisted.internet.interfaces.IConsumer`
overrides `twisted.web.http.Request.registerProducer`

Register a producer.

def setCopyableState(self, state): (source)
overrides `twisted.spread.pb.RemoteCopy.setCopyableState`

Initialize this `twisted.web.distrib.Request` based on the copied state so that it closely resembles a `twisted.web.server.Request`.

def unregisterProducer(self): (source)
from `twisted.internet.interfaces.IConsumer`
overrides `twisted.web.http.Request.unregisterProducer`

Unregister the producer.

def write(self, bytes): (source)
from `twisted.web.iweb.IRequest`
overrides `twisted.web.server.Request.write`

Write the given bytes to the response body.

Parameters
bytes | The bytes to write. If this is longer than 640k, it will be split up into smaller pieces.

content = (source)
from `twisted.web.iweb.IRequest`
overrides `twisted.web.http.Request.content`

A file-like object giving the request body. This may be a file on disk, an `io.BytesIO`, or some other type. The implementation is free to decide on a per-request basis.

_write = (source)

Undocumented