class documentation

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

View In Hierarchy

A request which was received by a ResourceSubscription and sent via PB to a distributed node.
Method fail Undocumented
Method register​Producer Register a producer.
Method set​Copyable​State Initialize this twisted.web.distrib.Request based on the copied state so that it closely resembles a twisted.web.server.Request.
Method unregister​Producer 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 unjelly​For Perform the inverse operation of Jellyable.jellyFor.
Instance Variable __dict__ Undocumented

Inherited from Unjellyable (via RemoteCopy):

Method set​State​For Undocumented

Inherited from Request:

Method __init__
Method child​Link Return the text that links to a child of the requested resource.
Method finish Override http.Request.finish for possible encoding.
Method get​Root​URL Get a previously-remembered URL.
Method get​Session Check if there is a session cookie, and if not, create it.
Method get​State​To​Copy​For Gather state to send when I am serialized for a particular perspective.
Method got​Length Called when HTTP channel got length of content in this request.
Method pre​Path​URL 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 processing​Failed Finish this request with an indication that processing failed and possibly display a traceback.
Method remember​Root​URL Remember the currently-processed part of the URL for later recalling.
Method render Ask a resource to render itself.
Method sib​Link Return the text that links to a sibling of the requested resource.
Method ​URLPath
Method view_add​Cookie Remote version of addCookie; same interface.
Method view​_finish Remote version of finish; same interface.
Method view_register​Producer Remote version of registerProducer; same interface. (requires a remote producer.)
Method view_set​ETag Remote version of setETag; same interface.
Method view_set​Header Remote version of setHeader; same interface.
Method view_set​Last​Modified Remote version of setLastModified; same interface.
Method view_set​Response​Code Remote version of setResponseCode; same interface.
Method view_unregister​Producer Undocumented
Method view​_write Remote version of write; same interface.
Class Variable __pychecker__ Undocumented
Instance Variable app​Root​URL Undocumented
Instance Variable default​Content​Type A bytes giving the default Content-Type value to send in responses if no other value is set. None disables the default.
Instance Variable method A bytes giving the HTTP method that was used.
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 No summary
Method _handle​Star Handle receiving a request whose path is '*'.
Method _pre​Path​URL Undocumented
Class Variable _log Undocumented
Instance Variable _encoder Undocumented
Instance Variable _in​Fake​Head Undocumented
Instance Variable _insecure​Session The Session object representing state that will be transmitted over plain-text HTTP.
Instance Variable _secure​Session The Session object representing the state that will be transmitted only over HTTPS.

Inherited from Copyable (via Request):

Method get​State​To​Copy Gather state to send when I am serialized for a peer.
Method get​Type​To​Copy Determine what type tag to send for me.
Method get​Type​To​Copy​For Determine what type tag to send for me.
Method jelly​For Assemble type tag and state to copy for this broker.

Inherited from Serializable (via Request, Copyable):

Method process​Unique​ID Return an ID which uniquely represents this object for this process.

Inherited from Jellyable (via Request, Copyable, Serializable):

Method get​State​For Undocumented

Inherited from Request (via Request):

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 add​Cookie Set an outgoing HTTP cookie.
Method connection​Lost There is no longer a connection for this request to respond over. Clean up anything which can't be useful anymore.
Method get​All​Headers Return dictionary mapping the names of all received headers to the last value received for each.
Method get​Client​Address Return the address of the client who submitted this request.
Method get​Client​IP Return the IP address of the client who submitted this request.
Method get​Cookie Get a cookie that was sent from the network.
Method get​Header Get an HTTP request header.
Method get​Host Get my originally requesting transport's host.
Method get​Password Return the HTTP password sent with this request, if any.
Method get​Request​Hostname Get the hostname that the HTTP client passed in to the request.
Method get​User Return the HTTP user sent with this request, if any.
Method handle​Content​Chunk Write a chunk of data.
Method is​Secure Return True if this request is using a secure transport.
Method lose​Connection Pass the loseConnection through to the underlying channel.
Method no​Longer​Queued Notify the object that it is no longer queued.
Method notify​Finish Notify when the response to this request has finished.
Method parse​Cookies Parse cookie headers.
Method redirect Utility function that does a redirect.
Method request​Received Called by channel when all data has been received.
Method set​ETag Set an entity tag for the outgoing response.
Method set​Header Set an HTTP response header. Overrides any previously set values for this header.
Method set​Host Change the host and port the request thinks it's using.
Method set​Last​Modified Set the Last-Modified time for the response to this request.
Method set​Response​Code Set the HTTP response code.
Instance Variable args A mapping of decoded query argument names as bytes to corresponding query argument values as lists 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 last​Modified Undocumented
Instance Variable notifications A list of Deferreds 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 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 request​Headers All received HTTP request headers.
Instance Variable response​Headers All HTTP response headers to be sent.
Instance Variable sent​Length Undocumented
Instance Variable started​Writing Undocumented
Instance Variable streaming​Producer 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 _force​SSL Undocumented

Inherited from Componentized (via Request):

Method __conform__ Undocumented
Method add​Adapter Utility method that calls addComponent. I take an adapter class and instantiate it with myself as the first argument.
Method add​Component Add a component to me, for all appropriate interfaces.
Method get​Component Create or retrieve an adapter for the given interface.
Method locate​Adapter​Class Undocumented
Method remove​Component Remove the given component from me entirely, for all interfaces for which it has been registered.
Method set​Adapter Cache a provider for the given interface, by adapting self using the given adapter class.
Method set​Component Cache a provider of the given interface.
Method unset​Component Remove my component specified by the given interface class.
Class Variable persistence​Version Undocumented
Instance Variable _adapter​Cache Undocumented
def fail(self, failure): (source)

Undocumented

def registerProducer(self, producer, streaming): (source)
def setCopyableState(self, state): (source)
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)
def write(self, bytes): (source)
Write the given bytes to the response body.
Parameters
bytesThe bytes to write. If this is longer than 640k, it will be split up into smaller pieces.
content = (source)
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