API Documentation

This code was originally based on code in WebOb by Ian Bicking and it seems silly to start from scratch since it already works so well. Ian’s license reads as follows:

Copyright (c) 2007 Ian Bicking and Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

httpkit.helper.cookie.delete_cookie(key, path='/', domain=None)

Delete a cookie from the client. Note that path and domain must match how the cookie was originally set.

This sets the cookie to the empty string, and max_age=0 so that it should expire immediately.

httpkit.helper.cookie.get_cookie(cookie_string, name=None)

httpkit.helper.cookie.set_cookie(key, value='', max_age=None, path='/', domain=None, secure=None, httponly=False, version=None, comment=None, expires=None, charset='utf8')

Set (add) a cookie for the response

httpkit.helper.cookie.unset_cookie(key, headers=[], path='/', domain=None)

Unset a cookie with the given name (remove it from the response). If there are multiple cookies (e.g., two cookies with the same name and different paths or domains), all such cookies will be deleted.

class httpkit.service.http.HTTPObject(flow, default_status='200 OK', default_headers=[, ('Content-Type', 'text/html; charset=utf-8')])

get_result()

class httpkit.service.http.HTTPService

static config(flow, name)

static create(flow, name, config=None)

start(flow, name)

class httpkit.service.http.ResultIterator(body, charset='utf8')

next()

Query string service

class httpkit.service.query.HTTPQueryService

static config(flow, name)

static create(flow, name, config=None)

start(flow, name)

Request body (POST input) service

class httpkit.service.input.HTTPInputService

static config(flow, name)

static create(flow, name, config=None)

start(flow, name)