Class n.w.WSGIRequest(object):

Part of nevow.wsgi View Source View In Hierarchy

Implements interfaces: nevow.inevow.IRequest

No class docstring
Line # Kind Name Docs
143 Method __init__ Undocumented
164 Method process When a form is POSTed,
201 Method gotPageContext Undocumented
265 Method getHeader Get a header that was sent from the network.
270 Method getCookie Get a cookie that was sent from the network.
275 Method getAllHeaders Return dictionary of all headers the request received.
279 Method getRequestHostname Get the hostname that the user passed in to the request.
290 Method getHost Get my originally requesting transport's host.
298 Method getClientIP Undocumented
301 Method getClient Undocumented
303 Method getUser Undocumented
305 Method getPassword Undocumented
307 Method isSecure Undocumented
310 Method getSession Undocumented
313 Method URLPath Undocumented
317 Method prePathURL Undocumented
344 Method rememberRootURL Remember the currently-processed part of the URL for later
354 Method getRootURL Get a previously-remembered URL.
361 Method finish 0 We are finished writing data.
364 Method write Write some data as a result of an HTTP request. The first
379 Method addCookie Set an outgoing HTTP cookie.
387 Method setResponseCode Set the HTTP response code.
392 Method setHeader Set an outgoing HTTP header.
397 Method redirect Utility function that does a redirect.
406 Method setLastModified Set the Last-Modified time for the response to this request.
438 Method setETag Set an entity tag for the outgoing response.
471 Method setHost Change the host and port the request thinks it's using.
492 Method registerProducer Undocumented
498 Method unregisterProducer Undocumented
501 Method finish We are finished writing data.
def __init__(self, environ, start_response): (source)
Undocumented
def process(self): (source)
When a form is POSTed, we create a cgi.FieldStorage instance using the data posted, and set it as the request.fields attribute. This way, we can get at information about filenames and mime-types of files that were posted.
def gotPageContext(self, pageContext): (source)
Undocumented
def getHeader(self, key): (source)
Get a header that was sent from the network.
def getCookie(self, key): (source)
Get a cookie that was sent from the network.
def getAllHeaders(self): (source)
Return dictionary of all headers the request received.
def getRequestHostname(self): (source)

Get the hostname that the user passed in to the request.

This will either use the Host: header (if it is available) or the host we are listening on if the header is unavailable.
def getHost(self): (source)

Get my originally requesting transport's host.

Don't rely on the 'transport' attribute, since Request objects may be copied remotely. For information on this method's return value, see twisted.internet.tcp.Port.
def getClientIP(self): (source)
Undocumented
def getClient(self): (source)
Undocumented
def getUser(self): (source)
Undocumented
def getPassword(self): (source)
Undocumented
def isSecure(self): (source)
Undocumented
def getSession(self, sessionInterface=None): (source)
Undocumented
def URLPath(self): (source)
Undocumented
def prePathURL(self): (source)
Undocumented
def rememberRootURL(self, url=None): (source)
Remember the currently-processed part of the URL for later recalling.
def getRootURL(self): (source)
Get a previously-remembered URL.
def finish 0(self): (source)
We are finished writing data.
def write(self, data): (source)
Write some data as a result of an HTTP request. The first time this is called, it writes out response data.
def addCookie(self, k, v, expires=None, domain=None, path=None, max_age=None, comment=None, secure=None): (source)

Set an outgoing HTTP cookie.

In general, you should consider using sessions instead of cookies, see twisted.web.server.Request.getSession and the twisted.web.server.Session class for details.
def setResponseCode(self, code, message=None): (source)
Set the HTTP response code.
def setHeader(self, header, value): (source)
Set an outgoing HTTP header.
def redirect(self, url): (source)

Utility function that does a redirect.

The request should have finish() called after this.
def setLastModified(self, when): (source)

Set the Last-Modified time for the response to this request.

If I am called more than once, I ignore attempts to set Last-Modified earlier, only replacing the Last-Modified time if it is to a later value.

If I am a conditional request, I may modify my response code to NOT_MODIFIED if appropriate for the time given.
ParameterswhenThe last time the resource being returned was modified, in seconds since the epoch. (type: number )
ReturnsIf I am a If-Modified-Since conditional request and the time given is not newer than the condition, I return http.CACHED to indicate that you should write no body. Otherwise, I return a false value.
def setETag(self, etag): (source)

Set an entity tag for the outgoing response.

That's "entity tag" as in the HTTP/1.1 ETag header, "used for comparing two or more entities from the same requested resource."

If I am a conditional request, I may modify my response code to NOT_MODIFIED or PRECONDITION_FAILED, if appropriate for the tag given.
ParametersetagThe entity tag for the resource being returned. (type: string )
ReturnsIf I am a If-None-Match conditional request and the tag matches one in the request, I return CACHED to indicate that you should write no body. Otherwise, I return a false value.
def setHost(self, host, port, ssl=0): (source)

Change the host and port the request thinks it's using.

This method is useful for working with reverse HTTP proxies (e.g. both Squid and Apache's mod_proxy can do this), when the address the HTTP client is using is different than the one we're listening on.

For example, Apache may be listening on https://www.example.com, and then forwarding requests to http://localhost:8080, but we don't want HTML produced by Twisted to say 'http://localhost:8080', they should say 'https://www.example.com', so we do:
>>> request.setHost('www.example.com', 443, ssl=1)
This method is experimental.
def registerProducer(self, other, _): (source)
Undocumented
def unregisterProducer(self): (source)
Undocumented
def finish(self): (source)
We are finished writing data.
API Documentation for Nevow, generated by pydoctor.