1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
"""
Provides common classes and functions most users will want access to.
"""
import threadinglocal, sys
if sys.version < '2.4':
class _RequestConfig(object):
__shared_state = threadinglocal.local()
def __getattr__(self, name):
return self.__shared_state.__getattr__(name)
def __setattr__(self, name, value):
return self.__shared_state.__setattr__(name, value)
else:
class _RequestConfig(object):
__shared_state = threadinglocal.local()
def __getattr__(self, name):
return self.__shared_state.__getattribute__(name)
def __setattr__(self, name, value):
return self.__shared_state.__setattr__(name, value)
def request_config(original=False):
"""
Returns the Routes RequestConfig object.
The Routes RequestConfig object is a thread-local singleton that should be initialized by
the web framework that is utilizing Routes.
To get the Routes RequestConfig:
>>> from routes import *
>>> config = routes.request_config()
The following attributes must be set on the config object every request:
mapper
mapper should be a Mapper instance thats ready for use
host
host is the hostname of the webapp
protocol
protocol is the protocol of the current request
mapper_dict
mapper_dict should be the dict returned by mapper.match()
redirect
redirect should be a function that issues a redirect,
and takes a url as the sole argument
prefix (optional)
Set if the application is moved under a URL prefix. Prefix
will be stripped before matching, and prepended on generation
environ (optional)
Set to the WSGI environ for automatic prefix support if the
webapp is underneath a 'SCRIPT_NAME'
If you have your own request local object that you'd like to use instead of the default
thread local provided by Routes, you can configure Routes to use it::
from routes import request_config()
config = request_config()
if hasattr(config, 'using_request_local'):
config.request_local = YourLocalCallable
config = request_config()
Once you have configured request_config, its advisable you retrieve it again to get the
object you wanted. The variable you assign to request_local is assumed to be a callable
that will get the local config object you wish.
"""
obj = _RequestConfig()
if hasattr(obj, 'request_local') and original is False:
return getattr(obj, 'request_local')()
else:
obj.using_request_local = False
return _RequestConfig()
from base import Mapper
from util import url_for, redirect_to
__all__=['Mapper', 'url_for', 'redirect_to', 'request_config']
|