Platforms: Unix, Windows
This is a mostly auto-generated API. If you are new to bottle, you might find the narrative Documentation more helpful.
The module defines several functions, constants, and an exception.
Change the debug level. There is only one debug level supported at the moment.
Start a server instance. This method blocks until the server terminates.
Parameters: |
|
---|
Load a bottle application based on a target string and return the application object.
If the target is an import path (e.g. package.module), the application stack is used to isolate the routes defined in that module. If the target contains a colon (e.g. package.module:myapp) the module variable specified after the colon is returned instead.
A dict to map HTTP status codes (e.g. 404) to phrases (e.g. ‘Not Found’)
Return the current Default Application. Actually, these are callable instances of AppStack and implement a stack-like API.
A stack-like list. Calling it returns the head of the stack.
Return the current default application and remove it from the stack.
Bottle maintains a stack of Bottle instances (see app() and AppStack) and uses the top of the stack as a default application for some of the module-level functions and decorators.
Decorator to install a route to the current default application. See Bottle.route() for details.
Decorator to install an error handler to the current default application. See Bottle.error() for details.
Parse rfc2617 HTTP authentication header string (basic) and return (user,pass) tuple or None
Encode and sign a pickle-able object. Return a (byte) string
Verify and decode an encoded string. Return an object or None.
Return True if the argument looks like a encoded cookie.
Return a generator for routes that match the signature (name, args) of the func parameter. This may yield more than one route if the function takes optional keyword arguments. The output is best described by example:
a() -> '/a'
b(x, y) -> '/b/:x/:y'
c(x, y=5) -> '/c/:x' and '/c/:x/:y'
d(x=5, y=6) -> '/d' and '/d/:x' and '/d/:x/:y'
Shift path fragments from PATH_INFO to SCRIPT_NAME and vice versa.
Returns: | The modified paths. |
---|---|
Parameters: |
|
This dict-like class wraps a WSGI environ dict and provides convenient access to HTTP_* fields. Keys and values are native strings (2.x bytes or 3.x unicode) and keys are case-insensitive. If the WSGI environment contains non-native string values, these are de- or encoded using a lossless ‘latin1’ character set.
The API will remain stable even on changes to the relevant PEPs. Currently PEP 333, 444 and 3333 are supported. (PEP 444 is the only one that uses non-native strings.)
WSGI application
Mount an application to a specific URL prefix. The prefix is added to SCIPT_PATH and removed from PATH_INFO before the sub-application is called.
Parameters: |
|
---|
All other parameters are passed to the underlying route() call.
Add a plugin to the list of plugins and prepare it for beeing applied to all routes of this application. A plugin may be a simple decorator or an object that implements the Plugin API.
Uninstall plugins. Pass an instance to remove a specific plugin. Pass a type object to remove all plugins that match that type. Subclasses are not removed. Pass a string to remove all plugins with a matching name attribute. Pass True to remove all plugins. The list of affected plugins is returned.
Reset all routes (force plugins to be re-applied) and clear all caches. If an ID is given, only that specific route is affected.
(deprecated) Search for a matching route and return a (callback, urlargs) tuple. The first element is the associated route callback with plugins applied. The second value is a dictionary with parameters extracted from the URL. The Router raises HTTPError (404/405) on a non-match.
A decorator to bind a function to a request URL. Example:
@app.route('/hello/:name')
def hello(name):
return 'Hello %s' % name
The :name part is a wildcard. See Router for syntax details.
Parameters: |
|
---|
Any additional keyword arguments are stored as route-specific configuration and passed to plugins (see Plugin.apply()).
Equals route() with a DELETE method parameter.
(deprecated) Execute the first matching route callback and return the result. HTTPResponse exceptions are catched and returned. If Bottle.catchall is true, other exceptions are catched as well and returned as HTTPError instances (500).
The Request class wraps a WSGI environment and provides helpful methods to parse and access form data, cookies, file uploads and other metadata. Most of the attributes are read-only.
The Response class on the other hand stores header and cookie data that is to be sent to the client.
Note
You usually don’t instantiate Request or Response yourself, but use the module-level instances bottle.request and bottle.response only. These hold the context for the current request cycle and are updated on every request. Their attributes are thread-local, so it is safe to use the global instance in multi-threaded environments too.
Represents a single HTTP request using thread-local attributes. The Request object wraps a WSGI environment and can be used as such.
Bind a new WSGI environment.
This is done automatically for the global bottle.request instance on every request.
Shift path fragments from PATH_INFO to SCRIPT_NAME and vice versa.
Parameters: | shift – The number of path fragments to shift. May be negative to change the shift direction. (default: 1) |
---|
Return a urlparse.SplitResult tuple that can be used to reconstruct the full URL as requested by the client. The tuple contains: (scheme, host, path, query_string, fragment). The fragment is always empty because it is not visible to the server.
Request HTTP Headers stored in a HeaderDict.
The combined values from forms and files. Values are either strings (form values) or instances of cgi.FieldStorage (file uploads).
POST form values parsed into an instance of MultiDict.
This property contains form values parsed from an url-encoded or multipart/form-data encoded POST request bidy. The values are native strings.
File uploads parsed into an instance of MultiDict.
This property contains file uploads parsed from an multipart/form-data encoded POST request body. The values are instances of cgi.FieldStorage.
HTTP authorization data as a (user, passwd) tuple. (experimental)
This implementation currently only supports basic auth and returns None on errors.
Cookies parsed into a dictionary. Signed cookies are NOT decoded automatically. See get_cookie() for details.
Return the content of a cookie. To read a Signed Cookies, use the same secret as used to create the cookie (see Response.set_cookie()). If anything goes wrong, None is returned.
Represents a single HTTP response using thread-local attributes.
Returns a wsgi conform list of header/value pairs.
A dict-like SimpleCookie instance. Use set_cookie() instead.
Add a cookie or overwrite an old one. If the secret parameter is set, create a Signed Cookie (described below).
Parameters: |
|
---|
If neither expires nor max_age are set (default), the cookie lasts only as long as the browser is not closed.
Signed cookies may store any pickle-able object and are cryptographically signed to prevent manipulation. Keep in mind that cookies are limited to 4kb in most browsers.
Warning: Signed cookies are not encrypted (the client can still see the content) and not copy-protected (the client can restore an old cookie). The main intention is to make pickling and unpickling save, not to store secret information at client side.
Delete a cookie. Be sure to use the same domain and path parameters as used to create the cookie.
Current ‘Content-Type’ header.
All template engines supported by bottle implement the BaseTemplate API. This way it is possible to switch and mix template engines without changing the application code at all.
Base class and minimal API for template adapters
Create a new template. If the source parameter (str or buffer) is missing, the name argument is used to guess a template filename. Subclasses can assume that self.source and/or self.filename are set. Both are strings. The lookup, encoding and settings parameters are stored as instance variables. The lookup parameter stores a list containing directory paths. The encoding parameter should be used to decode byte strings or files. The settings parameter contains a dict for engine-specific settings.
Search name in all directories specified in lookup. First without, then with common extensions. Return first hit.
This reads or sets the global settings stored in class.settings.
Run preparations (parsing, caching, ...). It should be possible to call this again to refresh a template or to update settings.
Render the template with the specified local variables and return a single byte or unicode string. If it is a byte string, the encoding must match self.encoding. This method must be thread-safe! Local variables may be provided in dictionaries (*args) or directly, as keywords (**kwargs).
Decorator: renders a template for a handler. The handler can control its behavior like that:
- return a dict of template vars to fill out the template
- return something other than a dict and the view decorator will not process the template, but return the handler result as is. This includes returning a HTTPResponse(dict) to get, for instance, JSON with autojson or other castfilters.
Get a rendered template as a string iterator. You can use a name, a filename or a template string as first parameter. Template rendering arguments can be passed as dictionaries or directly (as keyword arguments).
You can write your own adapter for your favourite template engine or use one of the predefined adapters. Currently there are four fully supported template engines:
Class | URL | Decorator | Render function |
---|---|---|---|
SimpleTemplate | SimpleTemplate Engine | view() | template() |
MakoTemplate | http://www.makotemplates.org | mako_view() | mako_template() |
CheetahTemplate | http://www.cheetahtemplate.org/ | cheetah_view() | cheetah_template() |
Jinja2Template | http://jinja.pocoo.org/ | jinja2_view() | jinja2_template() |
To use MakoTemplate as your default template engine, just import its specialised decorator and render function:
from bottle import mako_view as view, mako_template as template