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`.`proxy`.`ProxyRequest``

class documentation

`class ProxyRequest(Request): (source)`

Constructor: `ProxyRequest(channel, queued, reactor)`

View In Hierarchy

Used by Proxy to implement a simple web proxy.

Method | `__init__` | No summary
Method | `process` | Override in subclasses.
Class Variable | `ports` | Undocumented
Class Variable | `protocols` | Undocumented
Instance Variable | `reactor` | the reactor used to create connections.

Inherited from `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 | `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 | `finish` | Indicate that all response data has been written to this `Request`.
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 | `gotLength` | Called when HTTP channel got length of content in this request.
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 | `registerProducer` | Register a producer.
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.
Method | `unregisterProducer` | Unregister the producer.
Method | `write` | Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
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 | `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 | `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
Instance Variable | `_log` | A logger instance for request related messages.

def __init__(self, channel, queued=_QUEUED_SENTINEL, reactor=reactor): (source)
overrides `twisted.web.http.Request.__init__`

Parameters
channel | the channel we're connected to.
queued | (deprecated) are we in the request queue, or can we start writing to the transport?
reactor | Undocumented

def process(self): (source)
overrides `twisted.web.http.Request.process`

Override in subclasses.

This method is not intended for users.

ports: `dict[bytes, int]` = (source)

Undocumented

protocols = (source)

Undocumented

reactor: object providing `twisted.internet.interfaces.IReactorTCP` = (source)

the reactor used to create connections.