gws.base.web.wsgi

Basic WSGI request/response handling.

Source code: gws.base.web.wsgi

Module Contents

class gws.base.web.wsgi.Requester(root: gws.Root, environ: dict, site: gws.WebSite, **kwargs)

Bases: gws.WebRequester

Web Requester object.

contentType

Request content type.

contentTypeHeader
environ

Request environment.

isApi = False

The request provides json data in the POST body.

isForm = False

The request provides form data in the POST body.

isGet

The request is a GET request.

isPost

The request is a POST request.

isSecure

The request is secure.

maxContentLength
method

Request method.

root

Object tree root.

session

Current session.

site

Website the request is processed for.

structInput = None
structOutput = None
user

Current use.

api_responder(response)

Return a Responder object for an Api (structured) response.

Parameters:

response – Response object.

Returns:

A Responder.

command()

Command name from the request.

content_responder(response)

Return a Responder object for a content response.

Parameters:

response – Response object.

Returns:

A Responder.

cookie(key, default='')

Get a cookie.

Parameters:

  • key – Cookie name.

  • default – Default value.

Returns:

A cookie value.

data()

Raw POST data.

env(key, default='')

Get an environment variable.

Parameters:

  • key – Variable name.

  • default – Default value.

Returns:

A variable value.

error_responder(exc)

Return a Responder object for an Exception.

Parameters:

exc – An Exception.

Returns:

A Responder.

form()

POST form data as a list of (key, value) tuples.

has_param(key)

Check if a GET parameter exists.

Parameters:

key – Parameter name.

header(key, default='')

Get a header.

Parameters:

  • key – Header name.

  • default – Default value.

Returns:

A header value.

param(key, default='')

Get a GET parameter.

Parameters:

  • key – Parameter name.

  • default – Default value.

Returns:

A parameter value.

params()

GET parameters, including parsed path params.

parse()

Parse the request data, raise an error if the request is invalid.

path()

Request path, after the command is removed.

query_params()

GET parameters from the query string.

redirect_responder(response)

Return a Responder object for a redirect response.

Parameters:

response – Response object.

Returns:

A Responder.

set_session(sess)

Attach a session to the requester.

Parameters:

session – A Session object.

struct()

Structured JSON payload.

text()

POST data decoded to text.

url_for(path, **kwargs)

Return a canonical Url for the given request path.

Parameters:

  • request_path – Request path.

  • **kwargs – Additional GET parameters.

Returns:

An URL.

class gws.base.web.wsgi.Responder(**kwargs)

Bases: gws.WebResponder

Web Responder object.

response
status

Response status.

add_header(key, value)

Add a header.

Parameters:

  • key – Header name.

  • value – Header value.

Delete a cookie.

Parameters:

  • key – Cookie name.

  • **kwargs – Cookie options.

send_response(environ, start_response)

Send the response to the client.

Parameters:

  • environ – WSGI environment.

  • start_response – WSGI start_response function.

Set a cookie.

Parameters:

  • key – Cookie name.

  • value – Cookie value.

  • **kwargs – Cookie options.

set_status(status)

Set the response status.

Parameters:

status – HTTP status code.