mirror of
https://github.com/kennethreitz/responder.git
synced 2026-10-24 05:59:12 +00:00
426 lines
36 KiB
HTML
426 lines
36 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Migrating from Flask — responder 9.2.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
|
||
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=eb4102c5" />
|
||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
|
||
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
|
||
<link rel="stylesheet" type="text/css" href="_static/design-elements.e5416f61bae5d36adc6d722a2b6f8cff.css?v=452a8e97" />
|
||
<script src="_static/documentation_options.js?v=e8b940be"></script>
|
||
<script src="_static/doctools.js?v=fd6eb6e6"></script>
|
||
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
|
||
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="_static/copybutton.js?v=fd10adb8"></script>
|
||
<script>
|
||
</script>
|
||
<script src="_static/design-tabs.js?v=f930bc37"></script>
|
||
<script src="_static/design-elements.bbdccc18c4abea9397628f9fea3d48c2.js?v=03c7770e"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="API Reference" href="api.html" />
|
||
<link rel="prev" title="Writing Middleware" href="tutorial-middleware.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="migrating-from-flask">
|
||
<h1>Migrating from Flask<a class="headerlink" href="#migrating-from-flask" title="Link to this heading">¶</a></h1>
|
||
<p>If you’re coming from Flask, you’ll find Responder familiar but different
|
||
in a few key ways. This guide maps Flask concepts to their Responder
|
||
equivalents and shows you how to translate common patterns.</p>
|
||
<section id="the-big-differences">
|
||
<h2>The Big Differences<a class="headerlink" href="#the-big-differences" title="Link to this heading">¶</a></h2>
|
||
<p><strong>Mutate the response, or return one.</strong> In Flask you return a response.
|
||
Responder hands you a <code class="docutils literal notranslate"><span class="pre">resp</span></code> object to mutate — that’s the idiomatic style,
|
||
and it keeps the response editable through hooks and middleware:</p>
|
||
<p>Flask:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">():</span>
|
||
<span class="k">return</span> <span class="s2">"hello, world!"</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Responder:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">text</span> <span class="o">=</span> <span class="s2">"hello, world!"</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Flask-style returns work too. A string becomes the body; a dictionary, list,
|
||
number, or boolean becomes JSON; a Pydantic model or dataclass is serialized
|
||
for you; and a <code class="docutils literal notranslate"><span class="pre">(body,</span> <span class="pre">status[,</span> <span class="pre">headers])</span></code> tuple sets the lot at once:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="k">return</span> <span class="s2">"hello, world!"</span>
|
||
|
||
<span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/items"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"POST"</span><span class="p">])</span>
|
||
<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="k">return</span> <span class="p">{</span><span class="s2">"created"</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span> <span class="mi">201</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>See <a class="reference internal" href="quickstart.html#returning-values"><span class="std std-ref">accepted return types</span></a> for the complete list.</p>
|
||
<p><strong>Explicit request and response.</strong> Flask uses a global <code class="docutils literal notranslate"><span class="pre">request</span></code> object
|
||
(via thread-local magic). Responder passes <code class="docutils literal notranslate"><span class="pre">req</span></code> and <code class="docutils literal notranslate"><span class="pre">resp</span></code> explicitly.
|
||
No magic, no import needed — they’re right there in the function signature.</p>
|
||
<p><strong>ASGI, not WSGI.</strong> Flask runs on WSGI, which is synchronous. Responder
|
||
runs on ASGI, which supports async natively. You can still write sync
|
||
views — Responder runs them in a thread pool automatically.</p>
|
||
</section>
|
||
<section id="quick-reference">
|
||
<h2>Quick Reference<a class="headerlink" href="#quick-reference" title="Link to this heading">¶</a></h2>
|
||
<table class="docutils align-default">
|
||
<colgroup>
|
||
<col style="width: 40.0%" />
|
||
<col style="width: 60.0%" />
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Flask</p></th>
|
||
<th class="head"><p>Responder</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Flask(__name__)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">responder.API()</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">"text"</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">resp.text</span> <span class="pre">=</span> <span class="pre">"text"</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">jsonify(data)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">resp.media</span> <span class="pre">=</span> <span class="pre">data</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">render_template("t.html",</span> <span class="pre">x=1)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">resp.html</span> <span class="pre">=</span> <span class="pre">api.template("t.html",</span> <span class="pre">x=1)</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">request.args["q"]</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">req.params["q"]</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">request.json</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">await</span> <span class="pre">req.media()</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">request.form</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">await</span> <span class="pre">req.media("form")</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">request.headers["X"]</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">req.headers["X"]</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">request.method</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">req.method</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">request.cookies["x"]</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">req.cookies["x"]</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">session["x"]</span> <span class="pre">=</span> <span class="pre">1</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">resp.session["x"]</span> <span class="pre">=</span> <span class="pre">1</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">abort(404)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">responder.abort(404)</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">redirect("/new")</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">api.redirect(resp,</span> <span class="pre">location="/new")</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">@app.before_request</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">@api.before_request</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">@app.errorhandler(404)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">@api.exception_handler(404)</span></code></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">app.run(debug=True)</span></code></p></td>
|
||
<td><p><code class="docutils literal notranslate"><span class="pre">api.run(debug=True)</span></code></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>A few of these mappings deserve a closer look:</p>
|
||
<ul class="simple">
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">responder.abort(404)</span></code> <em>raises</em> and halts the handler, exactly like
|
||
Flask’s <code class="docutils literal notranslate"><span class="pre">abort()</span></code> — assigning <code class="docutils literal notranslate"><span class="pre">resp.status_code</span></code> alone does not stop
|
||
execution. Import it from <code class="docutils literal notranslate"><span class="pre">responder</span></code>; it works from handlers, hooks, and
|
||
dependencies alike.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">@api.exception_handler</span></code> takes an exception class <em>or</em> a status code, so
|
||
<code class="docutils literal notranslate"><span class="pre">@api.exception_handler(404)</span></code> mirrors <code class="docutils literal notranslate"><span class="pre">@app.errorhandler(404)</span></code>. The
|
||
handler receives <code class="docutils literal notranslate"><span class="pre">(req,</span> <span class="pre">resp,</span> <span class="pre">exc)</span></code>.</p></li>
|
||
<li><p><strong>Sessions need a secret key.</strong> <code class="docutils literal notranslate"><span class="pre">resp.session</span></code> and <code class="docutils literal notranslate"><span class="pre">req.session</span></code> ride on
|
||
a signed cookie, so Responder needs a signing key: set <code class="docutils literal notranslate"><span class="pre">API(secret_key=...)</span></code>
|
||
or the <code class="docutils literal notranslate"><span class="pre">RESPONDER_SECRET_KEY</span></code> environment variable. Without one, a random
|
||
per-process key is minted (with a loud warning), so sessions won’t survive a
|
||
restart or span multiple workers; <code class="docutils literal notranslate"><span class="pre">secret_key="NOTASECRET"</span></code> is rejected, and
|
||
cookies are marked <code class="docutils literal notranslate"><span class="pre">Secure</span></code> in production. See <a class="reference internal" href="guide-config.html"><span class="doc">Configuration</span></a>.</p></li>
|
||
<li><p><strong>Redirects can block open redirects.</strong> Pass <code class="docutils literal notranslate"><span class="pre">allow_external=False</span></code> to
|
||
<code class="docutils literal notranslate"><span class="pre">api.redirect</span></code> when the location comes from user input (e.g. a <code class="docutils literal notranslate"><span class="pre">?next=</span></code>
|
||
parameter).</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="route-parameters">
|
||
<h2>Route Parameters<a class="headerlink" href="#route-parameters" title="Link to this heading">¶</a></h2>
|
||
<p>Flask uses <code class="docutils literal notranslate"><span class="pre"><angle_brackets></span></code>. Responder uses <code class="docutils literal notranslate"><span class="pre">{curly_braces}</span></code>
|
||
with the same type convertor idea:</p>
|
||
<p>Flask:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/users/<int:user_id>"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">get_user</span><span class="p">(</span><span class="n">user_id</span><span class="p">):</span>
|
||
<span class="k">return</span> <span class="n">jsonify</span><span class="p">({</span><span class="s2">"id"</span><span class="p">:</span> <span class="n">user_id</span><span class="p">})</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Responder:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/users/{user_id:int}"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">get_user</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">user_id</span><span class="p">):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"id"</span><span class="p">:</span> <span class="n">user_id</span><span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Note the <code class="docutils literal notranslate"><span class="pre">*</span></code> — route parameters are keyword-only arguments in
|
||
Responder. This makes the interface explicit about which arguments
|
||
come from the URL.</p>
|
||
<p>Query-string parameters can be typed the same way. Instead of reaching into
|
||
<code class="docutils literal notranslate"><span class="pre">req.params</span></code>, declare them with the <code class="docutils literal notranslate"><span class="pre">Query</span></code> marker and Responder coerces
|
||
the value — returning <code class="docutils literal notranslate"><span class="pre">422</span></code> if it’s missing or the wrong type:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">responder</span><span class="w"> </span><span class="kn">import</span> <span class="n">Query</span>
|
||
|
||
<span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/search"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">search</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">q</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="o">...</span><span class="p">),</span> <span class="n">limit</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">Query</span><span class="p">(</span><span class="mi">10</span><span class="p">)):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"q"</span><span class="p">:</span> <span class="n">q</span><span class="p">,</span> <span class="s2">"limit"</span><span class="p">:</span> <span class="n">limit</span><span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><code class="docutils literal notranslate"><span class="pre">Query(...)</span></code> is required; <code class="docutils literal notranslate"><span class="pre">Query(10)</span></code> supplies a default. There are
|
||
matching <code class="docutils literal notranslate"><span class="pre">Header</span></code>, <code class="docutils literal notranslate"><span class="pre">Cookie</span></code>, and <code class="docutils literal notranslate"><span class="pre">Path</span></code> markers too.</p>
|
||
</section>
|
||
<section id="json-apis">
|
||
<h2>JSON APIs<a class="headerlink" href="#json-apis" title="Link to this heading">¶</a></h2>
|
||
<p>Flask:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/items"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"POST"</span><span class="p">])</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">create_item</span><span class="p">():</span>
|
||
<span class="n">data</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">json</span>
|
||
<span class="c1"># ... create item</span>
|
||
<span class="k">return</span> <span class="n">jsonify</span><span class="p">(</span><span class="n">item</span><span class="p">),</span> <span class="mi">201</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Responder:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/items"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"POST"</span><span class="p">])</span>
|
||
<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_item</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="n">data</span> <span class="o">=</span> <span class="k">await</span> <span class="n">req</span><span class="o">.</span><span class="n">media</span><span class="p">()</span>
|
||
<span class="c1"># ... create item</span>
|
||
<span class="k">return</span> <span class="n">item</span><span class="p">,</span> <span class="mi">201</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The <code class="docutils literal notranslate"><span class="pre">await</span></code> is needed because reading the request body is async I/O — the
|
||
event loop stays free while the body arrives. The <code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">item,</span> <span class="pre">201</span></code> is the
|
||
Flask-style tuple from earlier; you could just as well mutate <code class="docutils literal notranslate"><span class="pre">resp.media</span></code>
|
||
and <code class="docutils literal notranslate"><span class="pre">resp.status_code</span></code>.</p>
|
||
<p><strong>Skip the manual parsing.</strong> Flask hands you <code class="docutils literal notranslate"><span class="pre">request.json</span></code> and leaves
|
||
validation to you. Responder can do better: annotate a keyword-only parameter
|
||
with a Pydantic model and the body is parsed, validated, and injected for you —
|
||
with an automatic <code class="docutils literal notranslate"><span class="pre">422</span></code> (and the validation errors) when it doesn’t fit:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModel</span>
|
||
|
||
<span class="k">class</span><span class="w"> </span><span class="nc">ItemIn</span><span class="p">(</span><span class="n">BaseModel</span><span class="p">):</span>
|
||
<span class="n">name</span><span class="p">:</span> <span class="nb">str</span>
|
||
<span class="n">price</span><span class="p">:</span> <span class="nb">float</span>
|
||
|
||
<span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/api/items"</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s2">"POST"</span><span class="p">])</span>
|
||
<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">create_item</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">item</span><span class="p">:</span> <span class="n">ItemIn</span><span class="p">):</span>
|
||
<span class="c1"># `item` is a validated ItemIn — no try/except needed</span>
|
||
<span class="k">return</span> <span class="p">{</span><span class="s2">"id"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">"name"</span><span class="p">:</span> <span class="n">item</span><span class="o">.</span><span class="n">name</span><span class="p">},</span> <span class="mi">201</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>The same idea runs in reverse: a Pydantic <em>return</em> annotation becomes the
|
||
response model, validating and trimming the payload on the way out. See
|
||
<a class="reference internal" href="tutorial-rest.html"><span class="doc">Building a REST API</span></a> for the full typed-I/O walkthrough.</p>
|
||
</section>
|
||
<section id="templates">
|
||
<h2>Templates<a class="headerlink" href="#templates" title="Link to this heading">¶</a></h2>
|
||
<p>Both use Jinja2. The syntax is nearly identical:</p>
|
||
<p>Flask:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/hello/<name>"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">(</span><span class="n">name</span><span class="p">):</span>
|
||
<span class="k">return</span> <span class="n">render_template</span><span class="p">(</span><span class="s2">"hello.html"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Responder:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/hello/</span><span class="si">{name}</span><span class="s2">"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">hello</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">html</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">template</span><span class="p">(</span><span class="s2">"hello.html"</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
<section id="blueprints-routers">
|
||
<h2>Blueprints → Routers<a class="headerlink" href="#blueprints-routers" title="Link to this heading">¶</a></h2>
|
||
<p>Flask uses Blueprints to organize routes across modules. Responder’s
|
||
standalone <a class="reference internal" href="api.html#responder.Router" title="responder.Router"><code class="xref py py-class docutils literal notranslate"><span class="pre">responder.Router</span></code></a> works the same way — declare routes in
|
||
a module without an app instance, then register the router on the app:</p>
|
||
<p>Flask:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">bp</span> <span class="o">=</span> <span class="n">Blueprint</span><span class="p">(</span><span class="s2">"api"</span><span class="p">,</span> <span class="vm">__name__</span><span class="p">,</span> <span class="n">url_prefix</span><span class="o">=</span><span class="s2">"/api"</span><span class="p">)</span>
|
||
|
||
<span class="nd">@bp</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/users"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">list_users</span><span class="p">():</span>
|
||
<span class="k">return</span> <span class="n">jsonify</span><span class="p">([])</span>
|
||
|
||
<span class="n">app</span><span class="o">.</span><span class="n">register_blueprint</span><span class="p">(</span><span class="n">bp</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Responder:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">responder</span><span class="w"> </span><span class="kn">import</span> <span class="n">Router</span>
|
||
|
||
<span class="n">router</span> <span class="o">=</span> <span class="n">Router</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s2">"/api"</span><span class="p">)</span>
|
||
|
||
<span class="nd">@router</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/users"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">list_users</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="p">[]</span>
|
||
|
||
<span class="n">api</span><span class="o">.</span><span class="n">include_router</span><span class="p">(</span><span class="n">router</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Routers nest, take an extra prefix at inclusion time, and carry group-level
|
||
<code class="docutils literal notranslate"><span class="pre">tags</span></code>, <code class="docutils literal notranslate"><span class="pre">dependencies</span></code>, and <code class="docutils literal notranslate"><span class="pre">auth</span></code> — see <a class="reference internal" href="routers.html"><span class="doc">Composing Apps with Routers</span></a>. For quick
|
||
same-file prefix grouping there is also <code class="docutils literal notranslate"><span class="pre">api.group("/api")</span></code>, which
|
||
registers routes immediately on the live <code class="docutils literal notranslate"><span class="pre">api</span></code>.</p>
|
||
</section>
|
||
<section id="gradual-migration">
|
||
<h2>Gradual Migration<a class="headerlink" href="#gradual-migration" title="Link to this heading">¶</a></h2>
|
||
<p>You don’t have to migrate all at once. Responder can mount your existing
|
||
Flask app at a subroute, so you can move endpoints over one at a time:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">flask</span><span class="w"> </span><span class="kn">import</span> <span class="n">Flask</span>
|
||
|
||
<span class="n">flask_app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
||
|
||
<span class="c1"># Your existing Flask routes stay here</span>
|
||
<span class="nd">@flask_app</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/legacy"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">legacy</span><span class="p">():</span>
|
||
<span class="k">return</span> <span class="s2">"old endpoint"</span>
|
||
|
||
<span class="c1"># Mount Flask under /old, new routes go on Responder</span>
|
||
<span class="n">api</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span><span class="s2">"/old"</span><span class="p">,</span> <span class="n">flask_app</span><span class="p">)</span>
|
||
|
||
<span class="nd">@api</span><span class="o">.</span><span class="n">route</span><span class="p">(</span><span class="s2">"/new"</span><span class="p">)</span>
|
||
<span class="k">def</span><span class="w"> </span><span class="nf">new_endpoint</span><span class="p">(</span><span class="n">req</span><span class="p">,</span> <span class="n">resp</span><span class="p">):</span>
|
||
<span class="n">resp</span><span class="o">.</span><span class="n">media</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"modern"</span><span class="p">:</span> <span class="kc">True</span><span class="p">}</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Requests to <code class="docutils literal notranslate"><span class="pre">/old/legacy</span></code> go to Flask. Everything else goes to
|
||
Responder. When you’ve moved everything over, remove the mount.</p>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper"><p class="logo">
|
||
<a href="index.html">
|
||
<img class="logo" src="_static/responder.png" />
|
||
</a>
|
||
</p>
|
||
<p>
|
||
<strong>Responder</strong> — a familiar HTTP service framework for Python.
|
||
<br />
|
||
<small>v9.2.0</small>
|
||
</p>
|
||
<h3>Useful Links</h3>
|
||
<ul>
|
||
<li><a href="https://github.com/kennethreitz/responder">Responder @ GitHub</a></li>
|
||
<li><a href="https://pypi.org/project/responder/">Responder @ PyPI</a></li>
|
||
<li><a href="https://github.com/kennethreitz/responder/issues">Issue Tracker</a></li>
|
||
</ul><h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tour.html">Feature Tour</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="routers.html">Composing Apps with Routers</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="guide-config.html">Configuration</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="clientgen.html">Generated Clients</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Tutorials</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial-rest.html">Building a REST API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial-sqlalchemy.html">Using SQLAlchemy</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial-auth.html">Authentication</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial-websockets.html">WebSocket Tutorial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial-middleware.html">Writing Middleware</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Migrating from Flask</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#the-big-differences">The Big Differences</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#quick-reference">Quick Reference</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#route-parameters">Route Parameters</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#json-apis">JSON APIs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#templates">Templates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#blueprints-routers">Blueprints → Routers</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#gradual-migration">Gradual Migration</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cli.html">Command Line Interface</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="runtime-contracts.html">Runtime Contracts</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Project</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changelog</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migration-v9.html">Migrating to v9</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migration-v8.html">Migrating to v8</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migration-v7.html">Migrating to v7</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migration-v6.html">Migrating to v6</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migration-v5.html">Migrating to v5</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="sandbox.html">Sandbox</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="tutorial-middleware.html" title="previous chapter">Writing Middleware</a></li>
|
||
<li>Next: <a href="api.html" title="next chapter">API Reference</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2018-2026, Kenneth Reitz.
|
||
|
||
|
|
||
<a href="_sources/tutorial-flask.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
<a href="https://github.com/kennethreitz/responder" class="github">
|
||
<img src="_static/forkme_right_darkblue.png" alt="Fork me on GitHub" class="github"/>
|
||
</a>
|
||
|
||
|
||
|
||
</body>
|
||
</html> |