File: middleware.html

package info (click to toggle)
routes 1.13-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 2,468 kB
  • sloc: python: 1,594; makefile: 135; xml: 8
file content (160 lines) | stat: -rw-r--r-- 7,857 bytes parent folder | download
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
<!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>routes.middleware – Routes WSGI Middleware &mdash; Routes v1.12.3 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.12.3',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="search" type="application/opensearchdescription+xml"
          title="Search within Routes v1.12.3 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="top" title="Routes v1.12.3 documentation" href="../index.html" />
    <link rel="up" title="Routes Modules" href="index.html" />
    <link rel="next" title="routes.lru – LRU caching class and decorator" href="lru.html" />
    <link rel="prev" title="routes.route – Route" href="route.html" /> 
  </head>
  <body>
<div style="color: #D1361B; font-size: 70px; font-weight: bold; padding: 10px 0 0 10px;">Routes</div>
</div>

    <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="../modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="lru.html" title="routes.lru – LRU caching class and decorator"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="route.html" title="routes.route – Route"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">Routes home</a>&nbsp;|&nbsp;</li>
        <li><a href="../contents.html">Documentation</a>&raquo;</li>

          <li><a href="index.html" accesskey="U">Routes Modules</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-routes.middleware">
<h1><tt class="xref docutils literal"><span class="pre">routes.middleware</span></tt> &#8211; Routes WSGI Middleware<a class="headerlink" href="#module-routes.middleware" title="Permalink to this headline">¶</a></h1>
<p>Routes WSGI Middleware</p>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="routes.middleware.RoutesMiddleware">
<em class="property">class </em><tt class="descclassname">routes.middleware.</tt><tt class="descname">RoutesMiddleware</tt><big>(</big><em>wsgi_app</em>, <em>mapper</em>, <em>use_method_override=True</em>, <em>path_info=True</em>, <em>singleton=True</em><big>)</big><a class="headerlink" href="#routes.middleware.RoutesMiddleware" title="Permalink to this definition">¶</a></dt>
<dd><p>Routing middleware that handles resolving the PATH_INFO in
addition to optionally recognizing method overriding.</p>
<p>Create a Route middleware object</p>
<p>Using the use_method_override keyword will require Paste to be
installed, and your application should use Paste&#8217;s WSGIRequest
object as it will properly handle POST issues with wsgi.input
should Routes check it.</p>
<p>If path_info is True, then should a route var contain
path_info, the SCRIPT_NAME and PATH_INFO will be altered
accordingly. This should be used with routes like:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="nb">map</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="s">&#39;blog/*path_info&#39;</span><span class="p">,</span> <span class="n">controller</span><span class="o">=</span><span class="s">&#39;blog&#39;</span><span class="p">,</span> <span class="n">path_info</span><span class="o">=</span><span class="s">&#39;&#39;</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="routes.middleware.is_form_post">
<tt class="descclassname">routes.middleware.</tt><tt class="descname">is_form_post</tt><big>(</big><em>environ</em><big>)</big><a class="headerlink" href="#routes.middleware.is_form_post" title="Permalink to this definition">¶</a></dt>
<dd>Determine whether the request is a POSTed html form</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="../contents.html">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="#"><tt class="docutils literal"><span class="pre">routes.middleware</span></tt> &#8211; Routes WSGI Middleware</a><ul>
<li><a class="reference external" href="#module-contents">Module Contents</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="route.html"
                                  title="previous chapter"><tt class="docutils literal docutils literal"><span class="pre">routes.route</span></tt> &#8211; Route</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="lru.html"
                                  title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">routes.lru</span></tt> &#8211; LRU caching class and decorator</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="../_sources/modules/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="../modindex.html" title="Global Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="lru.html" title="routes.lru – LRU caching class and decorator"
             >next</a> |</li>
        <li class="right" >
          <a href="route.html" title="routes.route – Route"
             >previous</a> |</li>
        <li><a href="../index.html">Routes home</a>&nbsp;|&nbsp;</li>
        <li><a href="../contents.html">Documentation</a>&raquo;</li>

          <li><a href="index.html" >Routes Modules</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2010, Ben Bangert, Mike Orr.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.5.
    </div>
  </body>
</html>