<!DOCTYPE HTML>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Werkzeug Documentation</title>
<link rel="stylesheet" href="_static/style.css" type="text/css">
<link rel="stylesheet" href="_static/print.css" type="text/css" media="print">
<link rel="stylesheet" href="_static/pygments.css" type="text/css">
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '#',
VERSION: '0.6.1'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/interface.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/werkzeug.js"></script>
<link rel="contents" title="Global table of contents" href="contents.html">
<link rel="index" title="Global index" href="genindex.html">
<link rel="search" title="Search" href="search.html">
<link rel="top" title="Werkzeug v0.6.1 documentation" href="index.html">
<link rel="next" title="Quickstart" href="quickstart.html">
<link rel="prev" title="Werkzeug Tutorial" href="tutorial.html">
</head>
<body>
<div class="page">
<div class="header">
<h1 class="heading"><a href="index.html"
title="back to the documentation overview"><span>Werkzeug</span></a></h1>
</div>
<ul class="navigation">
<li class="indexlink"><a href="index.html">Overview</a></li>
<li><a href="tutorial.html">« Werkzeug Tutorial</a></li>
<li class="active"><a href="#">API Levels</a></li>
<li><a href="quickstart.html">Quickstart »</a></li>
</ul>
<div class="body">
<div id="toc">
<h3>Table Of Contents</h3>
<div class="inner"><ul>
<li><a class="reference external" href="#">API Levels</a><ul>
<li><a class="reference external" href="#example">Example</a></li>
<li><a class="reference external" href="#high-or-low">High or Low?</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="module-werkzeug">
<span id="api-levels"></span><h1>API Levels<a class="headerlink" href="#module-werkzeug" title="Permalink to this headline">¶</a></h1>
<p>Werkzeug is intended to be a utility rather than a framework. Because of that
the user-friendly API is separated from the lower-level API so that Werkzeug
can easily be used to extend another system.</p>
<p>All the functionality the <a title="werkzeug.Request" class="reference external" href="wrappers.html#werkzeug.Request"><tt class="xref py py-class docutils literal"><span class="pre">Request</span></tt></a> and <a title="werkzeug.Response" class="reference external" href="wrappers.html#werkzeug.Response"><tt class="xref py py-class docutils literal"><span class="pre">Response</span></tt></a> objects (aka
the “wrappers”) provide is also available in small utility functions.</p>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
<p>This example implements a small <cite>Hello World</cite> application that greets the
user with the name entered:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">werkzeug</span> <span class="kn">import</span> <span class="n">Request</span><span class="p">,</span> <span class="n">Response</span><span class="p">,</span> <span class="n">escape</span>
<span class="nd">@Request.application</span>
<span class="k">def</span> <span class="nf">hello_world</span><span class="p">(</span><span class="n">request</span><span class="p">):</span>
<span class="n">result</span> <span class="o">=</span> <span class="p">[</span><span class="s">'<title>Greeter</title>'</span><span class="p">]</span>
<span class="k">if</span> <span class="n">request</span><span class="o">.</span><span class="n">method</span> <span class="o">==</span> <span class="s">'POST'</span><span class="p">:</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'<h1>Hello </span><span class="si">%s</span><span class="s">!</h1>'</span> <span class="o">%</span> <span class="n">escape</span><span class="p">(</span><span class="n">request</span><span class="o">.</span><span class="n">form</span><span class="p">[</span><span class="s">'name'</span><span class="p">]))</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'''</span>
<span class="s"> <form action="" method="post"></span>
<span class="s"> <p>Name: <input type="text" name="name" size="20"></span>
<span class="s"> <input type="submit" value="Greet me"></span>
<span class="s"> </form></span>
<span class="s"> '''</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span><span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="p">),</span> <span class="n">mimetype</span><span class="o">=</span><span class="s">'text/html'</span><span class="p">)</span>
</pre></div>
</div>
<p>Alternatively the same application could be use without request and response
objects but by taking advantage of the parsing functions werkzeug provides:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">werkzeug</span> <span class="kn">import</span> <span class="n">parse_form_data</span><span class="p">,</span> <span class="n">escape</span>
<span class="k">def</span> <span class="nf">hello_world</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">result</span> <span class="o">=</span> <span class="p">[</span><span class="s">'<title>Greeter</title>'</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">form</span> <span class="o">=</span> <span class="n">parse_form_data</span><span class="p">(</span><span class="n">environ</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'<h1>Hello </span><span class="si">%s</span><span class="s">!</h1>'</span> <span class="o">%</span> <span class="n">escape</span><span class="p">(</span><span class="n">form</span><span class="p">[</span><span class="s">'name'</span><span class="p">]))</span>
<span class="n">result</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s">'''</span>
<span class="s"> <form action="" method="post"></span>
<span class="s"> <p>Name: <input type="text" name="name" size="20"></span>
<span class="s"> <input type="submit" value="Greet me"></span>
<span class="s"> </form></span>
<span class="s"> '''</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; charset=utf-8'</span><span class="p">)])</span>
<span class="k">return</span> <span class="p">[</span><span class="s">''</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">result</span><span class="p">)]</span>
</pre></div>
</div>
</div>
<div class="section" id="high-or-low">
<h2>High or Low?<a class="headerlink" href="#high-or-low" title="Permalink to this headline">¶</a></h2>
<p>Usually you want to use the high-level layer (the request and response
objects). But there are situations where this might not be what you want.</p>
<p>For example you might be maintaining code for an application written in
Django or another framework and you have to parse HTTP headers. You can
utilize Werkzeug for that by accessing the lower-level HTTP header parsing
functions.</p>
<p>Another situation where the low level parsing functions can be useful are
custom WSGI frameworks, unit-testing or modernizing an old CGI/mod_python
application to WSGI as well as WSGI middlewares where you want to keep the
overhead low.</p>
</div>
</div>
<div style="clear: both"></div>
</div>
<div class="footer">
© Copyright 2008 by the <a href="http://pocoo.org/">Pocoo Team</a>,
documentation generated by <a href="http://sphinx.pocoo.org/">Sphinx</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
i386
>
media
>
os
>
by-pkgid
>
5c4f8358fd6fdc210fb0d926bd25802c
>
files
>
250
