class Request(pb.RemoteCopy, server.Request): (source)
A request which was received by a ResourceSubscription
and sent via PB to a distributed node.
Method | setCopyableState |
Initialize this twisted.web.distrib.Request based on the copied state so that it closely resembles a twisted.web.server.Request . |
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. |
Method | write |
Write the given bytes to the response body. |
Method | registerProducer |
Register a producer. |
Method | unregisterProducer |
Unregister the producer. |
Method | fail |
Undocumented |
Instance Variable | _write |
Undocumented |
Inherited from RemoteCopy
:
Instance Variable | __dict__ |
Undocumented |
Method | unjellyFor |
Perform the inverse operation of Jellyable.jellyFor . |
Inherited from Unjellyable
(via RemoteCopy
):
Method | setStateFor |
Undocumented |
Inherited from Request
:
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 | site |
Undocumented |
Instance Variable | appRootURL |
Undocumented |
Instance Variable | prepath |
The URL path segments which have been processed during resource traversal, as a list of bytes . |
Instance Variable | postpath |
The URL path segments which have not (yet) been processed during resource traversal, as a list of bytes . |
Class Variable | __pychecker__ |
Undocumented |
Method | __init__ |
|
Method | getStateToCopyFor |
Gather state to send when I am serialized for a particular perspective. |
Method | sibLink |
Return the text that links to a sibling of the requested resource. |
Method | childLink |
Return the text that links to a child of the requested resource. |
Method | gotLength |
Called when HTTP channel got length of content in this request. |
Method | process |
Process a request. |
Method | finish |
Override http.Request.finish for possible encoding. |
Method | render |
Ask a resource to render itself. |
Instance Variable | method |
A bytes giving the HTTP method that was used. |
Method | processingFailed |
Finish this request with an indication that processing failed and possibly display a traceback. |
Method | view_write |
Remote version of write; same interface. |
Method | view_finish |
Remote version of finish; same interface. |
Method | view_addCookie |
Remote version of addCookie; same interface. |
Method | view_setHeader |
Remote version of setHeader; same interface. |
Method | view_setLastModified |
Remote version of setLastModified; same interface. |
Method | view_setETag |
Remote version of setETag; same interface. |
Method | view_setResponseCode |
Remote version of setResponseCode; same interface. |
Method | view_registerProducer |
Remote version of registerProducer; same interface. (requires a remote producer.) |
Method | view_unregisterProducer |
Undocumented |
Property | session |
No summary |
Method | getSession |
Check if there is a session cookie, and if not, create it. |
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 | URLPath |
|
Method | rememberRootURL |
Remember the currently-processed part of the URL for later recalling. |
Method | getRootURL |
Get a previously-remembered URL. |
Instance Variable | _insecureSession |
The Session object representing state that will be transmitted over plain-text HTTP. |
Instance Variable | _secureSession |
The Session object representing the state that will be transmitted only over HTTPS. |
Instance Variable | _inFakeHead |
Undocumented |
Instance Variable | _encoder |
Undocumented |
Class Variable | _log |
Undocumented |
Method | _prePathURL |
Undocumented |
Method | _handleStar |
Handle receiving a request whose path is '*'. |
Inherited from Copyable
(via 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 Request
, Copyable
):
Method | processUniqueID |
Return an ID which uniquely represents this object for this process. |
Inherited from Jellyable
(via Request
, Copyable
, Serializable
):
Method | getStateFor |
Undocumented |
Inherited from Request
(via Request
):
Instance Variable | uri |
The full encoded URI which was requested (including query arguments), e.g. b'/a/b%20/c?q=v' . |
Instance Variable | path |
The encoded path of the request URI (not including query arguments), e.g. b'/a/b%20/c' . |
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 | cookies |
The cookies that will be sent in the response. |
Instance Variable | requestHeaders |
All received HTTP request headers. |
Instance Variable | responseHeaders |
All HTTP response headers to be sent. |
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 method. |
Instance Variable | producer |
Undocumented |
Instance Variable | finished |
Undocumented |
Instance Variable | code_message |
Undocumented |
Instance Variable | clientproto |
Undocumented |
Instance Variable | startedWriting |
Undocumented |
Instance Variable | chunked |
Undocumented |
Instance Variable | sentLength |
Undocumented |
Instance Variable | etag |
Undocumented |
Instance Variable | lastModified |
Undocumented |
Instance Variable | channel |
Undocumented |
Instance Variable | client |
Undocumented |
Instance Variable | host |
Undocumented |
Instance Variable | received_cookies |
Undocumented |
Instance Variable | transport |
Undocumented |
Instance Variable | queued |
Undocumented |
Method | noLongerQueued |
Notify the object that it is no longer queued. |
Method | parseCookies |
Parse cookie headers. |
Method | handleContentChunk |
Write a chunk of data. |
Method | requestReceived |
Called by channel when all data has been received. |
Method | __repr__ |
Return a string description of the request including such information as the request method and request URI. |
Instance Variable | streamingProducer |
Undocumented |
Method | getHeader |
Get an HTTP request header. |
Method | getCookie |
Get a cookie that was sent from the network. |
Method | notifyFinish |
Notify when the response to this request has finished. |
Method | addCookie |
Set an outgoing HTTP cookie. |
Method | setResponseCode |
Set the HTTP response code. |
Instance Variable | code |
Undocumented |
Method | setHeader |
Set an HTTP response header. Overrides any previously set values for this header. |
Method | redirect |
Utility function that does a redirect. |
Method | setLastModified |
Set the Last-Modified time for the response to this request. |
Method | setETag |
Set an entity tag for the outgoing response. |
Method | getAllHeaders |
Return dictionary mapping the names of all received headers to the last value received for each. |
Method | getRequestHostname |
Get the hostname that the HTTP client passed in to the request. |
Method | getHost |
Get my originally requesting transport's host. |
Method | setHost |
Change the host and port the request thinks it's using. |
Method | getClientIP |
Return the IP address of the client who submitted this request. |
Method | getClientAddress |
Return the address of the client who submitted this request. |
Method | isSecure |
Return True if this request is using a secure transport. |
Instance Variable | user |
Undocumented |
Instance Variable | password |
Undocumented |
Method | getUser |
Return the HTTP user sent with this request, if any. |
Method | getPassword |
Return the HTTP password sent with this request, if any. |
Method | connectionLost |
There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore. |
Method | loseConnection |
Pass the loseConnection through to the underlying channel. |
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. |
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 |
Method | _cleanup |
Called when have finished responding and are no longer queued. |
Method | _authorize |
Undocumented |
Inherited from Componentized
(via Request
):
Class Variable | persistenceVersion |
Undocumented |
Method | locateAdapterClass |
Undocumented |
Method | setAdapter |
Cache a provider for the given interface, by adapting self using the given adapter class. |
Method | addAdapter |
Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument. |
Method | setComponent |
Cache a provider of the given interface. |
Method | addComponent |
Add a component to me, for all appropriate interfaces. |
Method | unsetComponent |
Remove my component specified by the given interface class. |
Method | removeComponent |
Remove the given component from me entirely, for all interfaces for which it has been registered. |
Method | getComponent |
Create or retrieve an adapter for the given interface. |
Method | __conform__ |
Undocumented |
Instance Variable | _adapterCache |
Undocumented |
Initialize this twisted.web.distrib.Request
based on the copied state so that it closely resembles a twisted.web.server.Request
.
twisted.web.server.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.
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. |