-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmiddleware.html
162 lines (152 loc) · 6.55 KB
/
middleware.html
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Middleware — pyroutes v0.4.1 documentation</title>
<link rel="stylesheet" href="static/pyroutes.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.4.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="static/jquery.js"></script>
<script type="text/javascript" src="static/underscore.js"></script>
<script type="text/javascript" src="static/doctools.js"></script>
<link rel="top" title="pyroutes v0.4.1 documentation" href="index.html" />
<link rel="next" title="Route handling" href="reference/pyroutes.html" />
<link rel="prev" title="Deployment" href="deployment.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference/pyroutes.html" title="Route handling"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="deployment.html" title="Deployment"
accesskey="P">previous</a> |</li>
<li><a href="index.html">pyroutes v0.4.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="middleware">
<span id="id1"></span><h1>Middleware<a class="headerlink" href="#middleware" title="Permalink to this headline">¶</a></h1>
<p>Middleware is run around each request processing.</p>
<p>In Python we can display this as:</p>
<div class="highlight-python"><pre>Outer(Middle(Inner(final_method)))(my param)</pre>
</div>
<p>Each layer calls the next with the the same parameters as it
was called with, and returns the same. This allows us
to edit requests and responses globally with ease.</p>
<div class="section" id="adding-middleware">
<h2>Adding middleware<a class="headerlink" href="#adding-middleware" title="Permalink to this headline">¶</a></h2>
<p>Adding middleware is done by modifying the project settings.
See <a class="reference internal" href="reference/settings.html#pyroutes-settings"><em>Settings</em></a> for more information about this.</p>
</div>
<div class="section" id="creating-your-own">
<h2>Creating your own<a class="headerlink" href="#creating-your-own" title="Permalink to this headline">¶</a></h2>
<p>Creating your own middleware is quite easy. Let’s create
a simple logging middleware as an example.</p>
<div class="highlight-python"><pre>import logging
class LoggingMiddleware(object):
def __init__(self, passthrough):
self.logger = logging.getLogger()
self.logger.addHandler(logging.FileHandler('/tmp/mylog.txt'))
self.logger.setLevel(logging.DEBUG)
self.passthrough = passthrough
def __call__(self, request):
self.logger.debug('Got request %s', request)
response = self.passthrough(request)
self.logger.debug('Got response %s', response)
return response</pre>
</div>
<p>So, what’s going on here?</p>
<p>Every middleware must accept a <tt class="docutils literal"><span class="pre">passthrough</span></tt> parameter. This is the
next method in the middleware chain (or the handler itself).
In the <tt class="docutils literal"><span class="pre">__call__</span></tt> method we accept a mandatory <tt class="docutils literal"><span class="pre">request</span></tt> parameter,
and return the result of the <tt class="docutils literal"><span class="pre">passthrough</span></tt>-method, called with <tt class="docutils literal"><span class="pre">request</span></tt>
as it’s parameter.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Middleware</a><ul>
<li><a class="reference internal" href="#adding-middleware">Adding middleware</a></li>
<li><a class="reference internal" href="#creating-your-own">Creating your own</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="deployment.html"
title="previous chapter">Deployment</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="reference/pyroutes.html"
title="next chapter">Route handling</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="sources/middleware.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference/pyroutes.html" title="Route handling"
>next</a> |</li>
<li class="right" >
<a href="deployment.html" title="Deployment"
>previous</a> |</li>
<li><a href="index.html">pyroutes v0.4.1 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2010, Kristian Klette.
Last updated on Apr 17, 2011.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
</div>
</body>
</html>