2025-04-10 15:52:02 -06:00
|
|
|
|
<!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">
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<title>Adding HTTP Method Overrides — Flask Documentation (3.2.x)</title>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=6625fa76" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/flask.css?v=b87c8d14" />
|
|
|
|
|
|
<script src="../_static/documentation_options.js?v=56528222"></script>
|
|
|
|
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
|
|
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
|
|
|
<script data-project="flask" data-version="3.2.x" src="../_static/describe_version.js?v=fa7f30d0"></script>
|
|
|
|
|
|
<link rel="icon" href="../_static/shortcut-icon.png"/>
|
|
|
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<link rel="next" title="Request Content Checksums" href="requestchecksum.html" />
|
|
|
|
|
|
<link rel="prev" title="Deferred Request Callbacks" href="deferredcallbacks.html" />
|
2025-04-10 15:52:02 -06:00
|
|
|
|
</head><body>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
|
accesskey="I">index</a></li>
|
|
|
|
|
|
<li class="right" >
|
|
|
|
|
|
<a href="../py-modindex.html" title="Python Module Index"
|
|
|
|
|
|
>modules</a> |</li>
|
|
|
|
|
|
<li class="right" >
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<a href="requestchecksum.html" title="Request Content Checksums"
|
2025-04-10 15:52:02 -06:00
|
|
|
|
accesskey="N">next</a> |</li>
|
|
|
|
|
|
<li class="right" >
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<a href="deferredcallbacks.html" title="Deferred Request Callbacks"
|
2025-04-10 15:52:02 -06:00
|
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Flask Documentation (3.2.x)</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Patterns for Flask</a> »</li>
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<li class="nav-item nav-item-this"><a href="">Adding HTTP Method Overrides</a></li>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
</ul>
|
2025-04-11 03:04:22 +00:00
|
|
|
|
</div>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<section id="adding-http-method-overrides">
|
|
|
|
|
|
<h1>Adding HTTP Method Overrides<a class="headerlink" href="#adding-http-method-overrides" title="Link to this heading">¶</a></h1>
|
|
|
|
|
|
<p>Some HTTP proxies do not support arbitrary HTTP methods or newer HTTP
|
|
|
|
|
|
methods (such as PATCH). In that case it’s possible to “proxy” HTTP
|
|
|
|
|
|
methods through another HTTP method in total violation of the protocol.</p>
|
|
|
|
|
|
<p>The way this works is by letting the client do an HTTP POST request and
|
|
|
|
|
|
set the <code class="docutils literal notranslate"><span class="pre">X-HTTP-Method-Override</span></code> header. Then the method is replaced
|
|
|
|
|
|
with the header value before being passed to Flask.</p>
|
|
|
|
|
|
<p>This can be accomplished with an HTTP middleware:</p>
|
|
|
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">HTTPMethodOverrideMiddleware</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
|
|
|
<span class="n">allowed_methods</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span>
|
|
|
|
|
|
<span class="s1">'GET'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'HEAD'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'POST'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'DELETE'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'PUT'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'PATCH'</span><span class="p">,</span>
|
|
|
|
|
|
<span class="s1">'OPTIONS'</span>
|
|
|
|
|
|
<span class="p">])</span>
|
|
|
|
|
|
<span class="n">bodyless_methods</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">([</span><span class="s1">'GET'</span><span class="p">,</span> <span class="s1">'HEAD'</span><span class="p">,</span> <span class="s1">'OPTIONS'</span><span class="p">,</span> <span class="s1">'DELETE'</span><span class="p">])</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="k">def</span><span class="w"> </span><span class="fm">__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="w"> </span><span class="fm">__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">method</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="s1">'HTTP_X_HTTP_METHOD_OVERRIDE'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">if</span> <span class="n">method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">allowed_methods</span><span class="p">:</span>
|
|
|
|
|
|
<span class="n">environ</span><span class="p">[</span><span class="s1">'REQUEST_METHOD'</span><span class="p">]</span> <span class="o">=</span> <span class="n">method</span>
|
|
|
|
|
|
<span class="k">if</span> <span class="n">method</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">bodyless_methods</span><span class="p">:</span>
|
|
|
|
|
|
<span class="n">environ</span><span class="p">[</span><span class="s1">'CONTENT_LENGTH'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'0'</span>
|
|
|
|
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">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>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<p>To use this with Flask, wrap the app object with the middleware:</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>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<span class="n">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="n">app</span><span class="o">.</span><span class="n">wsgi_app</span> <span class="o">=</span> <span class="n">HTTPMethodOverrideMiddleware</span><span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">wsgi_app</span><span class="p">)</span>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<span id="sidebar-top"></span>
|
|
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
2025-04-11 03:04:22 +00:00
|
|
|
|
|
|
|
|
|
|
|
2025-04-10 15:52:02 -06:00
|
|
|
|
<p class="logo"><a href="../index.html">
|
|
|
|
|
|
<img class="logo" src="../_static/flask-vertical.png" alt="Logo of Flask"/>
|
|
|
|
|
|
</a></p>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="../index.html">Overview</a>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a href="index.html">Patterns for Flask</a>
|
|
|
|
|
|
<ul>
|
2025-04-11 03:04:22 +00:00
|
|
|
|
<li>Previous: <a href="deferredcallbacks.html" title="previous chapter">Deferred Request Callbacks</a>
|
|
|
|
|
|
<li>Next: <a href="requestchecksum.html" title="next chapter">Request Content Checksums</a></ul>
|
2025-04-10 15:52:02 -06:00
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<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 id="ethical-ad-placement"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
|
|
|
|
© Copyright 2010 Pallets.
|
|
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
2025-04-11 03:04:22 +00:00
|
|
|
|
</html>
|
