<!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>A Do-It-Yourself Framework — Paste 1.7.5.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7.5.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="Paste 1.7.5.1 documentation" href="index.html" />
<link rel="next" title="The Paste HTTP Server Thread Pool" href="paste-httpserver-threadpool.html" />
<link rel="prev" title="URL Parsing With WSGI And Paste" href="url-parsing-with-wsgi.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
<link rel="stylesheet" type="text/css"
href="_static/paste.css.html">
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="a-do-it-yourself-framework">
<h1><a class="toc-backref" href="#id2">A Do-It-Yourself Framework</a><a class="headerlink" href="#a-do-it-yourself-framework" title="Permalink to this headline">¶</a></h1>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Ian Bicking <<a class="reference external" href="mailto:ianb%40colorstudy.com">ianb<span>@</span>colorstudy<span>.</span>com</a>></td>
</tr>
<tr class="field-even field"><th class="field-name">revision:</th><td class="field-body">$Rev$</td>
</tr>
<tr class="field-odd field"><th class="field-name">date:</th><td class="field-body">$LastChangedDate$</td>
</tr>
</tbody>
</table>
<p>This tutorial has been translated <a class="reference external" href="http://montegasppa.blogspot.com/2007/06/um-framework-faa-voc-mesmo.html">into Portuguese</a>.</p>
<p>A newer version of this article is available <a class="reference external" href="http://pythonpaste.org/webob/do-it-yourself.html">using WebOb</a>.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#a-do-it-yourself-framework" id="id2">A Do-It-Yourself Framework</a><ul>
<li><a class="reference internal" href="#introduction-and-audience" id="id3">Introduction and Audience</a></li>
<li><a class="reference internal" href="#what-is-wsgi" id="id4">What is WSGI?</a></li>
<li><a class="reference internal" href="#writing-a-wsgi-application" id="id5">Writing a WSGI Application</a><ul>
<li><a class="reference internal" href="#an-interactive-app" id="id6">An Interactive App</a></li>
</ul>
</li>
<li><a class="reference internal" href="#now-for-a-framework" id="id7">Now For a Framework</a><ul>
<li><a class="reference internal" href="#object-publishing" id="id8">Object Publishing</a></li>
<li><a class="reference internal" href="#the-path" id="id9">The Path</a></li>
<li><a class="reference internal" href="#taking-it-for-a-ride" id="id10">Taking It For a Ride</a></li>
<li><a class="reference internal" href="#give-me-more" id="id11">Give Me More!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#wsgi-middleware" id="id12">WSGI Middleware</a><ul>
<li><a class="reference internal" href="#give-me-more-middleware" id="id13">Give Me More Middleware!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#conclusion" id="id14">Conclusion</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="introduction-and-audience">
<h2><a class="toc-backref" href="#id3">Introduction and Audience</a><a class="headerlink" href="#introduction-and-audience" title="Permalink to this headline">¶</a></h2>
<p>This short tutorial is meant to teach you a little about WSGI, and as
an example a bit about the architecture that Paste has enabled and
encourages.</p>
<p>This isn’t an introduction to all the parts of Paste – in fact, we’ll
only use a few, and explain each part. This isn’t to encourage
everyone to go off and make their own framework (though honestly I
wouldn’t mind). The goal is that when you have finished reading this
you feel more comfortable with some of the frameworks built using this
architecture, and a little more secure that you will understand the
internals if you look under the hood.</p>
</div>
<div class="section" id="what-is-wsgi">
<h2><a class="toc-backref" href="#id4">What is WSGI?</a><a class="headerlink" href="#what-is-wsgi" title="Permalink to this headline">¶</a></h2>
<p>At its simplest WSGI is an interface between web servers and web
applications. We’ll explain the mechanics of WSGI below, but a higher
level view is to say that WSGI lets code pass around web requests in a
fairly formal way. But there’s more! WSGI is more than just HTTP.
It might seem like it is just <em>barely</em> more than HTTP, but that little
bit is important:</p>
<ul class="simple">
<li>You pass around a CGI-like environment, which means data like
<code class="docutils literal"><span class="pre">REMOTE_USER</span></code> (the logged-in username) can be securely passed
about.</li>
<li>A CGI-like environment can be passed around with more context –
specifically instead of just one path you two: <code class="docutils literal"><span class="pre">SCRIPT_NAME</span></code> (how
we got here) and <code class="docutils literal"><span class="pre">PATH_INFO</span></code> (what we have left).</li>
<li>You can – and often should – put your own extensions into the WSGI
environment. This allows for callbacks, extra information,
arbitrary Python objects, or whatever you want. These are things
you can’t put in custom HTTP headers.</li>
</ul>
<p>This means that WSGI can be used not just between a web server an an
application, but can be used at all levels for communication. This
allows web applications to become more like libraries – well
encapsulated and reusable, but still with rich reusable functionality.</p>
</div>
<div class="section" id="writing-a-wsgi-application">
<h2><a class="toc-backref" href="#id5">Writing a WSGI Application</a><a class="headerlink" href="#writing-a-wsgi-application" title="Permalink to this headline">¶</a></h2>
<p>The first part is about how to use <a class="reference external" href="http://www.python.org/peps/pep-0333.html">WSGI</a> at its most basic. You
can read the spec, but I’ll do a very brief summary:</p>
<ul class="simple">
<li>You will be writing a <em>WSGI application</em>. That’s an object that
responds to requests. An application is just a callable object
(like a function) that takes two arguments: <code class="docutils literal"><span class="pre">environ</span></code> and
<code class="docutils literal"><span class="pre">start_response</span></code>.</li>
<li>The environment looks a lot like a CGI environment, with keys like
<code class="docutils literal"><span class="pre">REQUEST_METHOD</span></code>, <code class="docutils literal"><span class="pre">HTTP_HOST</span></code>, etc.</li>
<li>The environment also has some special keys like <code class="docutils literal"><span class="pre">wsgi.input</span></code> (the
input stream, like the body of a POST request).</li>
<li><code class="docutils literal"><span class="pre">start_response</span></code> is a function that starts the response – you
give the status and headers here.</li>
<li>Lastly the application returns an iterator with the body response
(commonly this is just a list of strings, or just a list containing
one string that is the entire body.)</li>
</ul>
<p>So, here’s a simple application:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s">'content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Hello world!'</span><span class="p">]</span>
</pre></div>
</div>
<p>Well... that’s unsatisfying. Sure, you can imagine what it does, but
you can’t exactly point your web browser at it.</p>
<p>There’s other cleaner ways to do this, but this tutorial isn’t about
<em>clean</em> it’s about <em>easy-to-understand</em>. So just add this to the
bottom of your file:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">paste</span> <span class="kn">import</span> <span class="n">httpserver</span>
<span class="n">httpserver</span><span class="o">.</span><span class="n">serve</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s">'8080'</span><span class="p">)</span>
</pre></div>
</div>
<p>Now visit <a class="reference external" href="http://localhost:8080">http://localhost:8080</a> and you should see your new app.
If you want to understand how a WSGI server works, I’d recommend
looking at the <a class="reference external" href="http://www.python.org/peps/pep-0333.html#the-server-gateway-side">CGI WSGI server</a>
in the WSGI spec.</p>
<div class="section" id="an-interactive-app">
<h3><a class="toc-backref" href="#id6">An Interactive App</a><a class="headerlink" href="#an-interactive-app" title="Permalink to this headline">¶</a></h3>
<p>That last app wasn’t very interesting. Let’s at least make it
interactive. To do that we’ll give a form, and then parse the form
fields:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">paste.request</span> <span class="kn">import</span> <span class="n">parse_formvars</span>
<span class="k">def</span> <span class="nf">app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="n">parse_formvars</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="k">if</span> <span class="n">environ</span><span class="p">[</span><span class="s">'REQUEST_METHOD'</span><span class="p">]</span> <span class="o">==</span> <span class="s">'POST'</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s">'content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'Hello, '</span><span class="p">,</span> <span class="n">fields</span><span class="p">[</span><span class="s">'name'</span><span class="p">],</span> <span class="s">'!'</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s">'content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">'<form method="POST">Name: <input type="text" '</span>
<span class="s">'name="name"><input type="submit"></form>'</span><span class="p">]</span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">parse_formvars</span></code> function just takes the WSGI environment and
calls the <a class="reference external" href="http://python.org/doc/current/lib/module-cgi.html">cgi</a>
module (the <code class="docutils literal"><span class="pre">FieldStorage</span></code> class) and turns that into a MultiDict.</p>
</div>
</div>
<div class="section" id="now-for-a-framework">
<h2><a class="toc-backref" href="#id7">Now For a Framework</a><a class="headerlink" href="#now-for-a-framework" title="Permalink to this headline">¶</a></h2>
<p>Now, this probably feels a bit crude. After all, we’re testing for
things like REQUEST_METHOD to handle more than one thing, and it’s
unclear how you can have more than one page.</p>
<p>We want to build a framework, which is just a kind of generic
application. In this tutorial we’ll implement an <em>object publisher</em>,
which is something you may have seen in Zope, Quixote, or CherryPy.</p>
<div class="section" id="object-publishing">
<h3><a class="toc-backref" href="#id8">Object Publishing</a><a class="headerlink" href="#object-publishing" title="Permalink to this headline">¶</a></h3>
<p>In a typical Python object publisher you translate <code class="docutils literal"><span class="pre">/</span></code> to <code class="docutils literal"><span class="pre">.</span></code>. So
<code class="docutils literal"><span class="pre">/articles/view?id=5</span></code> turns into <code class="docutils literal"><span class="pre">root.articles.view(id=5)</span></code>. We
have to start with some root object, of course, which we’ll pass in...</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ObjectPublisher</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">root</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">root</span> <span class="o">=</span> <span class="n">root</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="o">...</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">ObjectPublisher</span><span class="p">(</span><span class="n">my_root_object</span><span class="p">)</span>
</pre></div>
</div>
<p>We override <code class="docutils literal"><span class="pre">__call__</span></code> to make instances of <code class="docutils literal"><span class="pre">ObjectPublisher</span></code>
callable objects, just like a function, and just like WSGI
applications. Now all we have to do is translate that <code class="docutils literal"><span class="pre">environ</span></code>
into the thing we are publishing, then call that thing, then turn the
response into what WSGI wants.</p>
</div>
<div class="section" id="the-path">
<h3><a class="toc-backref" href="#id9">The Path</a><a class="headerlink" href="#the-path" title="Permalink to this headline">¶</a></h3>
<p>WSGI puts the requested path into two variables: <code class="docutils literal"><span class="pre">SCRIPT_NAME</span></code> and
<code class="docutils literal"><span class="pre">PATH_INFO</span></code>. <code class="docutils literal"><span class="pre">SCRIPT_NAME</span></code> is everything that was used up
<em>getting here</em>. <code class="docutils literal"><span class="pre">PATH_INFO</span></code> is everything left over – it’s
the part the framework should be using to find the object. If you put
the two back together, you get the full path used to get to where we
are right now; this is very useful for generating correct URLs, and
we’ll make sure we preserve this.</p>
<p>So here’s how we might implement <code class="docutils literal"><span class="pre">__call__</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="n">parse_formvars</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_object</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
<span class="n">response_body</span> <span class="o">=</span> <span class="n">obj</span><span class="p">(</span><span class="o">**</span><span class="n">fields</span><span class="o">.</span><span class="n">mixed</span><span class="p">())</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s">'content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="n">response_body</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">find_object</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">obj</span><span class="p">,</span> <span class="n">environ</span><span class="p">):</span>
<span class="n">path_info</span> <span class="o">=</span> <span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'PATH_INFO'</span><span class="p">,</span> <span class="s">''</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">path_info</span> <span class="ow">or</span> <span class="n">path_info</span> <span class="o">==</span> <span class="s">'/'</span><span class="p">:</span>
<span class="c"># We've arrived!</span>
<span class="k">return</span> <span class="n">obj</span>
<span class="c"># PATH_INFO always starts with a /, so we'll get rid of it:</span>
<span class="n">path_info</span> <span class="o">=</span> <span class="n">path_info</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s">'/'</span><span class="p">)</span>
<span class="c"># Then split the path into the "next" chunk, and everything</span>
<span class="c"># after it ("rest"):</span>
<span class="n">parts</span> <span class="o">=</span> <span class="n">path_info</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'/'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="nb">next</span> <span class="o">=</span> <span class="n">parts</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">parts</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="n">rest</span> <span class="o">=</span> <span class="s">''</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">rest</span> <span class="o">=</span> <span class="s">'/'</span> <span class="o">+</span> <span class="n">parts</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="c"># Hide private methods/attributes:</span>
<span class="k">assert</span> <span class="ow">not</span> <span class="nb">next</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s">'_'</span><span class="p">)</span>
<span class="c"># Now we get the attribute; getattr(a, 'b') is equivalent</span>
<span class="c"># to a.b...</span>
<span class="n">next_obj</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="nb">next</span><span class="p">)</span>
<span class="c"># Now fix up SCRIPT_NAME and PATH_INFO...</span>
<span class="n">environ</span><span class="p">[</span><span class="s">'SCRIPT_NAME'</span><span class="p">]</span> <span class="o">+=</span> <span class="s">'/'</span> <span class="o">+</span> <span class="nb">next</span>
<span class="n">environ</span><span class="p">[</span><span class="s">'PATH_INFO'</span><span class="p">]</span> <span class="o">=</span> <span class="n">rest</span>
<span class="c"># and now parse the remaining part of the URL...</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_object</span><span class="p">(</span><span class="n">next_obj</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
</pre></div>
</div>
<p>And that’s it, we’ve got a framework.</p>
</div>
<div class="section" id="taking-it-for-a-ride">
<h3><a class="toc-backref" href="#id10">Taking It For a Ride</a><a class="headerlink" href="#taking-it-for-a-ride" title="Permalink to this headline">¶</a></h3>
<p>Now, let’s write a little application. Put that <code class="docutils literal"><span class="pre">ObjectPublisher</span></code>
class into a module <code class="docutils literal"><span class="pre">objectpub</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">objectpub</span> <span class="kn">import</span> <span class="n">ObjectPublisher</span>
<span class="k">class</span> <span class="nc">Root</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="c"># The "index" method:</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'''</span>
<span class="s"> <form action="welcome"></span>
<span class="s"> Name: <input type="text" name="name"></span>
<span class="s"> <input type="submit"></span>
<span class="s"> </form></span>
<span class="s"> '''</span>
<span class="k">def</span> <span class="nf">welcome</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'Hello </span><span class="si">%s</span><span class="s">!'</span> <span class="o">%</span> <span class="n">name</span>
<span class="n">app</span> <span class="o">=</span> <span class="n">ObjectPublisher</span><span class="p">(</span><span class="n">Root</span><span class="p">())</span>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">paste</span> <span class="kn">import</span> <span class="n">httpserver</span>
<span class="n">httpserver</span><span class="o">.</span><span class="n">serve</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s">'8080'</span><span class="p">)</span>
</pre></div>
</div>
<p>Alright, done! Oh, wait. There’s still some big missing features,
like how do you set headers? And instead of giving <code class="docutils literal"><span class="pre">404</span> <span class="pre">Not</span> <span class="pre">Found</span></code>
responses in some places, you’ll just get an attribute error. We’ll
fix those up in a later installment...</p>
</div>
<div class="section" id="give-me-more">
<h3><a class="toc-backref" href="#id11">Give Me More!</a><a class="headerlink" href="#give-me-more" title="Permalink to this headline">¶</a></h3>
<p>You’ll notice some things are missing here. Most specifically,
there’s no way to set the output headers, and the information on the
request is a little slim.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="c"># This is just a dictionary-like object that has case-</span>
<span class="c"># insensitive keys:</span>
<span class="kn">from</span> <span class="nn">paste.response</span> <span class="kn">import</span> <span class="n">HeaderDict</span>
<span class="k">class</span> <span class="nc">Request</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">environ</span> <span class="o">=</span> <span class="n">environ</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fields</span> <span class="o">=</span> <span class="n">parse_formvars</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="k">class</span> <span class="nc">Response</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">headers</span> <span class="o">=</span> <span class="n">HeaderDict</span><span class="p">(</span>
<span class="p">{</span><span class="s">'content-type'</span><span class="p">:</span> <span class="s">'text/html'</span><span class="p">})</span>
</pre></div>
</div>
<p>Now I’ll teach you a little trick. We don’t want to change the
signature of the methods. But we can’t put the request and response
objects in normal global variables, because we want to be
thread-friendly, and all threads see the same global variables (even
if they are processing different requests).</p>
<p>But Python 2.4 introduced a concept of “thread-local values”. That’s
a value that just this one thread can see. This is in the
<a class="reference external" href="http://docs.python.org/lib/module-threading.html">threading.local</a>
object. When you create an instance of <code class="docutils literal"><span class="pre">local</span></code> any attributes you
set on that object can only be seen by the thread you set them in. So
we’ll attach the request and response objects here.</p>
<p>So, let’s remind ourselves of what the <code class="docutils literal"><span class="pre">__call__</span></code> function looked
like:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">ObjectPublisher</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="o">...</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">fields</span> <span class="o">=</span> <span class="n">parse_formvars</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_object</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
<span class="n">response_body</span> <span class="o">=</span> <span class="n">obj</span><span class="p">(</span><span class="o">**</span><span class="n">fields</span><span class="o">.</span><span class="n">mixed</span><span class="p">())</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="p">[(</span><span class="s">'content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="n">response_body</span><span class="p">]</span>
</pre></div>
</div>
<p>Lets’s update that:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">threading</span>
<span class="n">webinfo</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">local</span><span class="p">()</span>
<span class="k">class</span> <span class="nc">ObjectPublisher</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="o">...</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">webinfo</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="n">webinfo</span><span class="o">.</span><span class="n">response</span> <span class="o">=</span> <span class="n">Response</span><span class="p">()</span>
<span class="n">obj</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">find_object</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">root</span><span class="p">,</span> <span class="n">environ</span><span class="p">)</span>
<span class="n">response_body</span> <span class="o">=</span> <span class="n">obj</span><span class="p">(</span><span class="o">**</span><span class="nb">dict</span><span class="p">(</span><span class="n">webinfo</span><span class="o">.</span><span class="n">request</span><span class="o">.</span><span class="n">fields</span><span class="p">))</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'200 OK'</span><span class="p">,</span> <span class="n">webinfo</span><span class="o">.</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
<span class="k">return</span> <span class="p">[</span><span class="n">response_body</span><span class="p">]</span>
</pre></div>
</div>
<p>Now in our method we might do:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Root</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">rss</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">webinfo</span><span class="o">.</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">[</span><span class="s">'content-type'</span><span class="p">]</span> <span class="o">=</span> <span class="s">'text/xml'</span>
<span class="o">...</span>
</pre></div>
</div>
<p>If we were being fancier we would do things like handle <a class="reference external" href="http://python.org/doc/current/lib/module-Cookie.html">cookies</a> in these
objects. But we aren’t going to do that now. You have a framework,
be happy!</p>
</div>
</div>
<div class="section" id="wsgi-middleware">
<h2><a class="toc-backref" href="#id12">WSGI Middleware</a><a class="headerlink" href="#wsgi-middleware" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="http://www.python.org/peps/pep-0333.html#middleware-components-that-play-both-sides">Middleware</a>
is where people get a little intimidated by WSGI and Paste.</p>
<p>What is middleware? Middleware is software that serves as an
intermediary.</p>
<p>So lets
write one. We’ll write an authentication middleware, so that you can
keep your greeting from being seen by just anyone.</p>
<p>Let’s use HTTP authentication, which also can mystify people a bit.
HTTP authentication is fairly simple:</p>
<ul class="simple">
<li>When authentication is requires, we give a <code class="docutils literal"><span class="pre">401</span> <span class="pre">Authentication</span>
<span class="pre">Required</span></code> status with a <code class="docutils literal"><span class="pre">WWW-Authenticate:</span> <span class="pre">Basic</span> <span class="pre">realm="This</span>
<span class="pre">Realm"</span></code> header</li>
<li>The client then sends back a header <code class="docutils literal"><span class="pre">Authorization:</span> <span class="pre">Basic</span>
<span class="pre">encoded_info</span></code></li>
<li>The “encoded_info” is a base-64 encoded version of
<code class="docutils literal"><span class="pre">username:password</span></code></li>
</ul>
<p>So how does this work? Well, we’re writing “middleware”, which means
we’ll typically pass the request on to another application. We could
change the request, or change the response, but in this case sometimes
we <em>won’t</em> pass the request on (like, when we need to give that 401
response).</p>
<p>To give an example of a really really simple middleware, here’s one
that capitalizes the response:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">Capitalizer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="c"># We generally pass in the application to be wrapped to</span>
<span class="c"># the middleware constructor:</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wrap_app</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wrap_app</span> <span class="o">=</span> <span class="n">wrap_app</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="c"># We call the application we are wrapping with the</span>
<span class="c"># same arguments we get...</span>
<span class="n">response_iter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap_app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
<span class="c"># then change the response...</span>
<span class="n">response_string</span> <span class="o">=</span> <span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">response_iter</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[</span><span class="n">response_string</span><span class="o">.</span><span class="n">upper</span><span class="p">()]</span>
</pre></div>
</div>
<p>Techically this isn’t quite right, because there there’s two ways to
return the response body, but we’re skimming bits.
<a class="reference external" href="http://pythonpaste.org/module-paste.wsgilib.html#intercept_output">paste.wsgilib.intercept_output</a>
is a somewhat more thorough implementation of this.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>This, like a lot of parts of this (now fairly old) tutorial is
better, more thorough, and easier using <a class="reference external" href="http://pythonpaste.org/webob/">WebOb</a>. This particular example looks
like:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">webob</span> <span class="kn">import</span> <span class="n">Request</span>
<span class="k">class</span> <span class="nc">Capitalizer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">req</span> <span class="o">=</span> <span class="n">Request</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>
<span class="n">resp</span> <span class="o">=</span> <span class="n">req</span><span class="o">.</span><span class="n">get_response</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span>
<span class="n">resp</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">resp</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
<span class="k">return</span> <span class="n">resp</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
</pre></div>
</div>
</div>
<p>So here’s some code that does something useful, authentication:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">class</span> <span class="nc">AuthMiddleware</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">wrap_app</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wrap_app</span> <span class="o">=</span> <span class="n">wrap_app</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">authorized</span><span class="p">(</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'HTTP_AUTHORIZATION'</span><span class="p">)):</span>
<span class="c"># Essentially self.auth_required is a WSGI application</span>
<span class="c"># that only knows how to respond with 401...</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">auth_required</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
<span class="c"># But if everything is okay, then pass everything through</span>
<span class="c"># to the application we are wrapping...</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap_app</span><span class="p">(</span><span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">authorized</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">auth_header</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">auth_header</span><span class="p">:</span>
<span class="c"># If they didn't give a header, they better login...</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="c"># .split(None, 1) means split in two parts on whitespace:</span>
<span class="n">auth_type</span><span class="p">,</span> <span class="n">encoded_info</span> <span class="o">=</span> <span class="n">auth_header</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">auth_type</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s">'basic'</span>
<span class="n">unencoded_info</span> <span class="o">=</span> <span class="n">encoded_info</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s">'base64'</span><span class="p">)</span>
<span class="n">username</span><span class="p">,</span> <span class="n">password</span> <span class="o">=</span> <span class="n">unencoded_info</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">check_password</span><span class="p">(</span><span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">check_password</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">username</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
<span class="c"># Not very high security authentication...</span>
<span class="k">return</span> <span class="n">username</span> <span class="o">==</span> <span class="n">password</span>
<span class="k">def</span> <span class="nf">auth_required</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">environ</span><span class="p">,</span> <span class="n">start_response</span><span class="p">):</span>
<span class="n">start_response</span><span class="p">(</span><span class="s">'401 Authentication Required'</span><span class="p">,</span>
<span class="p">[(</span><span class="s">'Content-type'</span><span class="p">,</span> <span class="s">'text/html'</span><span class="p">),</span>
<span class="p">(</span><span class="s">'WWW-Authenticate'</span><span class="p">,</span> <span class="s">'Basic realm="this realm"'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">"""</span>
<span class="s"> <html></span>
<span class="s"> <head><title>Authentication Required</title></head></span>
<span class="s"> <body></span>
<span class="s"> <h1>Authentication Required</h1></span>
<span class="s"> If you can't get in, then stay out.</span>
<span class="s"> </body></span>
<span class="s"> </html>"""</span><span class="p">]</span>
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Again, here’s the same thing with WebOb:</p>
<div class="last highlight-python"><div class="highlight"><pre>from webob import Request, Response
class AuthMiddleware(object):
def __init__(self, app):
self.app = app
def __call__(self, environ, start_response):
req = Request(environ)
if not self.authorized(req.headers['authorization']):
resp = self.auth_required(req)
else:
resp = self.app
return resp(environ, start_response)
def authorized(self, header):
if not header:
return False
auth_type, encoded = header.split(None, 1)
if not auth_type.lower() == 'basic':
return False
username, password = encoded.decode('base64').split(':', 1)
return self.check_password(username, password)
def check_password(self, username, password):
return username == password
def auth_required(self, req):
return Response(status=401, headers={'WWW-Authenticate': 'Basic realm="this realm"'},
body="""\
<html>
<head><title>Authentication Required</title></head>
<body>
<h1>Authentication Required</h1>
If you can't get in, then stay out.
</body>
</html>""")
</pre></div>
</div>
</div>
<p>So, how do we use this?</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">app</span> <span class="o">=</span> <span class="n">ObjectPublisher</span><span class="p">(</span><span class="n">Root</span><span class="p">())</span>
<span class="n">wrapped_app</span> <span class="o">=</span> <span class="n">AuthMiddleware</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">paste</span> <span class="kn">import</span> <span class="n">httpserver</span>
<span class="n">httpserver</span><span class="o">.</span><span class="n">serve</span><span class="p">(</span><span class="n">wrapped_app</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s">'8080'</span><span class="p">)</span>
</pre></div>
</div>
<p>Now you have middleware! Hurrah!</p>
<div class="section" id="give-me-more-middleware">
<h3><a class="toc-backref" href="#id13">Give Me More Middleware!</a><a class="headerlink" href="#give-me-more-middleware" title="Permalink to this headline">¶</a></h3>
<p>It’s even easier to use other people’s middleware than to make your
own, because then you don’t have to program. If you’ve been following
along, you’ve probably encountered a few exceptions, and have to look
at the console to see the exception reports. Let’s make that a little
easier, and show the exceptions in the browser...</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">app</span> <span class="o">=</span> <span class="n">ObjectPublisher</span><span class="p">(</span><span class="n">Root</span><span class="p">())</span>
<span class="n">wrapped_app</span> <span class="o">=</span> <span class="n">AuthMiddleware</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">paste.exceptions.errormiddleware</span> <span class="kn">import</span> <span class="n">ErrorMiddleware</span>
<span class="n">exc_wrapped_app</span> <span class="o">=</span> <span class="n">ErrorMiddleware</span><span class="p">(</span><span class="n">wrapped_app</span><span class="p">)</span>
</pre></div>
</div>
<p>Easy! But let’s make it <em>more</em> fancy...</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">app</span> <span class="o">=</span> <span class="n">ObjectPublisher</span><span class="p">(</span><span class="n">Root</span><span class="p">())</span>
<span class="n">wrapped_app</span> <span class="o">=</span> <span class="n">AuthMiddleware</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
<span class="kn">from</span> <span class="nn">paste.evalexception</span> <span class="kn">import</span> <span class="n">EvalException</span>
<span class="n">exc_wrapped_app</span> <span class="o">=</span> <span class="n">EvalException</span><span class="p">(</span><span class="n">wrapped_app</span><span class="p">)</span>
</pre></div>
</div>
<p>So go make an error now. And hit the little +’s. And type stuff in
to the boxes.</p>
</div>
</div>
<div class="section" id="conclusion">
<h2><a class="toc-backref" href="#id14">Conclusion</a><a class="headerlink" href="#conclusion" title="Permalink to this headline">¶</a></h2>
<p>Now that you’ve created your framework and application (I’m sure it’s
much nicer than the one I’ve given so far). You might keep writing it
(many people have so far), but even if you don’t you should be able to
recognize these components in other frameworks now, and you’ll have a
better understanding how they probably work under the covers.</p>
<p>Also check out the version of this tutorial written <a class="reference external" href="http://pythonpaste.org/webob/do-it-yourself.html">using WebOb</a>. That tutorial
includes things like <strong>testing</strong> and <strong>pattern-matching dispatch</strong>
(instead of object publishing).</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="http://pythonpaste.org/" class="invisible-link">Python Paste</a></h3>
<ul>
<li><a href="https://bitbucket.org/ianb/pastescript/issues/">Issue tracker</a></li>
<li><a href="http://pythonpaste.org/">Paste core</a></li>
<li><a href="http://webob.org/">WebOb</a></li>
<li><a href="http://pythonpaste.org/deploy/">Paste Deploy</a></li>
<li><a href="http://pythonpaste.org/script/">Paste Script</a></li>
<li><a href="http://webtest.pythonpaste.org/">WebTest</a></li>
<li><a href="http://pythonpaste.org/scripttest/">ScriptType</a></li>
<li><a href="http://pythonpaste.org/initools/">INITools</a></li>
<li><a href="http://pythonpaste.org/tempita/">Tempita</a></li>
<li><a href="http://pythonpaste.org/waitforit/">WaitForIt</a></li>
<li><a href="http://pythonpaste.org/wphp/">WPHP</a></li>
<li><a href="http://pythonpaste.org/wsgifilter/">WSGIFilter</a></li>
<li><a href="http://pythonpaste.org/wsgiproxy/">WSGIProxy</a></li>
</ul>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">A Do-It-Yourself Framework</a><ul>
<li><a class="reference internal" href="#introduction-and-audience">Introduction and Audience</a></li>
<li><a class="reference internal" href="#what-is-wsgi">What is WSGI?</a></li>
<li><a class="reference internal" href="#writing-a-wsgi-application">Writing a WSGI Application</a><ul>
<li><a class="reference internal" href="#an-interactive-app">An Interactive App</a></li>
</ul>
</li>
<li><a class="reference internal" href="#now-for-a-framework">Now For a Framework</a><ul>
<li><a class="reference internal" href="#object-publishing">Object Publishing</a></li>
<li><a class="reference internal" href="#the-path">The Path</a></li>
<li><a class="reference internal" href="#taking-it-for-a-ride">Taking It For a Ride</a></li>
<li><a class="reference internal" href="#give-me-more">Give Me More!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#wsgi-middleware">WSGI Middleware</a><ul>
<li><a class="reference internal" href="#give-me-more-middleware">Give Me More Middleware!</a></li>
</ul>
</li>
<li><a class="reference internal" href="#conclusion">Conclusion</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="url-parsing-with-wsgi.html" title="previous chapter">URL Parsing With WSGI And Paste</a></li>
<li>Next: <a href="paste-httpserver-threadpool.html" title="next chapter">The Paste HTTP Server Thread Pool</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/do-it-yourself-framework.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<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="footer">
©2008, Ian Bicking.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.3.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.6</a>
|
<a href="_sources/do-it-yourself-framework.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-release
>
by-pkgid
>
6b146ae60d64f7773c8cb4a1f7ef976a
>
files
>
443
