templog: web/bottle.py comparison

comparison web/bottle.py @ 248:317a1738f15c

Update to bottle 0.12.8

author	Matt Johnston <matt@ucc.asn.au>
date	Wed, 27 May 2015 22:17:39 +0800
parents	dbbd503119ba
children

comparison

equal deleted inserted replaced

-:a19496c95be5
+:317a1738f15c
 template engines - all in a single file and with no dependencies other than the
 Python Standard Library.
 Homepage and documentation: http://bottlepy.org/
-Copyright (c) 2011, Marcel Hellkamp.
+Copyright (c) 2013, Marcel Hellkamp.
 License: MIT (see LICENSE for details)
 """
 from __future__ import with_statement
 __author__ = 'Marcel Hellkamp'
-__version__ = '0.11.dev'
+__version__ = '0.12.8'
 __license__ = 'MIT'
 # The gevent server adapter needs to patch some modules before they are imported
 # This is why we parse the commandline parameters here but handle them later
 if __name__ == '__main__':
 _cmd_options, _cmd_args = _cmd_parser.parse_args()
 if _cmd_options.server and _cmd_options.server.startswith('gevent'):
 import gevent.monkey; gevent.monkey.patch_all()
 import base64, cgi, email.utils, functools, hmac, imp, itertools, mimetypes,\
-os, re, subprocess, sys, tempfile, threading, time, urllib, warnings
+os, re, subprocess, sys, tempfile, threading, time, warnings
 from datetime import date as datedate, datetime, timedelta
 from tempfile import TemporaryFile
 from traceback import format_exc, print_exc
+from inspect import getargspec
-try: from json import dumps as json_dumps, loads as json_lds
+from unicodedata import normalize
+try: from simplejson import dumps as json_dumps, loads as json_lds
 except ImportError: # pragma: no cover
-try: from simplejson import dumps as json_dumps, loads as json_lds
+try: from json import dumps as json_dumps, loads as json_lds
 except ImportError:
 try: from django.utils.simplejson import dumps as json_dumps, loads as json_lds
 except ImportError:
 def json_dumps(data):
 raise ImportError("JSON support requires Python 2.6 or simplejson.")
 # We now try to fix 2.5/2.6/3.1/3.2 incompatibilities.
 # It ain't pretty but it works... Sorry for the mess.
 py   = sys.version_info
-py3k = py >= (3,0,0)
+py3k = py >= (3, 0, 0)
-py25 = py <  (2,6,0)
+py25 = py <  (2, 6, 0)
+py31 = (3, 1, 0) <= py < (3, 2, 0)
 # Workaround for the missing "as" keyword in py3k.
 def _e(): return sys.exc_info()[1]
 # Workaround for the "print is a keyword/function" Python 2/3 dilemma
 # Lots of stdlib and builtin differences.
 if py3k:
 import http.client as httplib
 import _thread as thread
-from urllib.parse import urljoin, parse_qsl, SplitResult as UrlSplitResult
+from urllib.parse import urljoin, SplitResult as UrlSplitResult
 from urllib.parse import urlencode, quote as urlquote, unquote as urlunquote
+urlunquote = functools.partial(urlunquote, encoding='latin1')
 from http.cookies import SimpleCookie
 from collections import MutableMapping as DictMixin
 import pickle
 from io import BytesIO
+from configparser import ConfigParser
 basestring = str
 unicode = str
 json_loads = lambda s: json_lds(touni(s))
 callable = lambda x: hasattr(x, '__call__')
 imap = map
+def _raise(*a): raise a[0](a[1]).with_traceback(a[2])
 else: # 2.x
 import httplib
 import thread
 from urlparse import urljoin, SplitResult as UrlSplitResult
 from urllib import urlencode, quote as urlquote, unquote as urlunquote
 from Cookie import SimpleCookie
 from itertools import imap
 import cPickle as pickle
 from StringIO import StringIO as BytesIO
+from ConfigParser import SafeConfigParser as ConfigParser
 if py25:
-msg = "Python 2.5 support may be dropped in future versions of Bottle."
+msg  = "Python 2.5 support may be dropped in future versions of Bottle."
 warnings.warn(msg, DeprecationWarning)
-from cgi import parse_qsl
 from UserDict import DictMixin
 def next(it): return it.next()
 bytes = str
 else: # 2.6, 2.7
-from urlparse import parse_qsl
 from collections import MutableMapping as DictMixin
+unicode = unicode
 json_loads = json_lds
+eval(compile('def _raise(*a): raise a[0], a[1], a[2]', '<py3fix>', 'exec'))
 # Some helpers for string/byte handling
 def tob(s, enc='utf8'):
 return s.encode(enc) if isinstance(s, unicode) else bytes(s)
 def touni(s, enc='utf8', err='strict'):
 return s.decode(enc, err) if isinstance(s, bytes) else unicode(s)
 tonat = touni if py3k else tob
 # 3.2 fixes cgi.FieldStorage to accept bytes (which makes a lot of sense).
 # 3.1 needs a workaround.
-NCTextIOWrapper = None
+if py31:
-if (3,0,0) < py < (3,2,0):
 from io import TextIOWrapper
 class NCTextIOWrapper(TextIOWrapper):
 def close(self): pass # Keep wrapped buffer open.
 # A bug in functools causes it to break if the wrapper is an instance method
 def update_wrapper(wrapper, wrapped, *a, **ka):
 try: functools.update_wrapper(wrapper, wrapped, *a, **ka)
 except AttributeError: pass
 # These helpers are used at module level and need to be defined first.
 # And yes, I know PEP-8, but sometimes a lower-case classname makes more sense.
-def depr(message):
+def depr(message, hard=False):
 warnings.warn(message, DeprecationWarning, stacklevel=3)
 def makelist(data): # This is just to handy
 if isinstance(data, (tuple, list, set, dict)): return list(data)
 elif data: return [data]
 ''' A property that is only computed once per instance and then replaces
 itself with an ordinary attribute. Deleting the attribute resets the
 property. '''
 def __init__(self, func):
+self.__doc__ = getattr(func, '__doc__')
 self.func = func
 def __get__(self, obj, cls):
 if obj is None: return self
 value = obj.__dict__[self.func.__name__] = self.func(obj)
 class BottleException(Exception):
 """ A base class for exceptions used by bottle. """
 pass
-#TODO: This should subclass BaseRequest
-class HTTPResponse(BottleException):
-""" Used to break execution and immediately finish the response """
-def __init__(self, output='', status=200, header=None):
-super(BottleException, self).__init__("HTTP Response %d" % status)
-self.status = int(status)
-self.output = output
-self.headers = HeaderDict(header) if header else None
-def apply(self, response):
-if self.headers:
-for key, value in self.headers.allitems():
-response.headers[key] = value
-response.status = self.status
-class HTTPError(HTTPResponse):
-""" Used to generate an error page """
-def __init__(self, code=500, output='Unknown Error', exception=None,
-traceback=None, header=None):
-super(HTTPError, self).__init__(output, code, header)
-self.exception = exception
-self.traceback = traceback
-def __repr__(self):
-return tonat(template(ERROR_PAGE_TEMPLATE, e=self))
 ###############################################################################
 class RouterUnknownModeError(RouteError): pass
 class RouteSyntaxError(RouteError):
-""" The route parser found something not supported by this router """
+""" The route parser found something not supported by this router. """
 class RouteBuildError(RouteError):
-""" The route could not been built """
+""" The route could not be built. """
+def _re_flatten(p):
+''' Turn all capturing groups in a regular expression pattern into
+non-capturing groups. '''
+if '(' not in p: return p
+return re.sub(r'(\\*)(\(\?P<[^>]+>|\((?!\?))',
+lambda m: m.group(0) if len(m.group(1)) % 2 else m.group(1) + '(?:', p)
 class Router(object):
 ''' A Router is an ordered collection of route->target pairs. It is used to
 efficiently match WSGI requests against a number of routes and return
 path that contains wildcards (e.g. `/wiki/<page>`). The wildcard syntax
 and details on the matching order are described in docs:`routing`.
 '''
 default_pattern = '[^/]+'
-default_filter   = 're'
+default_filter  = 're'
-#: Sorry for the mess. It works. Trust me.
-rule_syntax = re.compile('(\\\\*)'\
+#: The current CPython regexp implementation does not allow more
-'(?:(?::([a-zA-Z_][a-zA-Z_0-9]*)?()(?:#(.*?)#)?)'\
+#: than 99 matching groups per regular expression.
-'|(?:<([a-zA-Z_][a-zA-Z_0-9]*)?(?::([a-zA-Z_]*)'\
+_MAX_GROUPS_PER_PATTERN = 99
-'(?::((?:\\\\.|[^\\\\>]+)+)?)?)?>))')
 def __init__(self, strict=False):
-self.rules    = {} # A {rule: Rule} mapping
+self.rules    = [] # All rules in order
-self.builder  = {} # A rule/name->build_info mapping
+self._groups  = {} # index of regexes to find them in dyna_routes
-self.static   = {} # Cache for static routes: {path: {method: target}}
+self.builder  = {} # Data structure for the url builder
-self.dynamic  = [] # Cache for dynamic routes. See _compile()
+self.static   = {} # Search structure for static routes
+self.dyna_routes   = {}
+self.dyna_regexes  = {} # Search structure for dynamic routes
 #: If true, static routes are no longer checked first.
 self.strict_order = strict
-self.filters = {'re': self.re_filter, 'int': self.int_filter,
+self.filters = {
-'float': self.float_filter, 'path': self.path_filter}
+'re':    lambda conf:
+(_re_flatten(conf or self.default_pattern), None, None),
-def re_filter(self, conf):
+'int':   lambda conf: (r'-?\d+', int, lambda x: str(int(x))),
-return conf or self.default_pattern, None, None
+'float': lambda conf: (r'-?[\d.]+', float, lambda x: str(float(x))),
+'path':  lambda conf: (r'.+?', None, None)}
-def int_filter(self, conf):
-return r'-?\d+', int, lambda x: str(int(x))
-def float_filter(self, conf):
-return r'-?[\d.]+', float, lambda x: str(float(x))
-def path_filter(self, conf):
-return r'.+?', None, None
 def add_filter(self, name, func):
 ''' Add a filter. The provided function is called with the configuration
 string as parameter and must return a (regexp, to_python, to_url) tuple.
 The first element is a string, the last two are callables or None. '''
 self.filters[name] = func
-def parse_rule(self, rule):
+rule_syntax = re.compile('(\\\\*)'\
-''' Parses a rule into a (name, filter, conf) token stream. If mode is
+'(?:(?::([a-zA-Z_][a-zA-Z_0-9]*)?()(?:#(.*?)#)?)'\
-None, name contains a static rule part. '''
+'|(?:<([a-zA-Z_][a-zA-Z_0-9]*)?(?::([a-zA-Z_]*)'\
+'(?::((?:\\\\.|[^\\\\>]+)+)?)?)?>))')
+def _itertokens(self, rule):
 offset, prefix = 0, ''
 for match in self.rule_syntax.finditer(rule):
 prefix += rule[offset:match.start()]
 g = match.groups()
 if len(g[0])%2: # Escaped wildcard
 prefix += match.group(0)[len(g[0]):]
 offset = match.end()
 continue
-if prefix: yield prefix, None, None
+if prefix:
-name, filtr, conf = g[1:4] if not g[2] is None else g[4:7]
+yield prefix, None, None
-if not filtr: filtr = self.default_filter
+name, filtr, conf = g[4:7] if g[2] is None else g[1:4]
-yield name, filtr, conf or None
+yield name, filtr or 'default', conf or None
 offset, prefix = match.end(), ''
 if offset <= len(rule) or prefix:
 yield prefix+rule[offset:], None, None
 def add(self, rule, method, target, name=None):
-''' Add a new route or replace the target for an existing route. '''
+''' Add a new rule or replace the target for an existing rule. '''
-if rule in self.rules:
+anons     = 0    # Number of anonymous wildcards found
-self.rules[rule][method] = target
+keys      = []   # Names of keys
-if name: self.builder[name] = self.builder[rule]
+pattern   = ''   # Regular expression pattern with named groups
-return
+filters   = []   # Lists of wildcard input filters
+builder   = []   # Data structure for the URL builder
-target = self.rules[rule] = {method: target}
-# Build pattern and other structures for dynamic routes
-anons = 0      # Number of anonymous wildcards
-pattern = ''   # Regular expression  pattern
-filters = []   # Lists of wildcard input filters
-builder = []   # Data structure for the URL builder
 is_static = True
-for key, mode, conf in self.parse_rule(rule):
+for key, mode, conf in self._itertokens(rule):
 if mode:
 is_static = False
+if mode == 'default': mode = self.default_filter
 mask, in_filter, out_filter = self.filters[mode](conf)
-if key:
+if not key:
+pattern += '(?:%s)' % mask
+key = 'anon%d' % anons
+anons += 1
+else:
 pattern += '(?P<%s>%s)' % (key, mask)
-else:
+keys.append(key)
-pattern += '(?:%s)' % mask
-key = 'anon%d' % anons; anons += 1
 if in_filter: filters.append((key, in_filter))
 builder.append((key, out_filter or str))
 elif key:
 pattern += re.escape(key)
 builder.append((None, key))
 self.builder[rule] = builder
 if name: self.builder[name] = builder
 if is_static and not self.strict_order:
-self.static[self.build(rule)] = target
+self.static.setdefault(method, {})
+self.static[method][self.build(rule)] = (target, None)
 return
-def fpat_sub(m):
-return m.group(0) if len(m.group(1)) % 2 else m.group(1) + '(?:'
-flat_pattern = re.sub(r'(\\*)(\(\?P<[^>]*>|\((?!\?))', fpat_sub, pattern)
 try:
-re_match = re.compile('^(%s)$' % pattern).match
+re_pattern = re.compile('^(%s)$' % pattern)
+re_match = re_pattern.match
 except re.error:
 raise RouteSyntaxError("Could not add Route: %s (%s)" % (rule, _e()))
-def match(path):
+if filters:
-""" Return an url-argument dictionary. """
+def getargs(path):
 url_args = re_match(path).groupdict()
 for name, wildcard_filter in filters:
 try:
 url_args[name] = wildcard_filter(url_args[name])
 except ValueError:
 raise HTTPError(400, 'Path has wrong format.')
 return url_args
+elif re_pattern.groupindex:
-try:
+def getargs(path):
-combined = '%s|(^%s$)' % (self.dynamic[-1][0].pattern, flat_pattern)
+return re_match(path).groupdict()
-self.dynamic[-1] = (re.compile(combined), self.dynamic[-1][1])
+else:
-self.dynamic[-1][1].append((match, target))
+getargs = None
-except (AssertionError, IndexError): # AssertionError: Too many groups
-self.dynamic.append((re.compile('(^%s$)' % flat_pattern),
+flatpat = _re_flatten(pattern)
-[(match, target)]))
+whole_rule = (rule, flatpat, target, getargs)
-return match
+if (flatpat, method) in self._groups:
+if DEBUG:
+msg = 'Route <%s %s> overwrites a previously defined route'
+warnings.warn(msg % (method, rule), RuntimeWarning)
+self.dyna_routes[method][self._groups[flatpat, method]] = whole_rule
+else:
+self.dyna_routes.setdefault(method, []).append(whole_rule)
+self._groups[flatpat, method] = len(self.dyna_routes[method]) - 1
+self._compile(method)
+def _compile(self, method):
+all_rules = self.dyna_routes[method]
+comborules = self.dyna_regexes[method] = []
+maxgroups = self._MAX_GROUPS_PER_PATTERN
+for x in range(0, len(all_rules), maxgroups):
+some = all_rules[x:x+maxgroups]
+combined = (flatpat for (_, flatpat, _, _) in some)
+combined = '|'.join('(^%s$)' % flatpat for flatpat in combined)
+combined = re.compile(combined).match
+rules = [(target, getargs) for (_, _, target, getargs) in some]
+comborules.append((combined, rules))
 def build(self, _name, *anons, **query):
 ''' Build an URL by filling the wildcards in a rule. '''
 builder = self.builder.get(_name)
 if not builder: raise RouteBuildError("No route with that name.", _name)
 except KeyError:
 raise RouteBuildError('Missing URL argument: %r' % _e().args[0])
 def match(self, environ):
 ''' Return a (target, url_agrs) tuple or raise HTTPError(400/404/405). '''
-path, targets, urlargs = environ['PATH_INFO'] or '/', None, {}
+verb = environ['REQUEST_METHOD'].upper()
-if path in self.static:
+path = environ['PATH_INFO'] or '/'
-targets = self.static[path]
+target = None
+if verb == 'HEAD':
+methods = ['PROXY', verb, 'GET', 'ANY']
 else:
-for combined, rules in self.dynamic:
+methods = ['PROXY', verb, 'ANY']
-match = combined.match(path)
-if not match: continue
+for method in methods:
-getargs, targets = rules[match.lastindex - 1]
+if method in self.static and path in self.static[method]:
-urlargs = getargs(path) if getargs else {}
+target, getargs = self.static[method][path]
-break
+return target, getargs(path) if getargs else {}
+elif method in self.dyna_regexes:
-if not targets:
+for combined, rules in self.dyna_regexes[method]:
-raise HTTPError(404, "Not found: " + repr(environ['PATH_INFO']))
+match = combined(path)
-method = environ['REQUEST_METHOD'].upper()
+if match:
-if method in targets:
+target, getargs = rules[match.lastindex - 1]
-return targets[method], urlargs
+return target, getargs(path) if getargs else {}
-if method == 'HEAD' and 'GET' in targets:
-return targets['GET'], urlargs
+# No matching route found. Collect alternative methods for 405 response
-if 'ANY' in targets:
+allowed = set([])
-return targets['ANY'], urlargs
+nocheck = set(methods)
-allowed = [verb for verb in targets if verb != 'ANY']
+for method in set(self.static) - nocheck:
-if 'GET' in allowed and 'HEAD' not in allowed:
+if path in self.static[method]:
-allowed.append('HEAD')
+allowed.add(verb)
-raise HTTPError(405, "Method not allowed.",
+for method in set(self.dyna_regexes) - allowed - nocheck:
-header=[('Allow',",".join(allowed))])
+for combined, rules in self.dyna_regexes[method]:
+match = combined(path)
+if match:
+allowed.add(method)
+if allowed:
+allow_header = ",".join(sorted(allowed))
+raise HTTPError(405, "Method not allowed.", Allow=allow_header)
+# No matching route and no alternative method found. We give up
+raise HTTPError(404, "Not found: " + repr(path))
 class Route(object):
 ''' This class wraps a route callback along with route specific metadata and
 configuration and applies Plugins on demand. It is also responsible for
 #: A list of plugins to not apply to this route (see :meth:`Bottle.route`).
 self.skiplist = skiplist or []
 #: Additional keyword arguments passed to the :meth:`Bottle.route`
 #: decorator are stored in this dictionary. Used for route-specific
 #: plugin configuration and meta-data.
-self.config = ConfigDict(config)
+self.config = ConfigDict().load_dict(config, make_namespaces=True)
 def __call__(self, *a, **ka):
 depr("Some APIs changed to return Route() instances instead of"\
 " callables. Make sure to use the Route.call method and not to"\
-" call Route instances directly.")
+" call Route instances directly.") #0.12
 return self.call(*a, **ka)
 @cached_property
 def call(self):
 ''' The route callback with all plugins applied. This property is
 ''' Do all on-demand work immediately (useful for debugging).'''
 self.call
 @property
 def _context(self):
-depr('Switch to Plugin API v2 and access the Route object directly.')
+depr('Switch to Plugin API v2 and access the Route object directly.')  #0.12
 return dict(rule=self.rule, method=self.method, callback=self.callback,
 name=self.name, app=self.app, config=self.config,
 apply=self.plugins, skip=self.skiplist)
 def all_plugins(self):
 return self._make_callback()
 if not callback is self.callback:
 update_wrapper(callback, self.callback)
 return callback
+def get_undecorated_callback(self):
+''' Return the callback. If the callback is a decorated function, try to
+recover the original function. '''
+func = self.callback
+func = getattr(func, '__func__' if py3k else 'im_func', func)
+closure_attr = '__closure__' if py3k else 'func_closure'
+while hasattr(func, closure_attr) and getattr(func, closure_attr):
+func = getattr(func, closure_attr)[0].cell_contents
+return func
+def get_callback_args(self):
+''' Return a list of argument names the callback (most likely) accepts
+as keyword arguments. If the callback is a decorated function, try
+to recover the original function before inspection. '''
+return getargspec(self.get_undecorated_callback())[0]
+def get_config(self, key, default=None):
+''' Lookup a config field and return its value, first checking the
+route.config, then route.app.config.'''
+for conf in (self.config, self.app.conifg):
+if key in conf: return conf[key]
+return default
 def __repr__(self):
-return '<%s %r %r>' % (self.method, self.rule, self.callback)
+cb = self.get_undecorated_callback()
+return '<%s %r %r>' % (self.method, self.rule, cb)
 :param catchall: If true (default), handle all exceptions. Turn off to
 let debugging middleware handle exceptions.
 """
 def __init__(self, catchall=True, autojson=True):
-#: If true, most exceptions are caught and returned as :exc:`HTTPError`
-self.catchall = catchall
+#: A :class:`ConfigDict` for app specific configuration.
+self.config = ConfigDict()
-#: A :cls:`ResourceManager` for application files
+self.config._on_change = functools.partial(self.trigger_hook, 'config')
+self.config.meta_set('autojson', 'validate', bool)
+self.config.meta_set('catchall', 'validate', bool)
+self.config['catchall'] = catchall
+self.config['autojson'] = autojson
+#: A :class:`ResourceManager` for application files
 self.resources = ResourceManager()
-#: A :cls:`ConfigDict` for app specific configuration.
-self.config = ConfigDict()
-self.config.autojson = autojson
 self.routes = [] # List of installed :class:`Route` instances.
 self.router = Router() # Maps requests to :class:`Route` instances.
 self.error_handler = {}
 # Core plugins
 self.plugins = [] # List of installed plugins.
-self.hooks = HooksPlugin()
+if self.config['autojson']:
-self.install(self.hooks)
-if self.config.autojson:
 self.install(JSONPlugin())
 self.install(TemplatePlugin())
+#: If true, most exceptions are caught and returned as :exc:`HTTPError`
+catchall = DictProperty('config', 'catchall')
+__hook_names = 'before_request', 'after_request', 'app_reset', 'config'
+__hook_reversed = 'after_request'
+@cached_property
+def _hooks(self):
+return dict((name, []) for name in self.__hook_names)
+def add_hook(self, name, func):
+''' Attach a callback to a hook. Three hooks are currently implemented:
+before_request
+Executed once before each request. The request context is
+available, but no routing has happened yet.
+after_request
+Executed once after each request regardless of its outcome.
+app_reset
+Called whenever :meth:`Bottle.reset` is called.
+'''
+if name in self.__hook_reversed:
+self._hooks[name].insert(0, func)
+else:
+self._hooks[name].append(func)
+def remove_hook(self, name, func):
+''' Remove a callback from a hook. '''
+if name in self._hooks and func in self._hooks[name]:
+self._hooks[name].remove(func)
+return True
+def trigger_hook(self, __name, *args, **kwargs):
+''' Trigger a hook and return a list of results. '''
+return [hook(*args, **kwargs) for hook in self._hooks[__name][:]]
+def hook(self, name):
+""" Return a decorator that attaches a callback to a hook. See
+:meth:`add_hook` for details."""
+def decorator(func):
+self.add_hook(name, func)
+return func
+return decorator
 def mount(self, prefix, app, **options):
 ''' Mount an application (:class:`Bottle` or plain WSGI) to a specific
 URL prefix. Example::
 :param app: an instance of :class:`Bottle` or a WSGI application.
 All other parameters are passed to the underlying :meth:`route` call.
 '''
 if isinstance(app, basestring):
-prefix, app = app, prefix
+depr('Parameter order of Bottle.mount() changed.', True) # 0.10
-depr('Parameter order of Bottle.mount() changed.') # 0.10
 segments = [p for p in prefix.split('/') if p]
 if not segments: raise ValueError('Empty path prefix.')
 path_depth = len(segments)
 def mountpoint_wrapper():
 try:
 request.path_shift(path_depth)
-rs = BaseResponse([], 200)
+rs = HTTPResponse([])
-def start_response(status, header):
+def start_response(status, headerlist, exc_info=None):
+if exc_info:
+try:
+_raise(*exc_info)
+finally:
+exc_info = None
 rs.status = status
-for name, value in header: rs.add_header(name, value)
+for name, value in headerlist: rs.add_header(name, value)
 return rs.body.append
 body = app(request.environ, start_response)
-body = itertools.chain(rs.body, body)
+if body and rs.body: body = itertools.chain(rs.body, body)
-return HTTPResponse(body, rs.status_code, rs.headers)
+rs.body = body or rs.body
+return rs
 finally:
 request.path_shift(-path_depth)
 options.setdefault('skip', True)
-options.setdefault('method', 'ANY')
+options.setdefault('method', 'PROXY')
 options.setdefault('mountpoint', {'prefix': prefix, 'target': app})
 options['callback'] = mountpoint_wrapper
 self.route('/%s/<:re:.*>' % '/'.join(segments), **options)
 if not prefix.endswith('/'):
 del self.plugins[i]
 if hasattr(plugin, 'close'): plugin.close()
 if removed: self.reset()
 return removed
-def run(self, **kwargs):
-''' Calls :func:`run` with the same parameters. '''
-run(self, **kwargs)
 def reset(self, route=None):
 ''' Reset all routes (force plugins to be re-applied) and clear all
 caches. If an ID or route object is given, only that specific route
 is affected. '''
 if route is None: routes = self.routes
 elif isinstance(route, Route): routes = [route]
 else: routes = [self.routes[route]]
 for route in routes: route.reset()
 if DEBUG:
 for route in routes: route.prepare()
-self.hooks.trigger('app_reset')
+self.trigger_hook('app_reset')
 def close(self):
 ''' Close the application and all installed plugins. '''
 for plugin in self.plugins:
 if hasattr(plugin, 'close'): plugin.close()
 self.stopped = True
+def run(self, **kwargs):
+''' Calls :func:`run` with the same parameters. '''
+run(self, **kwargs)
 def match(self, environ):
 """ Search for a matching route and return a (:class:`Route` , urlargs)
 tuple. The second value is a dictionary with parameters extracted
 from the URL. Raise :exc:`HTTPError` (404/405) on a non-match."""
 def wrapper(handler):
 self.error_handler[int(code)] = handler
 return handler
 return wrapper
-def hook(self, name):
+def default_error_handler(self, res):
-""" Return a decorator that attaches a callback to a hook. Three hooks
+return tob(template(ERROR_PAGE_TEMPLATE, e=res))
-are currently implemented:
-- before_request: Executed once before each request
-- after_request: Executed once after each request
-- app_reset: Called whenever :meth:`reset` is called.
-"""
-def wrapper(func):
-self.hooks.add(name, func)
-return func
-return wrapper
-def handle(self, path, method='GET'):
-""" (deprecated) Execute the first matching route callback and return
-the result. :exc:`HTTPResponse` exceptions are caught and returned.
-If :attr:`Bottle.catchall` is true, other exceptions are caught as
-well and returned as :exc:`HTTPError` instances (500).
-"""
-depr("This method will change semantics in 0.10. Try to avoid it.")
-if isinstance(path, dict):
-return self._handle(path)
-return self._handle({'PATH_INFO': path, 'REQUEST_METHOD': method.upper()})
 def _handle(self, environ):
+path = environ['bottle.raw_path'] = environ['PATH_INFO']
+if py3k:
+try:
+environ['PATH_INFO'] = path.encode('latin1').decode('utf8')
+except UnicodeError:
+return HTTPError(400, 'Invalid path string. Expected UTF-8')
 try:
 environ['bottle.app'] = self
 request.bind(environ)
 response.bind()
-route, args = self.router.match(environ)
+try:
-environ['route.handle'] = environ['bottle.route'] = route
+self.trigger_hook('before_request')
-environ['route.url_args'] = args
+route, args = self.router.match(environ)
-return route.call(**args)
+environ['route.handle'] = route
+environ['bottle.route'] = route
+environ['route.url_args'] = args
+return route.call(**args)
+finally:
+self.trigger_hook('after_request')
 except HTTPResponse:
 return _e()
 except RouteReset:
 route.reset()
 return self._handle(environ)
 iterable of strings and iterable of unicodes
 """
 # Empty output is done here
 if not out:
-response['Content-Length'] = 0
+if 'Content-Length' not in response:
+response['Content-Length'] = 0
 return []
 # Join lists of byte or unicode strings. Mixed lists are NOT supported
 if isinstance(out, (tuple, list))\
 and isinstance(out[0], (bytes, unicode)):
 out = out[0][0:0].join(out) # b'abc'[0:0] -> b''
 # Encode unicode strings
 if isinstance(out, unicode):
 out = out.encode(response.charset)
 # Byte Strings are just returned
 if isinstance(out, bytes):
-response['Content-Length'] = len(out)
+if 'Content-Length' not in response:
+response['Content-Length'] = len(out)
 return [out]
 # HTTPError or HTTPException (recursive, because they may wrap anything)
 # TODO: Handle these explicitly in handle() or make them iterable.
 if isinstance(out, HTTPError):
 out.apply(response)
-out = self.error_handler.get(out.status, repr)(out)
+out = self.error_handler.get(out.status_code, self.default_error_handler)(out)
-if isinstance(out, HTTPResponse):
-depr('Error handlers must not return :exc:`HTTPResponse`.') #0.9
 return self._cast(out)
 if isinstance(out, HTTPResponse):
 out.apply(response)
-return self._cast(out.output)
+return self._cast(out.body)
 # File-like objects.
 if hasattr(out, 'read'):
 if 'wsgi.file_wrapper' in request.environ:
 return request.environ['wsgi.file_wrapper'](out)
 elif hasattr(out, 'close') or not hasattr(out, '__iter__'):
 return WSGIFileWrapper(out)
 # Handle Iterables. We peek into them to detect their inner type.
 try:
-out = iter(out)
+iout = iter(out)
-first = next(out)
+first = next(iout)
 while not first:
-first = next(out)
+first = next(iout)
 except StopIteration:
 return self._cast('')
 except HTTPResponse:
 first = _e()
 except (KeyboardInterrupt, SystemExit, MemoryError):
 first = HTTPError(500, 'Unhandled exception', _e(), format_exc())
 # These are the inner types allowed in iterator or generator objects.
 if isinstance(first, HTTPResponse):
 return self._cast(first)
-if isinstance(first, bytes):
+elif isinstance(first, bytes):
-return itertools.chain([first], out)
+new_iter = itertools.chain([first], iout)
-if isinstance(first, unicode):
+elif isinstance(first, unicode):
-return imap(lambda x: x.encode(response.charset),
+encoder = lambda x: x.encode(response.charset)
-itertools.chain([first], out))
+new_iter = imap(encoder, itertools.chain([first], iout))
-return self._cast(HTTPError(500, 'Unsupported response type: %s'\
+else:
-% type(first)))
+msg = 'Unsupported response type: %s' % type(first)
+return self._cast(HTTPError(500, msg))
+if hasattr(out, 'close'):
+new_iter = _closeiter(new_iter, out.close)
+return new_iter
 def wsgi(self, environ, start_response):
 """ The bottle WSGI-interface. """
 try:
 out = self._cast(self._handle(environ))
 # rfc2616 section 4.3
 if response._status_code in (100, 101, 204, 304)\
-or request.method == 'HEAD':
+or environ['REQUEST_METHOD'] == 'HEAD':
 if hasattr(out, 'close'): out.close()
 out = []
-if isinstance(response._status_line, unicode):
+start_response(response._status_line, response.headerlist)
-response._status_line = str(response._status_line)
-start_response(response._status_line, list(response.iter_headers()))
 return out
 except (KeyboardInterrupt, SystemExit, MemoryError):
 raise
 except Exception:
 if not self.catchall: raise
 err += '<h2>Error:</h2>\n<pre>\n%s\n</pre>\n' \
 '<h2>Traceback:</h2>\n<pre>\n%s\n</pre>\n' \
 % (html_escape(repr(_e())), html_escape(format_exc()))
 environ['wsgi.errors'].write(err)
 headers = [('Content-Type', 'text/html; charset=UTF-8')]
-start_response('500 INTERNAL SERVER ERROR', headers)
+start_response('500 INTERNAL SERVER ERROR', headers, sys.exc_info())
 return [tob(err)]
 def __call__(self, environ, start_response):
 ''' Each instance of :class:'Bottle' is a WSGI application. '''
 return self.wsgi(environ, start_response)
 ###############################################################################
 # HTTP and WSGI Tools ##########################################################
 ###############################################################################
 class BaseRequest(object):
 """ A wrapper for WSGI environment dictionaries that adds a lot of
 convenient access methods and properties. Most of them are read-only.
 __slots__ = ('environ')
 #: Maximum size of memory buffer for :attr:`body` in bytes.
 MEMFILE_MAX = 102400
-#: Maximum number pr GET or POST parameters per request
-MAX_PARAMS  = 100
 def __init__(self, environ=None):
 """ Wrap a WSGI environ dictionary. """
 #: The wrapped WSGI environ dictionary. This is the only real attribute.
 #: All other attributes actually are read-only properties.
 @DictProperty('environ', 'bottle.app', read_only=True)
 def app(self):
 ''' Bottle application handling this request. '''
 raise RuntimeError('This request is not connected to an application.')
+@DictProperty('environ', 'bottle.route', read_only=True)
+def route(self):
+""" The bottle :class:`Route` object that matches this request. """
+raise RuntimeError('This request is not connected to a route.')
+@DictProperty('environ', 'route.url_args', read_only=True)
+def url_args(self):
+""" The arguments extracted from the URL. """
+raise RuntimeError('This request is not connected to a route.')
 @property
 def path(self):
 ''' The value of ``PATH_INFO`` with exactly one prefixed slash (to fix
 broken clients and avoid the "empty path" edge case). '''
 return '/' + self.environ.get('PATH_INFO','').lstrip('/')
 @DictProperty('environ', 'bottle.request.cookies', read_only=True)
 def cookies(self):
 """ Cookies parsed into a :class:`FormsDict`. Signed cookies are NOT
 decoded. Use :meth:`get_cookie` if you expect signed cookies. """
-cookies = SimpleCookie(self.environ.get('HTTP_COOKIE',''))
+cookies = SimpleCookie(self.environ.get('HTTP_COOKIE','')).values()
-cookies = list(cookies.values())[:self.MAX_PARAMS]
 return FormsDict((c.key, c.value) for c in cookies)
 def get_cookie(self, key, default=None, secret=None):
 """ Return the content of a cookie. To read a `Signed Cookie`, the
 `secret` must match the one used to create the cookie (see
 def query(self):
 ''' The :attr:`query_string` parsed into a :class:`FormsDict`. These
 values are sometimes called "URL arguments" or "GET parameters", but
 not to be confused with "URL wildcards" as they are provided by the
 :class:`Router`. '''
-pairs = parse_qsl(self.query_string, keep_blank_values=True)
 get = self.environ['bottle.get'] = FormsDict()
-for key, value in pairs[:self.MAX_PARAMS]:
+pairs = _parse_qsl(self.environ.get('QUERY_STRING', ''))
+for key, value in pairs:
 get[key] = value
 return get
 @DictProperty('environ', 'bottle.request.forms', read_only=True)
 def forms(self):
 """ Form values parsed from an `url-encoded` or `multipart/form-data`
-encoded POST or PUT request body. The result is retuned as a
+encoded POST or PUT request body. The result is returned as a
 :class:`FormsDict`. All keys and values are strings. File uploads
 are stored separately in :attr:`files`. """
 forms = FormsDict()
 for name, item in self.POST.allitems():
-if not hasattr(item, 'filename'):
+if not isinstance(item, FileUpload):
 forms[name] = item
 return forms
 @DictProperty('environ', 'bottle.request.params', read_only=True)
 def params(self):
 params[key] = value
 return params
 @DictProperty('environ', 'bottle.request.files', read_only=True)
 def files(self):
-""" File uploads parsed from an `url-encoded` or `multipart/form-data`
+""" File uploads parsed from `multipart/form-data` encoded POST or PUT
-encoded POST or PUT request body. The values are instances of
+request body. The values are instances of :class:`FileUpload`.
-:class:`cgi.FieldStorage`. The most important attributes are:
-filename
-The filename, if specified; otherwise None; this is the client
-side filename, *not* the file name on which it is stored (that's
-a temporary file you don't deal with)
-file
-The file(-like) object from which you can read the data.
-value
-The value as a *string*; for file uploads, this transparently
-reads the file every time you request the value. Do not do this
-on big files.
 """
 files = FormsDict()
 for name, item in self.POST.allitems():
-if hasattr(item, 'filename'):
+if isinstance(item, FileUpload):
 files[name] = item
 return files
 @DictProperty('environ', 'bottle.request.json', read_only=True)
 def json(self):
 ''' If the ``Content-Type`` header is ``application/json``, this
 property holds the parsed content of the request body. Only requests
 smaller than :attr:`MEMFILE_MAX` are processed to avoid memory
 exhaustion. '''
-if 'application/json' in self.environ.get('CONTENT_TYPE', '') \
+ctype = self.environ.get('CONTENT_TYPE', '').lower().split(';')[0]
-and 0 < self.content_length < self.MEMFILE_MAX:
+if ctype == 'application/json':
-return json_loads(self.body.read(self.MEMFILE_MAX))
+b = self._get_body_string()
+if not b:
+return None
+return json_loads(b)
 return None
+def _iter_body(self, read, bufsize):
+maxread = max(0, self.content_length)
+while maxread:
+part = read(min(maxread, bufsize))
+if not part: break
+yield part
+maxread -= len(part)
+def _iter_chunked(self, read, bufsize):
+err = HTTPError(400, 'Error while parsing chunked transfer body.')
+rn, sem, bs = tob('\r\n'), tob(';'), tob('')
+while True:
+header = read(1)
+while header[-2:] != rn:
+c = read(1)
+header += c
+if not c: raise err
+if len(header) > bufsize: raise err
+size, _, _ = header.partition(sem)
+try:
+maxread = int(tonat(size.strip()), 16)
+except ValueError:
+raise err
+if maxread == 0: break
+buff = bs
+while maxread > 0:
+if not buff:
+buff = read(min(maxread, bufsize))
+part, buff = buff[:maxread], buff[maxread:]
+if not part: raise err
+yield part
+maxread -= len(part)
+if read(2) != rn:
+raise err
 @DictProperty('environ', 'bottle.request.body', read_only=True)
 def _body(self):
-maxread = max(0, self.content_length)
+body_iter = self._iter_chunked if self.chunked else self._iter_body
-stream = self.environ['wsgi.input']
+read_func = self.environ['wsgi.input'].read
-body = BytesIO() if maxread < self.MEMFILE_MAX else TemporaryFile(mode='w+b')
+body, body_size, is_temp_file = BytesIO(), 0, False
-while maxread > 0:
+for part in body_iter(read_func, self.MEMFILE_MAX):
-part = stream.read(min(maxread, self.MEMFILE_MAX))
-if not part: break
 body.write(part)
-maxread -= len(part)
+body_size += len(part)
+if not is_temp_file and body_size > self.MEMFILE_MAX:
+body, tmp = TemporaryFile(mode='w+b'), body
+body.write(tmp.getvalue())
+del tmp
+is_temp_file = True
 self.environ['wsgi.input'] = body
 body.seek(0)
 return body
+def _get_body_string(self):
+''' read body until content-length or MEMFILE_MAX into a string. Raise
+HTTPError(413) on requests that are to large. '''
+clen = self.content_length
+if clen > self.MEMFILE_MAX:
+raise HTTPError(413, 'Request to large')
+if clen < 0: clen = self.MEMFILE_MAX + 1
+data = self.body.read(clen)
+if len(data) > self.MEMFILE_MAX: # Fail fast
+raise HTTPError(413, 'Request to large')
+return data
 @property
 def body(self):
 """ The HTTP request body as a seek-able file-like object. Depending on
 :attr:`MEMFILE_MAX`, this is either a temporary file or a
 time reads and replaces the ``wsgi.input`` environ variable.
 Subsequent accesses just do a `seek(0)` on the file object. """
 self._body.seek(0)
 return self._body
+@property
+def chunked(self):
+''' True if Chunked transfer encoding was. '''
+return 'chunked' in self.environ.get('HTTP_TRANSFER_ENCODING', '').lower()
 #: An alias for :attr:`query`.
 GET = query
 @DictProperty('environ', 'bottle.request.post', read_only=True)
 def POST(self):
 """ The values of :attr:`forms` and :attr:`files` combined into a single
 :class:`FormsDict`. Values are either strings (form values) or
 instances of :class:`cgi.FieldStorage` (file uploads).
 """
 post = FormsDict()
+# We default to application/x-www-form-urlencoded for everything that
+# is not multipart and take the fast path (also: 3.1 workaround)
+if not self.content_type.startswith('multipart/'):
+pairs = _parse_qsl(tonat(self._get_body_string(), 'latin1'))
+for key, value in pairs:
+post[key] = value
+return post
 safe_env = {'QUERY_STRING':''} # Build a safe environment for cgi
 for key in ('REQUEST_METHOD', 'CONTENT_TYPE', 'CONTENT_LENGTH'):
 if key in self.environ: safe_env[key] = self.environ[key]
-if NCTextIOWrapper:
+args = dict(fp=self.body, environ=safe_env, keep_blank_values=True)
-fb = NCTextIOWrapper(self.body, encoding='ISO-8859-1', newline='\n')
+if py31:
-else:
+args['fp'] = NCTextIOWrapper(args['fp'], encoding='utf8',
-fb = self.body
+newline='\n')
-data = cgi.FieldStorage(fp=fb, environ=safe_env, keep_blank_values=True)
+elif py3k:
-for item in (data.list or [])[:self.MAX_PARAMS]:
+args['encoding'] = 'utf8'
-post[item.name] = item if item.filename else item.value
+data = cgi.FieldStorage(**args)
+self['_cgi.FieldStorage'] = data #http://bugs.python.org/issue18394#msg207958
+data = data.list or []
+for item in data:
+if item.filename:
+post[item.name] = FileUpload(item.file, item.name,
+item.filename, item.headers)
+else:
+post[item.name] = item.value
 return post
-@property
-def COOKIES(self):
-''' Alias for :attr:`cookies` (deprecated). '''
-depr('BaseRequest.COOKIES was renamed to BaseRequest.cookies (lowercase).')
-return self.cookies
 @property
 def url(self):
 """ The full request URI including hostname and scheme. If your app
 lives behind a reverse proxy or load balancer and you get confusing
 ''' The :attr:`url` string as an :class:`urlparse.SplitResult` tuple.
 The tuple contains (scheme, host, path, query_string and fragment),
 but the fragment is always empty because it is not visible to the
 server. '''
 env = self.environ
-http = env.get('wsgi.url_scheme', 'http')
+http = env.get('HTTP_X_FORWARDED_PROTO') or env.get('wsgi.url_scheme', 'http')
 host = env.get('HTTP_X_FORWARDED_HOST') or env.get('HTTP_HOST')
 if not host:
 # HTTP 1.1 requires a Host-header. This is for HTTP/1.0 clients.
 host = env.get('SERVER_NAME', '127.0.0.1')
 port = env.get('SERVER_PORT')
 def content_length(self):
 ''' The request body length as an integer. The client is responsible to
 set this header. Otherwise, the real length of the body is unknown
 and -1 is returned. In this case, :attr:`body` will be empty. '''
 return int(self.environ.get('CONTENT_LENGTH') or -1)
+@property
+def content_type(self):
+''' The Content-Type header as a lowercase-string (default: empty). '''
+return self.environ.get('CONTENT_TYPE', '').lower()
 @property
 def is_xhr(self):
 ''' True if the request was triggered by a XMLHttpRequest. This only
 works with JavaScript libraries that support the `X-Requested-With`
 ''' Search in self.environ for additional user defined attributes. '''
 try:
 var = self.environ['bottle.request.ext.%s'%name]
 return var.__get__(self) if hasattr(var, '__get__') else var
 except KeyError:
 raise AttributeError('Attribute %r not defined.' % name)
 def __setattr__(self, name, value):
 if name == 'environ': return object.__setattr__(self, name, value)
 self.environ['bottle.request.ext.%s'%name] = value
 """ Storage class for a response body as well as headers and cookies.
 This class does support dict-like case-insensitive item-access to
 headers, but is NOT a dict. Most notably, iterating over a response
 yields parts of the body and not the headers.
+:param body: The response body as one of the supported types.
+:param status: Either an HTTP status code (e.g. 200) or a status line
+including the reason phrase (e.g. '200 OK').
+:param headers: A dictionary or a list of name-value pairs.
+Additional keyword arguments are added to the list of headers.
+Underscores in the header name are replaced with dashes.
 """
 default_status = 200
 default_content_type = 'text/html; charset=UTF-8'
 204: set(('Content-Type',)),
 304: set(('Allow', 'Content-Encoding', 'Content-Language',
 'Content-Length', 'Content-Range', 'Content-Type',
 'Content-Md5', 'Last-Modified'))}
-def __init__(self, body='', status=None, **headers):
+def __init__(self, body='', status=None, headers=None, **more_headers):
-self._status_line = None
-self._status_code = None
 self._cookies = None
-self._headers = {'Content-Type': [self.default_content_type]}
+self._headers = {}
 self.body = body
 self.status = status or self.default_status
 if headers:
-for name, value in headers.items():
+if isinstance(headers, dict):
-self[name] = value
+headers = headers.items()
+for name, value in headers:
-def copy(self):
+self.add_header(name, value)
+if more_headers:
+for name, value in more_headers.items():
+self.add_header(name, value)
+def copy(self, cls=None):
 ''' Returns a copy of self. '''
-copy = Response()
+cls = cls or BaseResponse
+assert issubclass(cls, BaseResponse)
+copy = cls()
 copy.status = self.status
 copy._headers = dict((k, v[:]) for (k, v) in self._headers.items())
+if self._cookies:
+copy._cookies = SimpleCookie()
+copy._cookies.load(self._cookies.output(header=''))
 return copy
 def __iter__(self):
 return iter(self.body)
 code   = int(status.split()[0])
 else:
 raise ValueError('String status line without a reason phrase.')
 if not 100 <= code <= 999: raise ValueError('Status code out of range.')
 self._status_code = code
-self._status_line = status or ('%d Unknown' % code)
+self._status_line = str(status or ('%d Unknown' % code))
 def _get_status(self):
 return self._status_line
 status = property(_get_status, _set_status, None,
 @property
 def headers(self):
 ''' An instance of :class:`HeaderDict`, a case-insensitive dict-like
 view on the response headers. '''
-self.__dict__['headers'] = hdict = HeaderDict()
+hdict = HeaderDict()
 hdict.dict = self._headers
 return hdict
 def __contains__(self, name): return _hkey(name) in self._headers
 def __delitem__(self, name):  del self._headers[_hkey(name)]
 def get_header(self, name, default=None):
 ''' Return the value of a previously defined header. If there is no
 header with that name, return a default value. '''
 return self._headers.get(_hkey(name), [default])[-1]
-def set_header(self, name, value, append=False):
+def set_header(self, name, value):
 ''' Create a new response header, replacing any previously defined
 headers with the same name. '''
-if append:
+self._headers[_hkey(name)] = [str(value)]
-self.add_header(name, value)
-else:
-self._headers[_hkey(name)] = [str(value)]
 def add_header(self, name, value):
 ''' Add an additional response header, not removing duplicates. '''
 self._headers.setdefault(_hkey(name), []).append(str(value))
 def iter_headers(self):
 ''' Yield (header, value) tuples, skipping headers that are not
 allowed with the current response status code. '''
-headers = self._headers.items()
-bad_headers = self.bad_headers.get(self._status_code)
-if bad_headers:
-headers = [h for h in headers if h[0] not in bad_headers]
-for name, values in headers:
-for value in values:
-yield name, value
-if self._cookies:
-for c in self._cookies.values():
-yield 'Set-Cookie', c.OutputString()
-def wsgiheader(self):
-depr('The wsgiheader method is deprecated. See headerlist.') #0.10
 return self.headerlist
 @property
 def headerlist(self):
 ''' WSGI conform list of (header, value) tuples. '''
-return list(self.iter_headers())
+out = []
+headers = list(self._headers.items())
+if 'Content-Type' not in self._headers:
+headers.append(('Content-Type', [self.default_content_type]))
+if self._status_code in self.bad_headers:
+bad_headers = self.bad_headers[self._status_code]
+headers = [h for h in headers if h[0] not in bad_headers]
+out += [(name, val) for name, vals in headers for val in vals]
+if self._cookies:
+for c in self._cookies.values():
+out.append(('Set-Cookie', c.OutputString()))
+return out
 content_type = HeaderProperty('Content-Type')
 content_length = HeaderProperty('Content-Length', reader=int)
+expires = HeaderProperty('Expires',
+reader=lambda x: datetime.utcfromtimestamp(parse_date(x)),
+writer=lambda x: http_date(x))
 @property
-def charset(self):
+def charset(self, default='UTF-8'):
 """ Return the charset specified in the content-type header (default: utf8). """
 if 'charset=' in self.content_type:
 return self.content_type.split('charset=')[-1].split(';')[0].strip()
-return 'UTF-8'
+return default
-@property
-def COOKIES(self):
-""" A dict-like SimpleCookie instance. This should not be used directly.
-See :meth:`set_cookie`. """
-depr('The COOKIES dict is deprecated. Use `set_cookie()` instead.') # 0.10
-if not self._cookies:
-self._cookies = SimpleCookie()
-return self._cookies
 def set_cookie(self, name, value, secret=None, **options):
 ''' Create a new cookie or replace an old one. If the `secret` parameter is
 set, create a `Signed Cookie` (described below).
 out = ''
 for name, value in self.headerlist:
 out += '%s: %s\n' % (name.title(), value.strip())
 return out
-#: Thread-local storage for :class:`LocalRequest` and :class:`LocalResponse`
-#: attributes.
+def local_property(name=None):
-_lctx = threading.local()
+if name: depr('local_property() is deprecated and will be removed.') #0.12
+ls = threading.local()
-def local_property(name):
 def fget(self):
-try:
+try: return ls.var
-return getattr(_lctx, name)
 except AttributeError:
 raise RuntimeError("Request context not initialized.")
-def fset(self, value): setattr(_lctx, name, value)
+def fset(self, value): ls.var = value
-def fdel(self): delattr(_lctx, name)
+def fdel(self): del ls.var
-return property(fget, fset, fdel,
+return property(fget, fset, fdel, 'Thread-local property')
-'Thread-local property stored in :data:`_lctx.%s`' % name)
 class LocalRequest(BaseRequest):
 ''' A thread-local subclass of :class:`BaseRequest` with a different
-set of attribues for each thread. There is usually only one global
+set of attributes for each thread. There is usually only one global
 instance of this class (:data:`request`). If accessed during a
 request/response cycle, this instance always refers to the *current*
 request (even on a multithreaded server). '''
 bind = BaseRequest.__init__
-environ = local_property('request_environ')
+environ = local_property()
 class LocalResponse(BaseResponse):
 ''' A thread-local subclass of :class:`BaseResponse` with a different
-set of attribues for each thread. There is usually only one global
+set of attributes for each thread. There is usually only one global
 instance of this class (:data:`response`). Its attributes are used
 to build the HTTP response at the end of the request/response cycle.
 '''
 bind = BaseResponse.__init__
-_status_line = local_property('response_status_line')
+_status_line = local_property()
-_status_code = local_property('response_status_code')
+_status_code = local_property()
-_cookies     = local_property('response_cookies')
+_cookies     = local_property()
-_headers     = local_property('response_headers')
+_headers     = local_property()
-body         = local_property('response_body')
+body         = local_property()
-Response = LocalResponse # BC 0.9
-Request  = LocalRequest  # BC 0.9
+Request = BaseRequest
+Response = BaseResponse
+class HTTPResponse(Response, BottleException):
+def __init__(self, body='', status=None, headers=None, **more_headers):
+super(HTTPResponse, self).__init__(body, status, headers, **more_headers)
+def apply(self, response):
+response._status_code = self._status_code
+response._status_line = self._status_line
+response._headers = self._headers
+response._cookies = self._cookies
+response.body = self.body
+class HTTPError(HTTPResponse):
+default_status = 500
+def __init__(self, status=None, body=None, exception=None, traceback=None,
+**options):
+self.exception = exception
+self.traceback = traceback
+super(HTTPError, self).__init__(body, status, **options)
 # Plugins ######################################################################
 ###############################################################################
 class PluginError(BottleException): pass
 class JSONPlugin(object):
 name = 'json'
 api  = 2
 def __init__(self, json_dumps=json_dumps):
 self.json_dumps = json_dumps
-def apply(self, callback, context):
+def apply(self, callback, route):
 dumps = self.json_dumps
 if not dumps: return callback
 def wrapper(*a, **ka):
-rv = callback(*a, **ka)
+try:
+rv = callback(*a, **ka)
+except HTTPError:
+rv = _e()
 if isinstance(rv, dict):
 #Attempt to serialize, raises exception on failure
 json_response = dumps(rv)
 #Set content type only if serialization succesful
 response.content_type = 'application/json'
 return json_response
+elif isinstance(rv, HTTPResponse) and isinstance(rv.body, dict):
+rv.body = dumps(rv.body)
+rv.content_type = 'application/json'
 return rv
-return wrapper
-class HooksPlugin(object):
-name = 'hooks'
-api  = 2
-_names = 'before_request', 'after_request', 'app_reset'
-def __init__(self):
-self.hooks = dict((name, []) for name in self._names)
-self.app = None
-def _empty(self):
-return not (self.hooks['before_request'] or self.hooks['after_request'])
-def setup(self, app):
-self.app = app
-def add(self, name, func):
-''' Attach a callback to a hook. '''
-was_empty = self._empty()
-self.hooks.setdefault(name, []).append(func)
-if self.app and was_empty and not self._empty(): self.app.reset()
-def remove(self, name, func):
-''' Remove a callback from a hook. '''
-was_empty = self._empty()
-if name in self.hooks and func in self.hooks[name]:
-self.hooks[name].remove(func)
-if self.app and not was_empty and self._empty(): self.app.reset()
-def trigger(self, name, *a, **ka):
-''' Trigger a hook and return a list of results. '''
-hooks = self.hooks[name]
-if ka.pop('reversed', False): hooks = hooks[::-1]
-return [hook(*a, **ka) for hook in hooks]
-def apply(self, callback, context):
-if self._empty(): return callback
-def wrapper(*a, **ka):
-self.trigger('before_request')
-rv = callback(*a, **ka)
-self.trigger('after_request', reversed=True)
-return rv
 return wrapper
 class TemplatePlugin(object):
 ''' This plugin applies the :func:`view` decorator to all routes with a
 def apply(self, callback, route):
 conf = route.config.get('template')
 if isinstance(conf, (tuple, list)) and len(conf) == 2:
 return view(conf[0], **conf[1])(callback)
-elif isinstance(conf, str) and 'template_opts' in route.config:
-depr('The `template_opts` parameter is deprecated.') #0.9
-return view(conf, **route.config['template_opts'])(callback)
 elif isinstance(conf, str):
 return view(conf)(callback)
 else:
 return callback
 '__all__': [], '__loader__': self})
 sys.meta_path.append(self)
 def find_module(self, fullname, path=None):
 if '.' not in fullname: return
-packname, modname = fullname.rsplit('.', 1)
+packname = fullname.rsplit('.', 1)[0]
 if packname != self.name: return
 return self
 def load_module(self, fullname):
 if fullname in sys.modules: return sys.modules[fullname]
-packname, modname = fullname.rsplit('.', 1)
+modname = fullname.rsplit('.', 1)[1]
 realname = self.impmask % modname
 __import__(realname)
 module = sys.modules[fullname] = sys.modules[realname]
 setattr(self.module, modname, module)
 module.__loader__ = self
 #: Aliases for WTForms to mimic other multi-dict APIs (Django)
 getone = get
 getlist = getall
 class FormsDict(MultiDict):
 ''' This :class:`MultiDict` subclass is used to store request form data.
 Additionally to the normal dict-like item access methods (which return
 unmodified data as native strings), this container also supports
 attribute-like access to its values. Attributes are automatically de-
 #: and then decoded to match :attr:`input_encoding`.
 recode_unicode = True
 def _fix(self, s, encoding=None):
 if isinstance(s, unicode) and self.recode_unicode: # Python 3 WSGI
-s = s.encode('latin1')
+return s.encode('latin1').decode(encoding or self.input_encoding)
-if isinstance(s, bytes): # Python 2 WSGI
+elif isinstance(s, bytes): # Python 2 WSGI
 return s.decode(encoding or self.input_encoding)
-return s
+else:
+return s
 def decode(self, encoding=None):
 ''' Returns a copy with all keys and values de- or recoded to match
 :attr:`input_encoding`. Some libraries (e.g. WTForms) want a
 unicode dictionary. '''
 for key, value in self.allitems():
 copy.append(self._fix(key, enc), self._fix(value, enc))
 return copy
 def getunicode(self, name, default=None, encoding=None):
+''' Return the value as a unicode string, or the default. '''
 try:
 return self._fix(self[name], encoding)
 except (UnicodeError, KeyError):
 return default
 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.)
 '''
-#: List of keys that do not have a 'HTTP_' prefix.
+#: List of keys that do not have a ``HTTP_`` prefix.
 cgikeys = ('CONTENT_TYPE', 'CONTENT_LENGTH')
 def __init__(self, environ):
 self.environ = environ
 def keys(self): return [x for x in self]
 def __len__(self): return len(self.keys())
 def __contains__(self, key): return self._ekey(key) in self.environ
 class ConfigDict(dict):
-''' A dict-subclass with some extras: You can access keys like attributes.
+''' A dict-like configuration storage with additional support for
-Uppercase attributes create new ConfigDicts and act as name-spaces.
+namespaces, validators, meta-data, on_change listeners and more.
-Other missing attributes return None. Calling a ConfigDict updates its
-values and returns itself.
+This storage is optimized for fast read access. Retrieving a key
+or using non-altering dict methods (e.g. `dict.get()`) has no overhead
->>> cfg = ConfigDict()
+compared to a native dict.
->>> cfg.Namespace.value = 5
->>> cfg.OtherNamespace(a=1, b=2)
->>> cfg
-{'Namespace': {'value': 5}, 'OtherNamespace': {'a': 1, 'b': 2}}
 '''
+__slots__ = ('_meta', '_on_change')
+class Namespace(DictMixin):
+def __init__(self, config, namespace):
+self._config = config
+self._prefix = namespace
+def __getitem__(self, key):
+depr('Accessing namespaces as dicts is discouraged. '
+'Only use flat item access: '
+'cfg["names"]["pace"]["key"] -> cfg["name.space.key"]') #0.12
+return self._config[self._prefix + '.' + key]
+def __setitem__(self, key, value):
+self._config[self._prefix + '.' + key] = value
+def __delitem__(self, key):
+del self._config[self._prefix + '.' + key]
+def __iter__(self):
+ns_prefix = self._prefix + '.'
+for key in self._config:
+ns, dot, name = key.rpartition('.')
+if ns == self._prefix and name:
+yield name
+def keys(self): return [x for x in self]
+def __len__(self): return len(self.keys())
+def __contains__(self, key): return self._prefix + '.' + key in self._config
+def __repr__(self): return '<Config.Namespace %s.*>' % self._prefix
+def __str__(self): return '<Config.Namespace %s.*>' % self._prefix
+# Deprecated ConfigDict features
+def __getattr__(self, key):
+depr('Attribute access is deprecated.') #0.12
+if key not in self and key[0].isupper():
+self[key] = ConfigDict.Namespace(self._config, self._prefix + '.' + key)
+if key not in self and key.startswith('__'):
+raise AttributeError(key)
+return self.get(key)
+def __setattr__(self, key, value):
+if key in ('_config', '_prefix'):
+self.__dict__[key] = value
+return
+depr('Attribute assignment is deprecated.') #0.12
+if hasattr(DictMixin, key):
+raise AttributeError('Read-only attribute.')
+if key in self and self[key] and isinstance(self[key], self.__class__):
+raise AttributeError('Non-empty namespace attribute.')
+self[key] = value
+def __delattr__(self, key):
+if key in self:
+val = self.pop(key)
+if isinstance(val, self.__class__):
+prefix = key + '.'
+for key in self:
+if key.startswith(prefix):
+del self[prefix+key]
+def __call__(self, *a, **ka):
+depr('Calling ConfDict is deprecated. Use the update() method.') #0.12
+self.update(*a, **ka)
+return self
+def __init__(self, *a, **ka):
+self._meta = {}
+self._on_change = lambda name, value: None
+if a or ka:
+depr('Constructor does no longer accept parameters.') #0.12
+self.update(*a, **ka)
+def load_config(self, filename):
+''' Load values from an *.ini style config file.
+If the config file contains sections, their names are used as
+namespaces for the values within. The two special sections
+``DEFAULT`` and ``bottle`` refer to the root namespace (no prefix).
+'''
+conf = ConfigParser()
+conf.read(filename)
+for section in conf.sections():
+for key, value in conf.items(section):
+if section not in ('DEFAULT', 'bottle'):
+key = section + '.' + key
+self[key] = value
+return self
+def load_dict(self, source, namespace='', make_namespaces=False):
+''' Import values from a dictionary structure. Nesting can be used to
+represent namespaces.
+>>> ConfigDict().load_dict({'name': {'space': {'key': 'value'}}})
+{'name.space.key': 'value'}
+'''
+stack = [(namespace, source)]
+while stack:
+prefix, source = stack.pop()
+if not isinstance(source, dict):
+raise TypeError('Source is not a dict (r)' % type(key))
+for key, value in source.items():
+if not isinstance(key, str):
+raise TypeError('Key is not a string (%r)' % type(key))
+full_key = prefix + '.' + key if prefix else key
+if isinstance(value, dict):
+stack.append((full_key, value))
+if make_namespaces:
+self[full_key] = self.Namespace(self, full_key)
+else:
+self[full_key] = value
+return self
+def update(self, *a, **ka):
+''' If the first parameter is a string, all keys are prefixed with this
+namespace. Apart from that it works just as the usual dict.update().
+Example: ``update('some.namespace', key='value')`` '''
+prefix = ''
+if a and isinstance(a[0], str):
+prefix = a[0].strip('.') + '.'
+a = a[1:]
+for key, value in dict(*a, **ka).items():
+self[prefix+key] = value
+def setdefault(self, key, value):
+if key not in self:
+self[key] = value
+return self[key]
+def __setitem__(self, key, value):
+if not isinstance(key, str):
+raise TypeError('Key has type %r (not a string)' % type(key))
+value = self.meta_get(key, 'filter', lambda x: x)(value)
+if key in self and self[key] is value:
+return
+self._on_change(key, value)
+dict.__setitem__(self, key, value)
+def __delitem__(self, key):
+dict.__delitem__(self, key)
+def clear(self):
+for key in self:
+del self[key]
+def meta_get(self, key, metafield, default=None):
+''' Return the value of a meta field for a key. '''
+return self._meta.get(key, {}).get(metafield, default)
+def meta_set(self, key, metafield, value):
+''' Set the meta field for a key to a new value. This triggers the
+on-change handler for existing keys. '''
+self._meta.setdefault(key, {})[metafield] = value
+if key in self:
+self[key] = self[key]
+def meta_list(self, key):
+''' Return an iterable of meta field names defined for a key. '''
+return self._meta.get(key, {}).keys()
+# Deprecated ConfigDict features
 def __getattr__(self, key):
+depr('Attribute access is deprecated.') #0.12
 if key not in self and key[0].isupper():
-self[key] = ConfigDict()
+self[key] = self.Namespace(self, key)
+if key not in self and key.startswith('__'):
+raise AttributeError(key)
 return self.get(key)
 def __setattr__(self, key, value):
+if key in self.__slots__:
+return dict.__setattr__(self, key, value)
+depr('Attribute assignment is deprecated.') #0.12
 if hasattr(dict, key):
 raise AttributeError('Read-only attribute.')
-if key in self and self[key] and isinstance(self[key], ConfigDict):
+if key in self and self[key] and isinstance(self[key], self.Namespace):
 raise AttributeError('Non-empty namespace attribute.')
 self[key] = value
 def __delattr__(self, key):
-if key in self: del self[key]
+if key in self:
+val = self.pop(key)
+if isinstance(val, self.Namespace):
+prefix = key + '.'
+for key in self:
+if key.startswith(prefix):
+del self[prefix+key]
 def __call__(self, *a, **ka):
-for key, value in dict(*a, **ka).items(): setattr(self, key, value)
+depr('Calling ConfDict is deprecated. Use the update() method.') #0.12
+self.update(*a, **ka)
 return self
 class AppStack(list):
 """ A stack-like list. Calling it returns the head of the stack. """
 part = read(buff)
 if not part: return
 yield part
+class _closeiter(object):
+''' This only exists to be able to attach a .close method to iterators that
+do not support attribute assignment (most of itertools). '''
+def __init__(self, iterator, close=None):
+self.iterator = iterator
+self.close_callbacks = makelist(close)
+def __iter__(self):
+return iter(self.iterator)
+def close(self):
+for func in self.close_callbacks:
+func()
 class ResourceManager(object):
 ''' This class manages a list of search paths and helps to find and open
-aplication-bound resources (files).
+application-bound resources (files).
-:param base: default value for same-named :meth:`add_path` parameter.
+:param base: default value for :meth:`add_path` calls.
 :param opener: callable used to open resources.
 :param cachemode: controls which lookups are cached. One of 'all',
 'found' or 'none'.
 '''
 self.base = base
 self.cachemode = cachemode
 #: A list of search paths. See :meth:`add_path` for details.
 self.path = []
-#: A cache for resolved paths. `res.cache.clear()`` clears the cache.
+#: A cache for resolved paths. ``res.cache.clear()`` clears the cache.
 self.cache = {}
 def add_path(self, path, base=None, index=None, create=False):
-''' Add a new path to the list of search paths. Return False if it does
+''' Add a new path to the list of search paths. Return False if the
-not exist.
+path does not exist.
-:param path: The new search path. Relative paths are turned into an
+:param path: The new search path. Relative paths are turned into
-absolute and normalized form. If the path looks like a file (not
+an absolute and normalized form. If the path looks like a file
-ending in `/`), the filename is stripped off.
+(not ending in `/`), the filename is stripped off.
 :param base: Path used to absolutize relative search paths.
-Defaults to `:attr:base` which defaults to ``./``.
+Defaults to :attr:`base` which defaults to ``os.getcwd()``.
-:param index: Position within the list of search paths. Defaults to
+:param index: Position within the list of search paths. Defaults
-last index (appends to the list).
+to last index (appends to the list).
-:param create: Create non-existent search paths. Off by default.
 The `base` parameter makes it easy to reference files installed
 along with a python module or package::
 res.add_path('./resources/', __file__)
 '''
 base = os.path.abspath(os.path.dirname(base or self.base))
 path = os.path.abspath(os.path.join(base, os.path.dirname(path)))
 path += os.sep
 if path in self.path:
 self.path.remove(path)
 if create and not os.path.isdir(path):
-os.mkdirs(path)
+os.makedirs(path)
 if index is None:
 self.path.append(path)
 else:
 self.path.insert(index, path)
 self.cache.clear()
+return os.path.exists(path)
 def __iter__(self):
 ''' Iterate over all existing files in all registered paths. '''
 search = self.path[:]
 while search:
 def open(self, name, mode='r', *args, **kwargs):
 ''' Find a resource and return a file object, or raise IOError. '''
 fname = self.lookup(name)
 if not fname: raise IOError("Resource %r not found." % name)
-return self.opener(name, mode=mode, *args, **kwargs)
+return self.opener(fname, mode=mode, *args, **kwargs)
+class FileUpload(object):
+def __init__(self, fileobj, name, filename, headers=None):
+''' Wrapper for file uploads. '''
+#: Open file(-like) object (BytesIO buffer or temporary file)
+self.file = fileobj
+#: Name of the upload form field
+self.name = name
+#: Raw filename as sent by the client (may contain unsafe characters)
+self.raw_filename = filename
+#: A :class:`HeaderDict` with additional headers (e.g. content-type)
+self.headers = HeaderDict(headers) if headers else HeaderDict()
+content_type = HeaderProperty('Content-Type')
+content_length = HeaderProperty('Content-Length', reader=int, default=-1)
+@cached_property
+def filename(self):
+''' Name of the file on the client file system, but normalized to ensure
+file system compatibility. An empty filename is returned as 'empty'.
+Only ASCII letters, digits, dashes, underscores and dots are
+allowed in the final filename. Accents are removed, if possible.
+Whitespace is replaced by a single dash. Leading or tailing dots
+or dashes are removed. The filename is limited to 255 characters.
+'''
+fname = self.raw_filename
+if not isinstance(fname, unicode):
+fname = fname.decode('utf8', 'ignore')
+fname = normalize('NFKD', fname).encode('ASCII', 'ignore').decode('ASCII')
+fname = os.path.basename(fname.replace('\\', os.path.sep))
+fname = re.sub(r'[^a-zA-Z0-9-_.\s]', '', fname).strip()
+fname = re.sub(r'[-\s]+', '-', fname).strip('.-')
+return fname[:255] or 'empty'
+def _copy_file(self, fp, chunk_size=2**16):
+read, write, offset = self.file.read, fp.write, self.file.tell()
+while 1:
+buf = read(chunk_size)
+if not buf: break
+write(buf)
+self.file.seek(offset)
+def save(self, destination, overwrite=False, chunk_size=2**16):
+''' Save file to disk or copy its content to an open file(-like) object.
+If *destination* is a directory, :attr:`filename` is added to the
+path. Existing files are not overwritten by default (IOError).
+:param destination: File path, directory or file(-like) object.
+:param overwrite: If True, replace existing files. (default: False)
+:param chunk_size: Bytes to read at a time. (default: 64kb)
+'''
+if isinstance(destination, basestring): # Except file-likes here
+if os.path.isdir(destination):
+destination = os.path.join(destination, self.filename)
+if not overwrite and os.path.exists(destination):
+raise IOError('File exists.')
+with open(destination, 'wb') as fp:
+self._copy_file(fp, chunk_size)
+else:
+self._copy_file(destination, chunk_size)
 ###############################################################################
 # Application Helper ###########################################################
 ###############################################################################
-def abort(code=500, text='Unknown Error: Application stopped.'):
+def abort(code=500, text='Unknown Error.'):
 """ Aborts execution and causes a HTTP error. """
 raise HTTPError(code, text)
 def redirect(url, code=None):
 """ Aborts execution and causes a 303 or 302 redirect, depending on
 the HTTP protocol version. """
-if code is None:
+if not code:
 code = 303 if request.get('SERVER_PROTOCOL') == "HTTP/1.1" else 302
-location = urljoin(request.url, url)
+res = response.copy(cls=HTTPResponse)
-raise HTTPResponse("", status=code, header=dict(Location=location))
+res.status = code
+res.body = ""
+res.set_header('Location', urljoin(request.url, url))
+raise res
 def _file_iter_range(fp, offset, bytes, maxread=1024*1024):
 ''' Yield chunks from a range in a file. No chunk is bigger than maxread.'''
 fp.seek(offset)
 if not part: break
 bytes -= len(part)
 yield part
-def static_file(filename, root, mimetype='auto', download=False):
+def static_file(filename, root, mimetype='auto', download=False, charset='UTF-8'):
 """ Open a file in a safe way and return :exc:`HTTPResponse` with status
-code 200, 305, 401 or 404. Set Content-Type, Content-Encoding,
+code 200, 305, 403 or 404. The ``Content-Type``, ``Content-Encoding``,
-Content-Length and Last-Modified header. Obey If-Modified-Since header
+``Content-Length`` and ``Last-Modified`` headers are set if possible.
-and HEAD requests.
+Special support for ``If-Modified-Since``, ``Range`` and ``HEAD``
+requests.
+:param filename: Name or path of the file to send.
+:param root: Root path for file lookups. Should be an absolute directory
+path.
+:param mimetype: Defines the content-type header (default: guess from
+file extension)
+:param download: If True, ask the browser to open a `Save as...` dialog
+instead of opening the file with the associated program. You can
+specify a custom filename as a string. If not specified, the
+original filename is used (default: False).
+:param charset: The charset to use for files with a ``text/*``
+mime-type. (default: UTF-8)
 """
 root = os.path.abspath(root) + os.sep
 filename = os.path.abspath(os.path.join(root, filename.strip('/\\')))
-header = dict()
+headers = dict()
 if not filename.startswith(root):
 return HTTPError(403, "Access denied.")
 if not os.path.exists(filename) or not os.path.isfile(filename):
 return HTTPError(404, "File does not exist.")
 if not os.access(filename, os.R_OK):
 return HTTPError(403, "You do not have permission to access this file.")
 if mimetype == 'auto':
 mimetype, encoding = mimetypes.guess_type(filename)
-if mimetype: header['Content-Type'] = mimetype
+if encoding: headers['Content-Encoding'] = encoding
-if encoding: header['Content-Encoding'] = encoding
-elif mimetype:
+if mimetype:
-header['Content-Type'] = mimetype
+if mimetype[:5] == 'text/' and charset and 'charset' not in mimetype:
+mimetype += '; charset=%s' % charset
+headers['Content-Type'] = mimetype
 if download:
 download = os.path.basename(filename if download == True else download)
-header['Content-Disposition'] = 'attachment; filename="%s"' % download
+headers['Content-Disposition'] = 'attachment; filename="%s"' % download
 stats = os.stat(filename)
-header['Content-Length'] = clen = stats.st_size
+headers['Content-Length'] = clen = stats.st_size
 lm = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime(stats.st_mtime))
-header['Last-Modified'] = lm
+headers['Last-Modified'] = lm
 ims = request.environ.get('HTTP_IF_MODIFIED_SINCE')
 if ims:
 ims = parse_date(ims.split(";")[0].strip())
 if ims is not None and ims >= int(stats.st_mtime):
-header['Date'] = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime())
+headers['Date'] = time.strftime("%a, %d %b %Y %H:%M:%S GMT", time.gmtime())
-return HTTPResponse(status=304, header=header)
+return HTTPResponse(status=304, **headers)
 body = '' if request.method == 'HEAD' else open(filename, 'rb')
-header["Accept-Ranges"] = "bytes"
+headers["Accept-Ranges"] = "bytes"
 ranges = request.environ.get('HTTP_RANGE')
 if 'HTTP_RANGE' in request.environ:
 ranges = list(parse_range_header(request.environ['HTTP_RANGE'], clen))
 if not ranges:
 return HTTPError(416, "Requested Range Not Satisfiable")
 offset, end = ranges[0]
-header["Content-Range"] = "bytes %d-%d/%d" % (offset, end-1, clen)
+headers["Content-Range"] = "bytes %d-%d/%d" % (offset, end-1, clen)
-header["Content-Length"] = str(end-offset)
+headers["Content-Length"] = str(end-offset)
 if body: body = _file_iter_range(body, offset, end-offset)
-return HTTPResponse(body, header=header, status=206)
+return HTTPResponse(body, status=206, **headers)
-return HTTPResponse(body, header=header)
+return HTTPResponse(body, **headers)
 def debug(mode=True):
 """ Change the debug level.
 There is only one debug level supported at the moment."""
 global DEBUG
+if mode: warnings.simplefilter('default')
 DEBUG = bool(mode)
+def http_date(value):
+if isinstance(value, (datedate, datetime)):
+value = value.utctimetuple()
+elif isinstance(value, (int, float)):
+value = time.gmtime(value)
+if not isinstance(value, basestring):
+value = time.strftime("%a, %d %b %Y %H:%M:%S GMT", value)
+return value
 def parse_date(ims):
 """ Parse rfc1123, rfc850 and asctime timestamps and return UTC epoch. """
 try:
 ts = email.utils.parsedate_tz(ims)
 return time.mktime(ts[:8] + (0,)) - (ts[9] or 0) - time.timezone
 except (TypeError, ValueError, IndexError, OverflowError):
 return None
 def parse_auth(header):
 """ Parse rfc2617 HTTP authentication header string (basic) and return (user,pass) tuple or None"""
 try:
 method, data = header.split(None, 1)
 if 0 <= start < end <= maxlen:
 yield start, end
 except ValueError:
 pass
+def _parse_qsl(qs):
+r = []
+for pair in qs.replace(';','&').split('&'):
+if not pair: continue
+nv = pair.split('=', 1)
+if len(nv) != 2: nv.append('')
+key = urlunquote(nv[0].replace('+', ' '))
+value = urlunquote(nv[1].replace('+', ' '))
+r.append((key, value))
+return r
 def _lscmp(a, b):
 ''' Compares two strings in a cryptographically safe way:
 Runtime is not affected by length of common prefix. '''
 return not sum(0 if x==y else 1 for x, y in zip(a, b)) and len(a) == len(b)
 .replace('"','&quot;').replace("'",'&#039;')
 def html_quote(string):
 ''' Escape and quote a string to be used as an HTTP attribute.'''
-return '"%s"' % html_escape(string).replace('\n','%#10;')\
+return '"%s"' % html_escape(string).replace('\n','&#10;')\
 .replace('\r','&#13;').replace('\t','&#9;')
 def yieldroutes(func):
 """ 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'
+b(x, y)     -> '/b/<x>/<y>'
-c(x, y=5)   -> '/c/:x' and '/c/: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'
+d(x=5, y=6) -> '/d' and '/d/<x>' and '/d/<x>/<y>'
 """
-import inspect # Expensive module. Only import if necessary.
 path = '/' + func.__name__.replace('__','/').lstrip('/')
-spec = inspect.getargspec(func)
+spec = getargspec(func)
 argc = len(spec[0]) - len(spec[3] or [])
-path += ('/:%s' * argc) % tuple(spec[0][:argc])
+path += ('/<%s>' * argc) % tuple(spec[0][:argc])
 yield path
 for arg in spec[0][argc:]:
-path += '/:%s' % arg
+path += '/<%s>' % arg
 yield path
 def path_shift(script_name, path_info, shift=1):
 ''' Shift path fragments from PATH_INFO to SCRIPT_NAME and vice versa.
 new_path_info = '/' + '/'.join(pathlist)
 if path_info.endswith('/') and pathlist: new_path_info += '/'
 return new_script_name, new_path_info
-def validate(**vkargs):
-"""
-Validates and manipulates keyword arguments by user defined callables.
-Handles ValueError and missing arguments by raising HTTPError(403).
-"""
-depr('Use route wildcard filters instead.')
-def decorator(func):
-@functools.wraps(func)
-def wrapper(*args, **kargs):
-for key, value in vkargs.items():
-if key not in kargs:
-abort(403, 'Missing parameter: %s' % key)
-try:
-kargs[key] = value(kargs[key])
-except ValueError:
-abort(403, 'Wrong parameter format for: %s' % key)
-return func(*args, **kargs)
-return wrapper
-return decorator
 def auth_basic(check, realm="private", text="Access denied"):
 ''' Callback decorator to require HTTP auth (basic).
 TODO: Add route(check_auth=...) parameter. '''
 def decorator(func):
 def wrapper(*a, **ka):
 user, password = request.auth or (None, None)
 if user is None or not check(user, password):
-response.headers['WWW-Authenticate'] = 'Basic realm="%s"' % realm
+err = HTTPError(401, text)
-return HTTPError(401, text)
+err.add_header('WWW-Authenticate', 'Basic realm="%s"' % realm)
-return func(*a, **ka)
+return err
-return wrapper
+return func(*a, **ka)
+return wrapper
 return decorator
 # Shortcuts for common Bottle methods.
 # They all refer to the current default application.
 ###############################################################################
 class ServerAdapter(object):
 quiet = False
-def __init__(self, host='127.0.0.1', port=8080, **config):
+def __init__(self, host='127.0.0.1', port=8080, **options):
-self.options = config
+self.options = options
 self.host = host
 self.port = int(port)
 def run(self, handler): # pragma: no cover
 pass
 self.options.setdefault('bindAddress', (self.host, self.port))
 flup.server.fcgi.WSGIServer(handler, **self.options).run()
 class WSGIRefServer(ServerAdapter):
-def run(self, handler): # pragma: no cover
+def run(self, app): # pragma: no cover
-from wsgiref.simple_server import make_server, WSGIRequestHandler
+from wsgiref.simple_server import WSGIRequestHandler, WSGIServer
-if self.quiet:
+from wsgiref.simple_server import make_server
-class QuietHandler(WSGIRequestHandler):
+import socket
-def log_request(*args, **kw): pass
-self.options['handler_class'] = QuietHandler
+class FixedHandler(WSGIRequestHandler):
-srv = make_server(self.host, self.port, handler, **self.options)
+def address_string(self): # Prevent reverse DNS lookups please.
+return self.client_address[0]
+def log_request(*args, **kw):
+if not self.quiet:
+return WSGIRequestHandler.log_request(*args, **kw)
+handler_cls = self.options.get('handler_class', FixedHandler)
+server_cls  = self.options.get('server_class', WSGIServer)
+if ':' in self.host: # Fix wsgiref for IPv6 addresses.
+if getattr(server_cls, 'address_family') == socket.AF_INET:
+class server_cls(server_cls):
+address_family = socket.AF_INET6
+srv = make_server(self.host, self.port, app, server_cls, handler_cls)
 srv.serve_forever()
 class CherryPyServer(ServerAdapter):
 def run(self, handler): # pragma: no cover
 from cherrypy import wsgiserver
-server = wsgiserver.CherryPyWSGIServer((self.host, self.port), handler)
+self.options['bind_addr'] = (self.host, self.port)
+self.options['wsgi_app'] = handler
+certfile = self.options.get('certfile')
+if certfile:
+del self.options['certfile']
+keyfile = self.options.get('keyfile')
+if keyfile:
+del self.options['keyfile']
+server = wsgiserver.CherryPyWSGIServer(**self.options)
+if certfile:
+server.ssl_certificate = certfile
+if keyfile:
+server.ssl_private_key = keyfile
 try:
 server.start()
 finally:
 server.stop()
 class PasteServer(ServerAdapter):
 def run(self, handler): # pragma: no cover
 from paste import httpserver
-if not self.quiet:
+from paste.translogger import TransLogger
-from paste.translogger import TransLogger
+handler = TransLogger(handler, setup_console_handler=(not self.quiet))
-handler = TransLogger(handler)
 httpserver.serve(handler, host=self.host, port=str(self.port),
 **self.options)
 class MeinheldServer(ServerAdapter):
 """ The super hyped asynchronous server by facebook. Untested. """
 def run(self, handler): # pragma: no cover
 import tornado.wsgi, tornado.httpserver, tornado.ioloop
 container = tornado.wsgi.WSGIContainer(handler)
 server = tornado.httpserver.HTTPServer(container)
-server.listen(port=self.port)
+server.listen(port=self.port,address=self.host)
 tornado.ioloop.IOLoop.instance().start()
 class AppEngineServer(ServerAdapter):
 """ Adapter for Google App Engine. """
 class GeventServer(ServerAdapter):
 """ Untested. Options:
-* `monkey` (default: True) fixes the stdlib to use greenthreads.
 * `fast` (default: False) uses libevent's http server, but has some
 issues: No streaming, no pipelining, no SSL.
+* See gevent.wsgi.WSGIServer() documentation for more options.
 """
 def run(self, handler):
-from gevent import wsgi as wsgi_fast, pywsgi, monkey, local
+from gevent import wsgi, pywsgi, local
-if self.options.get('monkey', True):
+if not isinstance(threading.local(), local.local):
-if not threading.local is local.local: monkey.patch_all()
+msg = "Bottle requires gevent.monkey.patch_all() (before import)"
-wsgi = wsgi_fast if self.options.get('fast') else pywsgi
+raise RuntimeError(msg)
-log = None if self.quiet else 'default'
+if not self.options.pop('fast', None): wsgi = pywsgi
-wsgi.WSGIServer((self.host, self.port), handler, log=log).serve_forever()
+self.options['log'] = None if self.quiet else 'default'
+address = (self.host, self.port)
+server = wsgi.WSGIServer(address, handler, **self.options)
+if 'BOTTLE_CHILD' in os.environ:
+import signal
+signal.signal(signal.SIGINT, lambda s, f: server.stop())
+server.serve_forever()
+class GeventSocketIOServer(ServerAdapter):
+def run(self,handler):
+from socketio import server
+address = (self.host, self.port)
+server.SocketIOServer(address, handler, **self.options).serve_forever()
 class GunicornServer(ServerAdapter):
 """ Untested. See http://gunicorn.org/configure.html for options. """
 def run(self, handler):
 'diesel': DieselServer,
 'meinheld': MeinheldServer,
 'gunicorn': GunicornServer,
 'eventlet': EventletServer,
 'gevent': GeventServer,
+'geventSocketIO':GeventSocketIOServer,
 'rocket': RocketServer,
 'bjoern' : BjoernServer,
 'auto': AutoServer,
 }
 NORUN = nr_old
 _debug = debug
 def run(app=None, server='wsgiref', host='127.0.0.1', port=8080,
 interval=1, reloader=False, quiet=False, plugins=None,
-debug=False, **kargs):
+debug=None, **kargs):
 """ Start a server instance. This method blocks until the server terminates.
 :param app: WSGI application or target string supported by
 :func:`load_app`. (default: :func:`default_app`)
 :param server: Server adapter to use. See :data:`server_names` keys
 if os.path.exists(lockfile):
 os.unlink(lockfile)
 return
 try:
-_debug(debug)
+if debug is not None: _debug(debug)
 app = app or default_app()
 if isinstance(app, basestring):
 app = load_app(app)
 if not callable(app):
 raise ValueError("Application is not callable: %r" % app)
 @classmethod
 def search(cls, name, lookup=[]):
 """ Search name in all directories specified in lookup.
 First without, then with common extensions. Return first hit. """
-if os.path.isfile(name): return name
+if not lookup:
+depr('The template lookup path list should not be empty.') #0.12
+lookup = ['.']
+if os.path.isabs(name) and os.path.isfile(name):
+depr('Absolute template path names are deprecated.') #0.12
+return os.path.abspath(name)
 for spath in lookup:
-fname = os.path.join(spath, name)
+spath = os.path.abspath(spath) + os.sep
-if os.path.isfile(fname):
+fname = os.path.abspath(os.path.join(spath, name))
-return fname
+if not fname.startswith(spath): continue
+if os.path.isfile(fname): return fname
 for ext in cls.extensions:
 if os.path.isfile('%s.%s' % (fname, ext)):
 return '%s.%s' % (fname, ext)
 @classmethod
 def render(self, *args, **kwargs):
 """ 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)
+Local variables may be provided in dictionaries (args)
-or directly, as keywords (**kwargs).
+or directly, as keywords (kwargs).
 """
 raise NotImplementedError
 class MakoTemplate(BaseTemplate):
 self.context.vars.clear()
 return out
 class Jinja2Template(BaseTemplate):
-def prepare(self, filters=None, tests=None, **kwargs):
+def prepare(self, filters=None, tests=None, globals={}, **kwargs):
 from jinja2 import Environment, FunctionLoader
 if 'prefix' in kwargs: # TODO: to be removed after a while
 raise RuntimeError('The keyword argument `prefix` has been removed. '
 'Use the full jinja2 environment name line_statement_prefix instead.')
 self.env = Environment(loader=FunctionLoader(self.loader), **kwargs)
 if filters: self.env.filters.update(filters)
 if tests: self.env.tests.update(tests)
+if globals: self.env.globals.update(globals)
 if self.source:
 self.tpl = self.env.from_string(self.source)
 else:
 self.tpl = self.env.get_template(self.filename)
 if not fname: return
 with open(fname, "rb") as f:
 return f.read().decode(self.encoding)
-class SimpleTALTemplate(BaseTemplate):
-''' Deprecated, do not use. '''
-def prepare(self, **options):
-depr('The SimpleTAL template handler is deprecated'\
-' and will be removed in 0.12')
-from simpletal import simpleTAL
-if self.source:
-self.tpl = simpleTAL.compileHTMLTemplate(self.source)
-else:
-with open(self.filename, 'rb') as fp:
-self.tpl = simpleTAL.compileHTMLTemplate(tonat(fp.read()))
-def render(self, *args, **kwargs):
-from simpletal import simpleTALES
-for dictarg in args: kwargs.update(dictarg)
-context = simpleTALES.Context()
-for k,v in self.defaults.items():
-context.addGlobal(k, v)
-for k,v in kwargs.items():
-context.addGlobal(k, v)
-output = StringIO()
-self.tpl.expand(context, output)
-return output.getvalue()
 class SimpleTemplate(BaseTemplate):
-blocks = ('if', 'elif', 'else', 'try', 'except', 'finally', 'for', 'while',
-'with', 'def', 'class')
+def prepare(self, escape_func=html_escape, noescape=False, syntax=None, **ka):
-dedent_blocks = ('elif', 'else', 'except', 'finally')
-@lazy_attribute
-def re_pytokens(cls):
-''' This matches comments and all kinds of quoted strings but does
-NOT match comments (#...) within quoted strings. (trust me) '''
-return re.compile(r'''
-(''(?!')|""(?!")|'{6}|"{6}    # Empty strings (all 4 types)
-|'(?:[^\\']|\\.)+?'          # Single quotes (')
-|"(?:[^\\"]|\\.)+?"          # Double quotes (")
-|'{3}(?:[^\\]|\\.|\n)+?'{3}  # Triple-quoted strings (')
-|"{3}(?:[^\\]|\\.|\n)+?"{3}  # Triple-quoted strings (")
-|\#.*                        # Comments
-)''', re.VERBOSE)
-def prepare(self, escape_func=html_escape, noescape=False, **kwargs):
 self.cache = {}
 enc = self.encoding
 self._str = lambda x: touni(x, enc)
 self._escape = lambda x: escape_func(touni(x, enc))
+self.syntax = syntax
 if noescape:
 self._str, self._escape = self._escape, self._str
-@classmethod
-def split_comment(cls, code):
-""" Removes comments (#...) from python code. """
-if '#' not in code: return code
-#: Remove comments only (leave quoted strings as they are)
-subf = lambda m: '' if m.group(0)[0]=='#' else m.group(0)
-return re.sub(cls.re_pytokens, subf, code)
 @cached_property
 def co(self):
 return compile(self.code, self.filename or '<string>', 'exec')
 @cached_property
 def code(self):
-stack = [] # Current Code indentation
+source = self.source
-lineno = 0 # Current line of code
+if not source:
-ptrbuffer = [] # Buffer for printable strings and token tuple instances
+with open(self.filename, 'rb') as f:
-codebuffer = [] # Buffer for generated python code
+source = f.read()
-multiline = dedent = oneline = False
+try:
-template = self.source or open(self.filename, 'rb').read()
+source, encoding = touni(source), 'utf8'
+except UnicodeError:
-def yield_tokens(line):
+depr('Template encodings other than utf8 are no longer supported.') #0.11
-for i, part in enumerate(re.split(r'\{\{(.*?)\}\}', line)):
+source, encoding = touni(source, 'latin1'), 'latin1'
-if i % 2:
+parser = StplParser(source, encoding=encoding, syntax=self.syntax)
-if part.startswith('!'): yield 'RAW', part[1:]
+code = parser.translate()
-else: yield 'CMD', part
+self.encoding = parser.encoding
-else: yield 'TXT', part
+return code
-def flush(): # Flush the ptrbuffer
+def _rebase(self, _env, _name=None, **kwargs):
-if not ptrbuffer: return
+if _name is None:
-cline = ''
+depr('Rebase function called without arguments.'
-for line in ptrbuffer:
+' You were probably looking for {{base}}?', True) #0.12
-for token, value in line:
+_env['_rebase'] = (_name, kwargs)
-if token == 'TXT': cline += repr(value)
-elif token == 'RAW': cline += '_str(%s)' % value
+def _include(self, _env, _name=None, **kwargs):
-elif token == 'CMD': cline += '_escape(%s)' % value
+if _name is None:
-cline +=  ', '
+depr('Rebase function called without arguments.'
-cline = cline[:-2] + '\\\n'
+' You were probably looking for {{base}}?', True) #0.12
-cline = cline[:-2]
+env = _env.copy()
-if cline[:-1].endswith('\\\\\\\\\\n'):
+env.update(kwargs)
-cline = cline[:-7] + cline[-1] # 'nobr\\\\\n' --> 'nobr'
-cline = '_printlist([' + cline + '])'
-del ptrbuffer[:] # Do this before calling code() again
-code(cline)
-def code(stmt):
-for line in stmt.splitlines():
-codebuffer.append('  ' * len(stack) + line.strip())
-for line in template.splitlines(True):
-lineno += 1
-line = touni(line, self.encoding)
-sline = line.lstrip()
-if lineno <= 2:
-m = re.match(r"%\s*#.*coding[:=]\s*([-\w.]+)", sline)
-if m: self.encoding = m.group(1)
-if m: line = line.replace('coding','coding (removed)')
-if sline and sline[0] == '%' and sline[:2] != '%%':
-line = line.split('%',1)[1].lstrip() # Full line following the %
-cline = self.split_comment(line).strip()
-cmd = re.split(r'[^a-zA-Z0-9_]', cline)[0]
-flush() # You are actually reading this? Good luck, it's a mess :)
-if cmd in self.blocks or multiline:
-cmd = multiline or cmd
-dedent = cmd in self.dedent_blocks # "else:"
-if dedent and not oneline and not multiline:
-cmd = stack.pop()
-code(line)
-oneline = not cline.endswith(':') # "if 1: pass"
-multiline = cmd if cline.endswith('\\') else False
-if not oneline and not multiline:
-stack.append(cmd)
-elif cmd == 'end' and stack:
-code('#end(%s) %s' % (stack.pop(), line.strip()[3:]))
-elif cmd == 'include':
-p = cline.split(None, 2)[1:]
-if len(p) == 2:
-code("_=_include(%s, _stdout, %s)" % (repr(p[0]), p[1]))
-elif p:
-code("_=_include(%s, _stdout)" % repr(p[0]))
-else: # Empty %include -> reverse of %rebase
-code("_printlist(_base)")
-elif cmd == 'rebase':
-p = cline.split(None, 2)[1:]
-if len(p) == 2:
-code("globals()['_rebase']=(%s, dict(%s))" % (repr(p[0]), p[1]))
-elif p:
-code("globals()['_rebase']=(%s, {})" % repr(p[0]))
-else:
-code(line)
-else: # Line starting with text (not '%') or '%%' (escaped)
-if line.strip().startswith('%%'):
-line = line.replace('%%', '%', 1)
-ptrbuffer.append(yield_tokens(line))
-flush()
-return '\n'.join(codebuffer) + '\n'
-def subtemplate(self, _name, _stdout, *args, **kwargs):
-for dictarg in args: kwargs.update(dictarg)
 if _name not in self.cache:
 self.cache[_name] = self.__class__(name=_name, lookup=self.lookup)
-return self.cache[_name].execute(_stdout, kwargs)
+return self.cache[_name].execute(env['_stdout'], env)
-def execute(self, _stdout, *args, **kwargs):
+def execute(self, _stdout, kwargs):
-for dictarg in args: kwargs.update(dictarg)
 env = self.defaults.copy()
+env.update(kwargs)
 env.update({'_stdout': _stdout, '_printlist': _stdout.extend,
-'_include': self.subtemplate, '_str': self._str,
+'include': functools.partial(self._include, env),
-'_escape': self._escape, 'get': env.get,
+'rebase': functools.partial(self._rebase, env), '_rebase': None,
-'setdefault': env.setdefault, 'defined': env.__contains__})
+'_str': self._str, '_escape': self._escape, 'get': env.get,
-env.update(kwargs)
+'setdefault': env.setdefault, 'defined': env.__contains__ })
 eval(self.co, env)
-if '_rebase' in env:
+if env.get('_rebase'):
-subtpl, rargs = env['_rebase']
+subtpl, rargs = env.pop('_rebase')
-rargs['_base'] = _stdout[:] #copy stdout
+rargs['base'] = ''.join(_stdout) #copy stdout
 del _stdout[:] # clear stdout
-return self.subtemplate(subtpl,_stdout,rargs)
+return self._include(env, subtpl, **rargs)
 return env
 def render(self, *args, **kwargs):
 """ Render the template using keyword arguments as local variables. """
-for dictarg in args: kwargs.update(dictarg)
+env = {}; stdout = []
-stdout = []
+for dictarg in args: env.update(dictarg)
-self.execute(stdout, kwargs)
+env.update(kwargs)
+self.execute(stdout, env)
 return ''.join(stdout)
+class StplSyntaxError(TemplateError): pass
+class StplParser(object):
+''' Parser for stpl templates. '''
+_re_cache = {} #: Cache for compiled re patterns
+# This huge pile of voodoo magic splits python code into 8 different tokens.
+# 1: All kinds of python strings (trust me, it works)
+_re_tok = '((?m)[urbURB]?(?:\'\'(?!\')|""(?!")|\'{6}|"{6}' \
+'|\'(?:[^\\\\\']|\\\\.)+?\'|"(?:[^\\\\"]|\\\\.)+?"' \
+'|\'{3}(?:[^\\\\]|\\\\.|\\n)+?\'{3}' \
+'|"{3}(?:[^\\\\]|\\\\.|\\n)+?"{3}))'
+_re_inl = _re_tok.replace('|\\n','') # We re-use this string pattern later
+# 2: Comments (until end of line, but not the newline itself)
+_re_tok += '|(#.*)'
+# 3,4: Keywords that start or continue a python block (only start of line)
+_re_tok += '|^([ \\t]*(?:if|for|while|with|try|def|class)\\b)' \
+'|^([ \\t]*(?:elif|else|except|finally)\\b)'
+# 5: Our special 'end' keyword (but only if it stands alone)
+_re_tok += '|((?:^|;)[ \\t]*end[ \\t]*(?=(?:%(block_close)s[ \\t]*)?\\r?$|;|#))'
+# 6: A customizable end-of-code-block template token (only end of line)
+_re_tok += '|(%(block_close)s[ \\t]*(?=$))'
+# 7: And finally, a single newline. The 8th token is 'everything else'
+_re_tok += '|(\\r?\\n)'
+# Match the start tokens of code areas in a template
+_re_split = '(?m)^[ \t]*(\\\\?)((%(line_start)s)|(%(block_start)s))(%%?)'
+# Match inline statements (may contain python strings)
+_re_inl = '%%(inline_start)s((?:%s|[^\'"\n]*?)+)%%(inline_end)s' % _re_inl
+default_syntax = '<% %> % {{ }}'
+def __init__(self, source, syntax=None, encoding='utf8'):
+self.source, self.encoding = touni(source, encoding), encoding
+self.set_syntax(syntax or self.default_syntax)
+self.code_buffer, self.text_buffer = [], []
+self.lineno, self.offset = 1, 0
+self.indent, self.indent_mod = 0, 0
+def get_syntax(self):
+''' Tokens as a space separated string (default: <% %> % {{ }}) '''
+return self._syntax
+def set_syntax(self, syntax):
+self._syntax = syntax
+self._tokens = syntax.split()
+if not syntax in self._re_cache:
+names = 'block_start block_close line_start inline_start inline_end'
+etokens = map(re.escape, self._tokens)
+pattern_vars = dict(zip(names.split(), etokens))
+patterns = (self._re_split, self._re_tok, self._re_inl)
+patterns = [re.compile(p%pattern_vars) for p in patterns]
+self._re_cache[syntax] = patterns
+self.re_split, self.re_tok, self.re_inl = self._re_cache[syntax]
+syntax = property(get_syntax, set_syntax)
+def translate(self):
+if self.offset: raise RuntimeError('Parser is a one time instance.')
+while True:
+m = self.re_split.search(self.source[self.offset:])
+if m:
+text = self.source[self.offset:self.offset+m.start()]
+self.text_buffer.append(text)
+self.offset += m.end()
+if m.group(1): # New escape syntax
+line, sep, _ = self.source[self.offset:].partition('\n')
+self.text_buffer.append(m.group(2)+m.group(5)+line+sep)
+self.offset += len(line+sep)+1
+continue
+elif m.group(5): # Old escape syntax
+depr('Escape code lines with a backslash.') #0.12
+line, sep, _ = self.source[self.offset:].partition('\n')
+self.text_buffer.append(m.group(2)+line+sep)
+self.offset += len(line+sep)+1
+continue
+self.flush_text()
+self.read_code(multiline=bool(m.group(4)))
+else: break
+self.text_buffer.append(self.source[self.offset:])
+self.flush_text()
+return ''.join(self.code_buffer)
+def read_code(self, multiline):
+code_line, comment = '', ''
+while True:
+m = self.re_tok.search(self.source[self.offset:])
+if not m:
+code_line += self.source[self.offset:]
+self.offset = len(self.source)
+self.write_code(code_line.strip(), comment)
+return
+code_line += self.source[self.offset:self.offset+m.start()]
+self.offset += m.end()
+_str, _com, _blk1, _blk2, _end, _cend, _nl = m.groups()
+if code_line and (_blk1 or _blk2): # a if b else c
+code_line += _blk1 or _blk2
+continue
+if _str:    # Python string
+code_line += _str
+elif _com:  # Python comment (up to EOL)
+comment = _com
+if multiline and _com.strip().endswith(self._tokens[1]):
+multiline = False # Allow end-of-block in comments
+elif _blk1: # Start-block keyword (if/for/while/def/try/...)
+code_line, self.indent_mod = _blk1, -1
+self.indent += 1
+elif _blk2: # Continue-block keyword (else/elif/except/...)
+code_line, self.indent_mod = _blk2, -1
+elif _end:  # The non-standard 'end'-keyword (ends a block)
+self.indent -= 1
+elif _cend: # The end-code-block template token (usually '%>')
+if multiline: multiline = False
+else: code_line += _cend
+else: # \n
+self.write_code(code_line.strip(), comment)
+self.lineno += 1
+code_line, comment, self.indent_mod = '', '', 0
+if not multiline:
+break
+def flush_text(self):
+text = ''.join(self.text_buffer)
+del self.text_buffer[:]
+if not text: return
+parts, pos, nl = [], 0, '\\\n'+'  '*self.indent
+for m in self.re_inl.finditer(text):
+prefix, pos = text[pos:m.start()], m.end()
+if prefix:
+parts.append(nl.join(map(repr, prefix.splitlines(True))))
+if prefix.endswith('\n'): parts[-1] += nl
+parts.append(self.process_inline(m.group(1).strip()))
+if pos < len(text):
+prefix = text[pos:]
+lines = prefix.splitlines(True)
+if lines[-1].endswith('\\\\\n'): lines[-1] = lines[-1][:-3]
+elif lines[-1].endswith('\\\\\r\n'): lines[-1] = lines[-1][:-4]
+parts.append(nl.join(map(repr, lines)))
+code = '_printlist((%s,))' % ', '.join(parts)
+self.lineno += code.count('\n')+1
+self.write_code(code)
+def process_inline(self, chunk):
+if chunk[0] == '!': return '_str(%s)' % chunk[1:]
+return '_escape(%s)' % chunk
+def write_code(self, line, comment=''):
+line, comment = self.fix_backward_compatibility(line, comment)
+code  = '  ' * (self.indent+self.indent_mod)
+code += line.lstrip() + comment + '\n'
+self.code_buffer.append(code)
+def fix_backward_compatibility(self, line, comment):
+parts = line.strip().split(None, 2)
+if parts and parts[0] in ('include', 'rebase'):
+depr('The include and rebase keywords are functions now.') #0.12
+if len(parts) == 1:   return "_printlist([base])", comment
+elif len(parts) == 2: return "_=%s(%r)" % tuple(parts), comment
+else:                 return "_=%s(%r, %s)" % tuple(parts), comment
+if self.lineno <= 2 and not line.strip() and 'coding' in comment:
+m = re.match(r"#.*coding[:=]\s*([-\w.]+)", comment)
+if m:
+depr('PEP263 encoding strings in templates are deprecated.') #0.12
+enc = m.group(1)
+self.source = self.source.encode(self.encoding).decode(enc)
+self.encoding = enc
+return line, comment.replace('coding','coding*')
+return line, comment
 def template(*args, **kwargs):
 '''
 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).
 '''
 tpl = args[0] if args else None
-template_adapter = kwargs.pop('template_adapter', SimpleTemplate)
+adapter = kwargs.pop('template_adapter', SimpleTemplate)
-if tpl not in TEMPLATES or DEBUG:
+lookup = kwargs.pop('template_lookup', TEMPLATE_PATH)
+tplid = (id(lookup), tpl)
+if tplid not in TEMPLATES or DEBUG:
 settings = kwargs.pop('template_settings', {})
-lookup = kwargs.pop('template_lookup', TEMPLATE_PATH)
+if isinstance(tpl, adapter):
-if isinstance(tpl, template_adapter):
+TEMPLATES[tplid] = tpl
-TEMPLATES[tpl] = tpl
+if settings: TEMPLATES[tplid].prepare(**settings)
-if settings: TEMPLATES[tpl].prepare(**settings)
 elif "\n" in tpl or "{" in tpl or "%" in tpl or '$' in tpl:
-TEMPLATES[tpl] = template_adapter(source=tpl, lookup=lookup, **settings)
+TEMPLATES[tplid] = adapter(source=tpl, lookup=lookup, **settings)
 else:
-TEMPLATES[tpl] = template_adapter(name=tpl, lookup=lookup, **settings)
+TEMPLATES[tplid] = adapter(name=tpl, lookup=lookup, **settings)
-if not TEMPLATES[tpl]:
+if not TEMPLATES[tplid]:
 abort(500, 'Template (%s) not found' % tpl)
 for dictarg in args[1:]: kwargs.update(dictarg)
-return TEMPLATES[tpl].render(kwargs)
+return TEMPLATES[tplid].render(kwargs)
 mako_template = functools.partial(template, template_adapter=MakoTemplate)
 cheetah_template = functools.partial(template, template_adapter=CheetahTemplate)
 jinja2_template = functools.partial(template, template_adapter=Jinja2Template)
-simpletal_template = functools.partial(template, template_adapter=SimpleTALTemplate)
 def view(tpl_name, **defaults):
 ''' Decorator: renders a template for a handler.
 The handler can control its behavior like that:
 result = func(*args, **kwargs)
 if isinstance(result, (dict, DictMixin)):
 tplvars = defaults.copy()
 tplvars.update(result)
 return template(tpl_name, **tplvars)
+elif result is None:
+return template(tpl_name, defaults)
 return result
 return wrapper
 return decorator
 mako_view = functools.partial(view, template_adapter=MakoTemplate)
 cheetah_view = functools.partial(view, template_adapter=CheetahTemplate)
 jinja2_view = functools.partial(view, template_adapter=Jinja2Template)
-simpletal_view = functools.partial(view, template_adapter=SimpleTALTemplate)
 NORUN = False # If set, run() does nothing. Used by load_app()
 #: A dict to map HTTP status codes (e.g. 404) to phrases (e.g. 'Not Found')
 HTTP_CODES = httplib.responses
 HTTP_CODES[418] = "I'm a teapot" # RFC 2324
+HTTP_CODES[422] = "Unprocessable Entity" # RFC 4918
 HTTP_CODES[428] = "Precondition Required"
 HTTP_CODES[429] = "Too Many Requests"
 HTTP_CODES[431] = "Request Header Fields Too Large"
 HTTP_CODES[511] = "Network Authentication Required"
 _HTTP_STATUS_LINES = dict((k, '%d %s'%(k,v)) for (k,v) in HTTP_CODES.items())
 #: The default template used for error pages. Override with @error()
 ERROR_PAGE_TEMPLATE = """
 %%try:
 %%from %s import DEBUG, HTTP_CODES, request, touni
-%%status_name = HTTP_CODES.get(e.status, 'Unknown').title()
 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
 <html>
 <head>
-<title>Error {{e.status}}: {{status_name}}</title>
+<title>Error: {{e.status}}</title>
 <style type="text/css">
 html {background-color: #eee; font-family: sans;}
 body {background-color: #fff; border: 1px solid #ddd;
 padding: 15px; margin: 15px;}
 pre {background-color: #eee; border: 1px solid #ddd; padding: 5px;}
 </style>
 </head>
 <body>
-<h1>Error {{e.status}}: {{status_name}}</h1>
+<h1>Error: {{e.status}}</h1>
 <p>Sorry, the requested URL <tt>{{repr(request.url)}}</tt>
 caused an error:</p>
-<pre>{{e.output}}</pre>
+<pre>{{e.body}}</pre>
 %%if DEBUG and e.exception:
 <h2>Exception:</h2>
 <pre>{{repr(e.exception)}}</pre>
 %%end
 %%if DEBUG and e.traceback:
 <b>ImportError:</b> Could not generate the error page. Please add bottle to
 the import path.
 %%end
 """ % __name__
 #: A thread-safe instance of :class:`LocalRequest`. If accessed from within a
 #: request callback, this instance always refers to the *current* request
 #: (even on a multithreaded server).
 request = LocalRequest()
 #: A thread-safe instance of :class:`LocalResponse`. It is used to change the
 app = default_app = AppStack()
 app.push()
 #: A virtual package that redirects import statements.
 #: Example: ``import bottle.ext.sqlite`` actually imports `bottle_sqlite`.
-ext = _ImportRedirect(__name__+'.ext', 'bottle_%s').module
+ext = _ImportRedirect('bottle.ext' if __name__ == '__main__' else __name__+".ext", 'bottle_%s').module
 if __name__ == '__main__':
 opt, args, parser = _cmd_options, _cmd_args, _cmd_parser
 if opt.version:
 _stdout('Bottle %s\n'%__version__)
 sys.path.insert(0, '.')
 sys.modules.setdefault('bottle', sys.modules['__main__'])
 host, port = (opt.bind or 'localhost'), 8080
-if ':' in host:
+if ':' in host and host.rfind(']') < host.rfind(':'):
 host, port = host.rsplit(':', 1)
+host = host.strip('[]')
-run(args[0], host=host, port=port, server=opt.server,
+run(args[0], host=host, port=int(port), server=opt.server,
 reloader=opt.reload, plugins=opt.plugin, debug=opt.debug)

Mercurial > templog

comparison web/bottle.py @ 248:317a1738f15c