Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Obserwuj 1
Polub 0
Wiki 捐赠
gooderp18绿色标准版
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
Gałąź: master
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'master'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/wsgiref.html

1194 lines
122KB
Czysty Bezpośredni odnośnik Wina Historia 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="wsgiref — WSGI Utilities and Reference Implementation" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/wsgiref.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/wsgiref The Web Server Gateway Interface (WSGI) is a standard interface between web server software and web applications written in Python. Having a standard interface makes it eas..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/wsgiref The Web Server Gateway Interface (WSGI) is a standard interface between web server software and web applications written in Python. Having a standard interface makes it eas..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>wsgiref — WSGI Utilities and Reference Implementation &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="urllib — URL handling modules" href="urllib.html" />

  39.     <link rel="prev" title="webbrowser — Convenient web-browser controller" href="webbrowser.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/wsgiref.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code> — WSGI Utilities and Reference Implementation</a><ul>

  99. <li><a class="reference internal" href="#module-wsgiref.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code> – WSGI environment utilities</a></li>

  100. <li><a class="reference internal" href="#module-wsgiref.headers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.headers</span></code> – WSGI response header tools</a></li>

  101. <li><a class="reference internal" href="#module-wsgiref.simple_server"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.simple_server</span></code> – a simple WSGI HTTP server</a></li>

  102. <li><a class="reference internal" href="#module-wsgiref.validate"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.validate</span></code> — WSGI conformance checker</a></li>

  103. <li><a class="reference internal" href="#module-wsgiref.handlers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code> – server/gateway base classes</a></li>

  104. <li><a class="reference internal" href="#module-wsgiref.types"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.types</span></code> – WSGI types for static type checking</a></li>

  105. <li><a class="reference internal" href="#examples">Examples</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. 

  110.   </div>

  111.   <div>

  112.     <h4>Previous topic</h4>

  113.     <p class="topless"><a href="webbrowser.html"

  114.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">webbrowser</span></code> — Convenient web-browser controller</a></p>

  115.   </div>

  116.   <div>

  117.     <h4>Next topic</h4>

  118.     <p class="topless"><a href="urllib.html"

  119.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib</span></code> — URL handling modules</a></p>

  120.   </div>

  121.   <div role="note" aria-label="source link">

  122.     <h3>This Page</h3>

  123.     <ul class="this-page-menu">

  124.       <li><a href="../bugs.html">Report a Bug</a></li>

  125.       <li>

  126.         <a href="https://github.com/python/cpython/blob/main/Doc/library/wsgiref.rst"

  127.             rel="nofollow">Show Source

  128.         </a>

  129.       </li>

  130.     </ul>

  131.   </div>

  132.         </nav>

  133.     </div>

  134. </div>

  135. 

  136.   

  137.     <div class="related" role="navigation" aria-label="related navigation">

  138.       <h3>Navigation</h3>

  139.       <ul>

  140.         <li class="right" style="margin-right: 10px">

  141.           <a href="../genindex.html" title="General Index"

  142.              accesskey="I">index</a></li>

  143.         <li class="right" >

  144.           <a href="../py-modindex.html" title="Python Module Index"

  145.              >modules</a> |</li>

  146.         <li class="right" >

  147.           <a href="urllib.html" title="urllib — URL handling modules"

  148.              accesskey="N">next</a> |</li>

  149.         <li class="right" >

  150.           <a href="webbrowser.html" title="webbrowser — Convenient web-browser controller"

  151.              accesskey="P">previous</a> |</li>

  152. 

  153.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  154.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  155.           <li class="switchers">

  156.             <div class="language_switcher_placeholder"></div>

  157.             <div class="version_switcher_placeholder"></div>

  158.           </li>

  159.           <li>

  160.               

  161.           </li>

  162.     <li id="cpython-language-and-version">

  163.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  164.     </li>

  165. 

  166.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  167.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  168.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code> — WSGI Utilities and Reference Implementation</a></li>

  169.                 <li class="right">

  170.                     

  171. 

  172.     <div class="inline-search" role="search">

  173.         <form class="inline-search" action="../search.html" method="get">

  174.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  175.           <input type="submit" value="Go" />

  176.         </form>

  177.     </div>

  178.                      |

  179.                 </li>

  180.             <li class="right">

  181. <label class="theme-selector-label">

  182.     Theme

  183.     <select class="theme-selector" oninput="activateTheme(this.value)">

  184.         <option value="auto" selected>Auto</option>

  185.         <option value="light">Light</option>

  186.         <option value="dark">Dark</option>

  187.     </select>

  188. </label> |</li>

  189.             

  190.       </ul>

  191.     </div>    

  192. 

  193.     <div class="document">

  194.       <div class="documentwrapper">

  195.         <div class="bodywrapper">

  196.           <div class="body" role="main">

  197.             

  198.   <section id="module-wsgiref">

  199. <span id="wsgiref-wsgi-utilities-and-reference-implementation"></span><h1><a class="reference internal" href="#module-wsgiref" title="wsgiref: WSGI Utilities and Reference Implementation."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code></a> — WSGI Utilities and Reference Implementation<a class="headerlink" href="#module-wsgiref" title="Link to this heading">¶</a></h1>

  200. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/wsgiref">Lib/wsgiref</a></p>

  201. <hr class="docutils" />

  202. <p>The Web Server Gateway Interface (WSGI) is a standard interface between web

  203. server software and web applications written in Python. Having a standard

  204. interface makes it easy to use an application that supports WSGI with a number

  205. of different web servers.</p>

  206. <p>Only authors of web servers and programming frameworks need to know every detail

  207. and corner case of the WSGI design.  You don’t need to understand every detail

  208. of WSGI just to install a WSGI application or to write a web application using

  209. an existing framework.</p>

  210. <p><a class="reference internal" href="#module-wsgiref" title="wsgiref: WSGI Utilities and Reference Implementation."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code></a> is a reference implementation of the WSGI specification that can

  211. be used to add WSGI support to a web server or framework.  It provides utilities

  212. for manipulating WSGI environment variables and response headers, base classes

  213. for implementing WSGI servers, a demo HTTP server that serves WSGI applications,

  214. types for static type checking,

  215. and a validation tool that checks WSGI servers and applications for conformance

  216. to the WSGI specification (<span class="target" id="index-0"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>).</p>

  217. <p>See <a class="reference external" href="https://wsgi.readthedocs.io/">wsgi.readthedocs.io</a> for more information about WSGI, and links

  218. to tutorials and other resources.</p>

  219. <section id="module-wsgiref.util">

  220. <span id="wsgiref-util-wsgi-environment-utilities"></span><h2><a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code></a> – WSGI environment utilities<a class="headerlink" href="#module-wsgiref.util" title="Link to this heading">¶</a></h2>

  221. <p>This module provides a variety of utility functions for working with WSGI

  222. environments.  A WSGI environment is a dictionary containing HTTP request

  223. variables as described in <span class="target" id="index-1"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.  All of the functions taking an <em>environ</em>

  224. parameter expect a WSGI-compliant dictionary to be supplied; please see

  225. <span class="target" id="index-2"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a> for a detailed specification and

  226. <a class="reference internal" href="#wsgiref.types.WSGIEnvironment" title="wsgiref.types.WSGIEnvironment"><code class="xref py py-data docutils literal notranslate"><span class="pre">WSGIEnvironment</span></code></a> for a type alias that can be used

  227. in type annotations.</p>

  228. <dl class="py function">

  229. <dt class="sig sig-object py" id="wsgiref.util.guess_scheme">

  230. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">guess_scheme</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.guess_scheme" title="Link to this definition">¶</a></dt>

  231. <dd><p>Return a guess for whether <code class="docutils literal notranslate"><span class="pre">wsgi.url_scheme</span></code> should be “http” or “https”, by

  232. checking for a <code class="docutils literal notranslate"><span class="pre">HTTPS</span></code> environment variable in the <em>environ</em> dictionary.  The

  233. return value is a string.</p>

  234. <p>This function is useful when creating a gateway that wraps CGI or a CGI-like

  235. protocol such as FastCGI.  Typically, servers providing such protocols will

  236. include a <code class="docutils literal notranslate"><span class="pre">HTTPS</span></code> variable with a value of “1”, “yes”, or “on” when a request

  237. is received via SSL.  So, this function returns “https” if such a value is

  238. found, and “http” otherwise.</p>

  239. </dd></dl>

  240. 

  241. <dl class="py function">

  242. <dt class="sig sig-object py" id="wsgiref.util.request_uri">

  243. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">request_uri</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_query</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.request_uri" title="Link to this definition">¶</a></dt>

  244. <dd><p>Return the full request URI, optionally including the query string, using the

  245. algorithm found in the “URL Reconstruction” section of <span class="target" id="index-3"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.  If

  246. <em>include_query</em> is false, the query string is not included in the resulting URI.</p>

  247. </dd></dl>

  248. 

  249. <dl class="py function">

  250. <dt class="sig sig-object py" id="wsgiref.util.application_uri">

  251. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">application_uri</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.application_uri" title="Link to this definition">¶</a></dt>

  252. <dd><p>Similar to <a class="reference internal" href="#wsgiref.util.request_uri" title="wsgiref.util.request_uri"><code class="xref py py-func docutils literal notranslate"><span class="pre">request_uri()</span></code></a>, except that the <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> and

  253. <code class="docutils literal notranslate"><span class="pre">QUERY_STRING</span></code> variables are ignored.  The result is the base URI of the

  254. application object addressed by the request.</p>

  255. </dd></dl>

  256. 

  257. <dl class="py function">

  258. <dt class="sig sig-object py" id="wsgiref.util.shift_path_info">

  259. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">shift_path_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.shift_path_info" title="Link to this definition">¶</a></dt>

  260. <dd><p>Shift a single name from <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> to <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code> and return the name.

  261. The <em>environ</em> dictionary is <em>modified</em> in-place; use a copy if you need to keep

  262. the original <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> or <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code> intact.</p>

  263. <p>If there are no remaining path segments in <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code> is returned.</p>

  264. <p>Typically, this routine is used to process each portion of a request URI path,

  265. for example to treat the path as a series of dictionary keys. This routine

  266. modifies the passed-in environment to make it suitable for invoking another WSGI

  267. application that is located at the target URI. For example, if there is a WSGI

  268. application at <code class="docutils literal notranslate"><span class="pre">/foo</span></code>, and the request URI path is <code class="docutils literal notranslate"><span class="pre">/foo/bar/baz</span></code>, and the

  269. WSGI application at <code class="docutils literal notranslate"><span class="pre">/foo</span></code> calls <a class="reference internal" href="#wsgiref.util.shift_path_info" title="wsgiref.util.shift_path_info"><code class="xref py py-func docutils literal notranslate"><span class="pre">shift_path_info()</span></code></a>, it will receive the

  270. string “bar”, and the environment will be updated to be suitable for passing to

  271. a WSGI application at <code class="docutils literal notranslate"><span class="pre">/foo/bar</span></code>.  That is, <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code> will change from

  272. <code class="docutils literal notranslate"><span class="pre">/foo</span></code> to <code class="docutils literal notranslate"><span class="pre">/foo/bar</span></code>, and <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> will change from <code class="docutils literal notranslate"><span class="pre">/bar/baz</span></code> to

  273. <code class="docutils literal notranslate"><span class="pre">/baz</span></code>.</p>

  274. <p>When <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> is just a “/”, this routine returns an empty string and

  275. appends a trailing slash to <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code>, even though empty path segments are

  276. normally ignored, and <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code> doesn’t normally end in a slash.  This is

  277. intentional behavior, to ensure that an application can tell the difference

  278. between URIs ending in <code class="docutils literal notranslate"><span class="pre">/x</span></code> from ones ending in <code class="docutils literal notranslate"><span class="pre">/x/</span></code> when using this

  279. routine to do object traversal.</p>

  280. </dd></dl>

  281. 

  282. <dl class="py function">

  283. <dt class="sig sig-object py" id="wsgiref.util.setup_testing_defaults">

  284. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">setup_testing_defaults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.setup_testing_defaults" title="Link to this definition">¶</a></dt>

  285. <dd><p>Update <em>environ</em> with trivial defaults for testing purposes.</p>

  286. <p>This routine adds various parameters required for WSGI, including <code class="docutils literal notranslate"><span class="pre">HTTP_HOST</span></code>,

  287. <code class="docutils literal notranslate"><span class="pre">SERVER_NAME</span></code>, <code class="docutils literal notranslate"><span class="pre">SERVER_PORT</span></code>, <code class="docutils literal notranslate"><span class="pre">REQUEST_METHOD</span></code>, <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code>,

  288. <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code>, and all of the <span class="target" id="index-4"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>-defined <code class="docutils literal notranslate"><span class="pre">wsgi.*</span></code> variables.  It

  289. only supplies default values, and does not replace any existing settings for

  290. these variables.</p>

  291. <p>This routine is intended to make it easier for unit tests of WSGI servers and

  292. applications to set up dummy environments.  It should NOT be used by actual WSGI

  293. servers or applications, since the data is fake!</p>

  294. <p>Example usage:</p>

  295. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">wsgiref.util</span> <span class="kn">import</span> <span class="n">setup_testing_defaults</span>

  296. <span class="kn">from</span> <span class="nn">wsgiref.simple_server</span> <span class="kn">import</span> <span class="n">make_server</span>

  297. 

  298. <span class="c1"># A relatively simple WSGI application. It&#39;s going to print out the</span>

  299. <span class="c1"># environment dictionary after being updated by setup_testing_defaults</span>

  300. <span class="k">def</span> <span class="nf">simple_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>

  301.     <span class="n">setup_testing_defaults</span><span class="p">(</span><span class="n">environ</span><span class="p">)</span>

  302. 

  303.     <span class="n">status</span> <span class="o">=</span> <span class="s1">&#39;200 OK&#39;</span>

  304.     <span class="n">headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">&#39;Content-type&#39;</span><span class="p">,</span> <span class="s1">&#39;text/plain; charset=utf-8&#39;</span><span class="p">)]</span>

  305. 

  306.     <span class="n">start_response</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span>

  307. 

  308.     <span class="n">ret</span> <span class="o">=</span> <span class="p">[(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">value</span><span class="p">))</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s2">&quot;utf-8&quot;</span><span class="p">)</span>

  309.            <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">environ</span><span class="o">.</span><span class="n">items</span><span class="p">()]</span>

  310.     <span class="k">return</span> <span class="n">ret</span>

  311. 

  312. <span class="k">with</span> <span class="n">make_server</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">,</span> <span class="n">simple_app</span><span class="p">)</span> <span class="k">as</span> <span class="n">httpd</span><span class="p">:</span>

  313.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Serving on port 8000...&quot;</span><span class="p">)</span>

  314.     <span class="n">httpd</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  315. </pre></div>

  316. </div>

  317. </dd></dl>

  318. 

  319. <p>In addition to the environment functions above, the <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code></a> module

  320. also provides these miscellaneous utilities:</p>

  321. <dl class="py function">

  322. <dt class="sig sig-object py" id="wsgiref.util.is_hop_by_hop">

  323. <span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">is_hop_by_hop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.is_hop_by_hop" title="Link to this definition">¶</a></dt>

  324. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if ‘header_name’ is an HTTP/1.1 “Hop-by-Hop” header, as defined by

  325. <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html"><strong>RFC 2616</strong></a>.</p>

  326. </dd></dl>

  327. 

  328. <dl class="py class">

  329. <dt class="sig sig-object py" id="wsgiref.util.FileWrapper">

  330. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.util.</span></span><span class="sig-name descname"><span class="pre">FileWrapper</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filelike</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blksize</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">8192</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.util.FileWrapper" title="Link to this definition">¶</a></dt>

  331. <dd><p>A concrete implementation of the <a class="reference internal" href="#wsgiref.types.FileWrapper" title="wsgiref.types.FileWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">wsgiref.types.FileWrapper</span></code></a>

  332. protocol used to convert a file-like object to an <a class="reference internal" href="../glossary.html#term-iterator"><span class="xref std std-term">iterator</span></a>.

  333. The resulting objects

  334. are <a class="reference internal" href="../glossary.html#term-iterable"><span class="xref std std-term">iterable</span></a>s. As the object is iterated over, the

  335. optional <em>blksize</em> parameter will be repeatedly passed to the <em>filelike</em>

  336. object’s <code class="xref py py-meth docutils literal notranslate"><span class="pre">read()</span></code> method to obtain bytestrings to yield.  When <code class="xref py py-meth docutils literal notranslate"><span class="pre">read()</span></code>

  337. returns an empty bytestring, iteration is ended and is not resumable.</p>

  338. <p>If <em>filelike</em> has a <code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code> method, the returned object will also have a

  339. <code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code> method, and it will invoke the <em>filelike</em> object’s <code class="xref py py-meth docutils literal notranslate"><span class="pre">close()</span></code>

  340. method when called.</p>

  341. <p>Example usage:</p>

  342. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">io</span> <span class="kn">import</span> <span class="n">StringIO</span>

  343. <span class="kn">from</span> <span class="nn">wsgiref.util</span> <span class="kn">import</span> <span class="n">FileWrapper</span>

  344. 

  345. <span class="c1"># We&#39;re using a StringIO-buffer for as the file-like object</span>

  346. <span class="n">filelike</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">(</span><span class="s2">&quot;This is an example file-like object&quot;</span><span class="o">*</span><span class="mi">10</span><span class="p">)</span>

  347. <span class="n">wrapper</span> <span class="o">=</span> <span class="n">FileWrapper</span><span class="p">(</span><span class="n">filelike</span><span class="p">,</span> <span class="n">blksize</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>

  348. 

  349. <span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">wrapper</span><span class="p">:</span>

  350.     <span class="nb">print</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>

  351. </pre></div>

  352. </div>

  353. <div class="versionchanged">

  354. <p><span class="versionmodified changed">Changed in version 3.11: </span>Support for <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__getitem__()</span></code></a> method has been removed.</p>

  355. </div>

  356. </dd></dl>

  357. 

  358. </section>

  359. <section id="module-wsgiref.headers">

  360. <span id="wsgiref-headers-wsgi-response-header-tools"></span><h2><a class="reference internal" href="#module-wsgiref.headers" title="wsgiref.headers: WSGI response header tools."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.headers</span></code></a> – WSGI response header tools<a class="headerlink" href="#module-wsgiref.headers" title="Link to this heading">¶</a></h2>

  361. <p>This module provides a single class, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a>, for convenient

  362. manipulation of WSGI response headers using a mapping-like interface.</p>

  363. <dl class="py class">

  364. <dt class="sig sig-object py" id="wsgiref.headers.Headers">

  365. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.headers.</span></span><span class="sig-name descname"><span class="pre">Headers</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">headers</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.headers.Headers" title="Link to this definition">¶</a></dt>

  366. <dd><p>Create a mapping-like object wrapping <em>headers</em>, which must be a list of header

  367. name/value tuples as described in <span class="target" id="index-6"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>. The default value of <em>headers</em> is

  368. an empty list.</p>

  369. <p><a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a> objects support typical mapping operations including

  370. <a class="reference internal" href="../reference/datamodel.html#object.__getitem__" title="object.__getitem__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__getitem__()</span></code></a>, <a class="reference internal" href="stdtypes.html#dict.get" title="dict.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a>, <a class="reference internal" href="../reference/datamodel.html#object.__setitem__" title="object.__setitem__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__setitem__()</span></code></a>,

  371. <a class="reference internal" href="stdtypes.html#dict.setdefault" title="dict.setdefault"><code class="xref py py-meth docutils literal notranslate"><span class="pre">setdefault()</span></code></a>,

  372. <a class="reference internal" href="../reference/datamodel.html#object.__delitem__" title="object.__delitem__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__delitem__()</span></code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__contains__" title="object.__contains__"><code class="xref py py-meth docutils literal notranslate"><span class="pre">__contains__()</span></code></a>.  For each of

  373. these methods, the key is the header name (treated case-insensitively), and the

  374. value is the first value associated with that header name.  Setting a header

  375. deletes any existing values for that header, then adds a new value at the end of

  376. the wrapped header list.  Headers’ existing order is generally maintained, with

  377. new headers added to the end of the wrapped list.</p>

  378. <p>Unlike a dictionary, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a> objects do not raise an error when you try

  379. to get or delete a key that isn’t in the wrapped header list. Getting a

  380. nonexistent header just returns <code class="docutils literal notranslate"><span class="pre">None</span></code>, and deleting a nonexistent header does

  381. nothing.</p>

  382. <p><a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a> objects also support <code class="xref py py-meth docutils literal notranslate"><span class="pre">keys()</span></code>, <code class="xref py py-meth docutils literal notranslate"><span class="pre">values()</span></code>, and

  383. <code class="xref py py-meth docutils literal notranslate"><span class="pre">items()</span></code> methods.  The lists returned by <code class="xref py py-meth docutils literal notranslate"><span class="pre">keys()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">items()</span></code> can

  384. include the same key more than once if there is a multi-valued header.  The

  385. <code class="docutils literal notranslate"><span class="pre">len()</span></code> of a <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a> object is the same as the length of its

  386. <code class="xref py py-meth docutils literal notranslate"><span class="pre">items()</span></code>, which is the same as the length of the wrapped header list.  In

  387. fact, the <code class="xref py py-meth docutils literal notranslate"><span class="pre">items()</span></code> method just returns a copy of the wrapped header list.</p>

  388. <p>Calling <code class="docutils literal notranslate"><span class="pre">bytes()</span></code> on a <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a> object returns a formatted bytestring

  389. suitable for transmission as HTTP response headers.  Each header is placed on a

  390. line with its value, separated by a colon and a space. Each line is terminated

  391. by a carriage return and line feed, and the bytestring is terminated with a

  392. blank line.</p>

  393. <p>In addition to their mapping interface and formatting features, <a class="reference internal" href="#wsgiref.headers.Headers" title="wsgiref.headers.Headers"><code class="xref py py-class docutils literal notranslate"><span class="pre">Headers</span></code></a>

  394. objects also have the following methods for querying and adding multi-valued

  395. headers, and for adding headers with MIME parameters:</p>

  396. <dl class="py method">

  397. <dt class="sig sig-object py" id="wsgiref.headers.Headers.get_all">

  398. <span class="sig-name descname"><span class="pre">get_all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.headers.Headers.get_all" title="Link to this definition">¶</a></dt>

  399. <dd><p>Return a list of all the values for the named header.</p>

  400. <p>The returned list will be sorted in the order they appeared in the original

  401. header list or were added to this instance, and may contain duplicates.  Any

  402. fields deleted and re-inserted are always appended to the header list.  If no

  403. fields exist with the given name, returns an empty list.</p>

  404. </dd></dl>

  405. 

  406. <dl class="py method">

  407. <dt class="sig sig-object py" id="wsgiref.headers.Headers.add_header">

  408. <span class="sig-name descname"><span class="pre">add_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_params</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.headers.Headers.add_header" title="Link to this definition">¶</a></dt>

  409. <dd><p>Add a (possibly multi-valued) header, with optional MIME parameters specified

  410. via keyword arguments.</p>

  411. <p><em>name</em> is the header field to add.  Keyword arguments can be used to set MIME

  412. parameters for the header field.  Each parameter must be a string or <code class="docutils literal notranslate"><span class="pre">None</span></code>.

  413. Underscores in parameter names are converted to dashes, since dashes are illegal

  414. in Python identifiers, but many MIME parameter names include dashes.  If the

  415. parameter value is a string, it is added to the header value parameters in the

  416. form <code class="docutils literal notranslate"><span class="pre">name=&quot;value&quot;</span></code>. If it is <code class="docutils literal notranslate"><span class="pre">None</span></code>, only the parameter name is added.

  417. (This is used for MIME parameters without a value.)  Example usage:</p>

  418. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">h</span><span class="o">.</span><span class="n">add_header</span><span class="p">(</span><span class="s1">&#39;content-disposition&#39;</span><span class="p">,</span> <span class="s1">&#39;attachment&#39;</span><span class="p">,</span> <span class="n">filename</span><span class="o">=</span><span class="s1">&#39;bud.gif&#39;</span><span class="p">)</span>

  419. </pre></div>

  420. </div>

  421. <p>The above will add a header that looks like this:</p>

  422. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">Content</span><span class="o">-</span><span class="n">Disposition</span><span class="p">:</span> <span class="n">attachment</span><span class="p">;</span> <span class="n">filename</span><span class="o">=</span><span class="s2">&quot;bud.gif&quot;</span>

  423. </pre></div>

  424. </div>

  425. </dd></dl>

  426. 

  427. <div class="versionchanged">

  428. <p><span class="versionmodified changed">Changed in version 3.5: </span><em>headers</em> parameter is optional.</p>

  429. </div>

  430. </dd></dl>

  431. 

  432. </section>

  433. <section id="module-wsgiref.simple_server">

  434. <span id="wsgiref-simple-server-a-simple-wsgi-http-server"></span><h2><a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.simple_server</span></code></a> – a simple WSGI HTTP server<a class="headerlink" href="#module-wsgiref.simple_server" title="Link to this heading">¶</a></h2>

  435. <p>This module implements a simple HTTP server (based on <a class="reference internal" href="http.server.html#module-http.server" title="http.server: HTTP server and request handlers."><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.server</span></code></a>)

  436. that serves WSGI applications.  Each server instance serves a single WSGI

  437. application on a given host and port.  If you want to serve multiple

  438. applications on a single host and port, you should create a WSGI application

  439. that parses <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> to select which application to invoke for each

  440. request.  (E.g., using the <code class="xref py py-func docutils literal notranslate"><span class="pre">shift_path_info()</span></code> function from

  441. <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code></a>.)</p>

  442. <dl class="py function">

  443. <dt class="sig sig-object py" id="wsgiref.simple_server.make_server">

  444. <span class="sig-prename descclassname"><span class="pre">wsgiref.simple_server.</span></span><span class="sig-name descname"><span class="pre">make_server</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">app</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WSGIServer</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler_class</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">WSGIRequestHandler</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.make_server" title="Link to this definition">¶</a></dt>

  445. <dd><p>Create a new WSGI server listening on <em>host</em> and <em>port</em>, accepting connections

  446. for <em>app</em>.  The return value is an instance of the supplied <em>server_class</em>, and

  447. will process requests using the specified <em>handler_class</em>.  <em>app</em> must be a WSGI

  448. application object, as defined by <span class="target" id="index-7"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.</p>

  449. <p>Example usage:</p>

  450. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">wsgiref.simple_server</span> <span class="kn">import</span> <span class="n">make_server</span><span class="p">,</span> <span class="n">demo_app</span>

  451. 

  452. <span class="k">with</span> <span class="n">make_server</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">,</span> <span class="n">demo_app</span><span class="p">)</span> <span class="k">as</span> <span class="n">httpd</span><span class="p">:</span>

  453.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Serving HTTP on port 8000...&quot;</span><span class="p">)</span>

  454. 

  455.     <span class="c1"># Respond to requests until process is killed</span>

  456.     <span class="n">httpd</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  457. 

  458.     <span class="c1"># Alternative: serve one request, then exit</span>

  459.     <span class="n">httpd</span><span class="o">.</span><span class="n">handle_request</span><span class="p">()</span>

  460. </pre></div>

  461. </div>

  462. </dd></dl>

  463. 

  464. <dl class="py function">

  465. <dt class="sig sig-object py" id="wsgiref.simple_server.demo_app">

  466. <span class="sig-prename descclassname"><span class="pre">wsgiref.simple_server.</span></span><span class="sig-name descname"><span class="pre">demo_app</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_response</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.demo_app" title="Link to this definition">¶</a></dt>

  467. <dd><p>This function is a small but complete WSGI application that returns a text page

  468. containing the message “Hello world!” and a list of the key/value pairs provided

  469. in the <em>environ</em> parameter.  It’s useful for verifying that a WSGI server (such

  470. as <a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.simple_server</span></code></a>) is able to run a simple WSGI application

  471. correctly.</p>

  472. </dd></dl>

  473. 

  474. <dl class="py class">

  475. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer">

  476. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.simple_server.</span></span><span class="sig-name descname"><span class="pre">WSGIServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">RequestHandlerClass</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIServer" title="Link to this definition">¶</a></dt>

  477. <dd><p>Create a <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> instance.  <em>server_address</em> should be a

  478. <code class="docutils literal notranslate"><span class="pre">(host,port)</span></code> tuple, and <em>RequestHandlerClass</em> should be the subclass of

  479. <a class="reference internal" href="http.server.html#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">http.server.BaseHTTPRequestHandler</span></code></a> that will be used to process

  480. requests.</p>

  481. <p>You do not normally need to call this constructor, as the <a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_server()</span></code></a>

  482. function can handle all the details for you.</p>

  483. <p><a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> is a subclass of <a class="reference internal" href="http.server.html#http.server.HTTPServer" title="http.server.HTTPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">http.server.HTTPServer</span></code></a>, so all

  484. of its methods (such as <code class="xref py py-meth docutils literal notranslate"><span class="pre">serve_forever()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">handle_request()</span></code>) are

  485. available. <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> also provides these WSGI-specific methods:</p>

  486. <dl class="py method">

  487. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer.set_app">

  488. <span class="sig-name descname"><span class="pre">set_app</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">application</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIServer.set_app" title="Link to this definition">¶</a></dt>

  489. <dd><p>Sets the callable <em>application</em> as the WSGI application that will receive

  490. requests.</p>

  491. </dd></dl>

  492. 

  493. <dl class="py method">

  494. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIServer.get_app">

  495. <span class="sig-name descname"><span class="pre">get_app</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIServer.get_app" title="Link to this definition">¶</a></dt>

  496. <dd><p>Returns the currently set application callable.</p>

  497. </dd></dl>

  498. 

  499. <p>Normally, however, you do not need to use these additional methods, as

  500. <a class="reference internal" href="#wsgiref.simple_server.WSGIServer.set_app" title="wsgiref.simple_server.WSGIServer.set_app"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_app()</span></code></a> is normally called by <a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_server()</span></code></a>, and the

  501. <a class="reference internal" href="#wsgiref.simple_server.WSGIServer.get_app" title="wsgiref.simple_server.WSGIServer.get_app"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_app()</span></code></a> exists mainly for the benefit of request handler instances.</p>

  502. </dd></dl>

  503. 

  504. <dl class="py class">

  505. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler">

  506. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.simple_server.</span></span><span class="sig-name descname"><span class="pre">WSGIRequestHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler" title="Link to this definition">¶</a></dt>

  507. <dd><p>Create an HTTP handler for the given <em>request</em> (i.e. a socket), <em>client_address</em>

  508. (a <code class="docutils literal notranslate"><span class="pre">(host,port)</span></code> tuple), and <em>server</em> (<a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> instance).</p>

  509. <p>You do not need to create instances of this class directly; they are

  510. automatically created as needed by <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> objects.  You can,

  511. however, subclass this class and supply it as a <em>handler_class</em> to the

  512. <a class="reference internal" href="#wsgiref.simple_server.make_server" title="wsgiref.simple_server.make_server"><code class="xref py py-func docutils literal notranslate"><span class="pre">make_server()</span></code></a> function.  Some possibly relevant methods for overriding in

  513. subclasses:</p>

  514. <dl class="py method">

  515. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.get_environ">

  516. <span class="sig-name descname"><span class="pre">get_environ</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.get_environ" title="Link to this definition">¶</a></dt>

  517. <dd><p>Return a <a class="reference internal" href="#wsgiref.types.WSGIEnvironment" title="wsgiref.types.WSGIEnvironment"><code class="xref py py-data docutils literal notranslate"><span class="pre">WSGIEnvironment</span></code></a> dictionary for a

  518. request.  The default

  519. implementation copies the contents of the <a class="reference internal" href="#wsgiref.simple_server.WSGIServer" title="wsgiref.simple_server.WSGIServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">WSGIServer</span></code></a> object’s

  520. <code class="xref py py-attr docutils literal notranslate"><span class="pre">base_environ</span></code> dictionary attribute and then adds various headers derived

  521. from the HTTP request.  Each call to this method should return a new dictionary

  522. containing all of the relevant CGI environment variables as specified in

  523. <span class="target" id="index-8"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.</p>

  524. </dd></dl>

  525. 

  526. <dl class="py method">

  527. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.get_stderr">

  528. <span class="sig-name descname"><span class="pre">get_stderr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.get_stderr" title="Link to this definition">¶</a></dt>

  529. <dd><p>Return the object that should be used as the <code class="docutils literal notranslate"><span class="pre">wsgi.errors</span></code> stream. The default

  530. implementation just returns <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code>.</p>

  531. </dd></dl>

  532. 

  533. <dl class="py method">

  534. <dt class="sig sig-object py" id="wsgiref.simple_server.WSGIRequestHandler.handle">

  535. <span class="sig-name descname"><span class="pre">handle</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.simple_server.WSGIRequestHandler.handle" title="Link to this definition">¶</a></dt>

  536. <dd><p>Process the HTTP request.  The default implementation creates a handler instance

  537. using a <a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code></a> class to implement the actual WSGI application

  538. interface.</p>

  539. </dd></dl>

  540. 

  541. </dd></dl>

  542. 

  543. </section>

  544. <section id="module-wsgiref.validate">

  545. <span id="wsgiref-validate-wsgi-conformance-checker"></span><h2><a class="reference internal" href="#module-wsgiref.validate" title="wsgiref.validate: WSGI conformance checker."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.validate</span></code></a> — WSGI conformance checker<a class="headerlink" href="#module-wsgiref.validate" title="Link to this heading">¶</a></h2>

  546. <p>When creating new WSGI application objects, frameworks, servers, or middleware,

  547. it can be useful to validate the new code’s conformance using

  548. <a class="reference internal" href="#module-wsgiref.validate" title="wsgiref.validate: WSGI conformance checker."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.validate</span></code></a>.  This module provides a function that creates WSGI

  549. application objects that validate communications between a WSGI server or

  550. gateway and a WSGI application object, to check both sides for protocol

  551. conformance.</p>

  552. <p>Note that this utility does not guarantee complete <span class="target" id="index-9"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a> compliance; an

  553. absence of errors from this module does not necessarily mean that errors do not

  554. exist.  However, if this module does produce an error, then it is virtually

  555. certain that either the server or application is not 100% compliant.</p>

  556. <p>This module is based on the <code class="xref py py-mod docutils literal notranslate"><span class="pre">paste.lint</span></code> module from Ian Bicking’s “Python

  557. Paste” library.</p>

  558. <dl class="py function">

  559. <dt class="sig sig-object py" id="wsgiref.validate.validator">

  560. <span class="sig-prename descclassname"><span class="pre">wsgiref.validate.</span></span><span class="sig-name descname"><span class="pre">validator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">application</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.validate.validator" title="Link to this definition">¶</a></dt>

  561. <dd><p>Wrap <em>application</em> and return a new WSGI application object.  The returned

  562. application will forward all requests to the original <em>application</em>, and will

  563. check that both the <em>application</em> and the server invoking it are conforming to

  564. the WSGI specification and to <span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html"><strong>RFC 2616</strong></a>.</p>

  565. <p>Any detected nonconformance results in an <a class="reference internal" href="exceptions.html#AssertionError" title="AssertionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AssertionError</span></code></a> being raised;

  566. note, however, that how these errors are handled is server-dependent.  For

  567. example, <a class="reference internal" href="#module-wsgiref.simple_server" title="wsgiref.simple_server: A simple WSGI HTTP server."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.simple_server</span></code></a> and other servers based on

  568. <a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code></a> (that don’t override the error handling methods to do

  569. something else) will simply output a message that an error has occurred, and

  570. dump the traceback to <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> or some other error stream.</p>

  571. <p>This wrapper may also generate output using the <a class="reference internal" href="warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate"><span class="pre">warnings</span></code></a> module to

  572. indicate behaviors that are questionable but which may not actually be

  573. prohibited by <span class="target" id="index-11"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.  Unless they are suppressed using Python command-line

  574. options or the <a class="reference internal" href="warnings.html#module-warnings" title="warnings: Issue warning messages and control their disposition."><code class="xref py py-mod docutils literal notranslate"><span class="pre">warnings</span></code></a> API, any such warnings will be written to

  575. <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> (<em>not</em> <code class="docutils literal notranslate"><span class="pre">wsgi.errors</span></code>, unless they happen to be the same

  576. object).</p>

  577. <p>Example usage:</p>

  578. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">wsgiref.validate</span> <span class="kn">import</span> <span class="n">validator</span>

  579. <span class="kn">from</span> <span class="nn">wsgiref.simple_server</span> <span class="kn">import</span> <span class="n">make_server</span>

  580. 

  581. <span class="c1"># Our callable object which is intentionally not compliant to the</span>

  582. <span class="c1"># standard, so the validator is going to break</span>

  583. <span class="k">def</span> <span class="nf">simple_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>

  584.     <span class="n">status</span> <span class="o">=</span> <span class="s1">&#39;200 OK&#39;</span>  <span class="c1"># HTTP Status</span>

  585.     <span class="n">headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s1">&#39;Content-type&#39;</span><span class="p">,</span> <span class="s1">&#39;text/plain&#39;</span><span class="p">)]</span>  <span class="c1"># HTTP Headers</span>

  586.     <span class="n">start_response</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span>

  587. 

  588.     <span class="c1"># This is going to break because we need to return a list, and</span>

  589.     <span class="c1"># the validator is going to inform us</span>

  590.     <span class="k">return</span> <span class="sa">b</span><span class="s2">&quot;Hello World&quot;</span>

  591. 

  592. <span class="c1"># This is the application wrapped in a validator</span>

  593. <span class="n">validator_app</span> <span class="o">=</span> <span class="n">validator</span><span class="p">(</span><span class="n">simple_app</span><span class="p">)</span>

  594. 

  595. <span class="k">with</span> <span class="n">make_server</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">,</span> <span class="n">validator_app</span><span class="p">)</span> <span class="k">as</span> <span class="n">httpd</span><span class="p">:</span>

  596.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Listening on port 8000....&quot;</span><span class="p">)</span>

  597.     <span class="n">httpd</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  598. </pre></div>

  599. </div>

  600. </dd></dl>

  601. 

  602. </section>

  603. <section id="module-wsgiref.handlers">

  604. <span id="wsgiref-handlers-server-gateway-base-classes"></span><h2><a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code></a> – server/gateway base classes<a class="headerlink" href="#module-wsgiref.handlers" title="Link to this heading">¶</a></h2>

  605. <p>This module provides base handler classes for implementing WSGI servers and

  606. gateways.  These base classes handle most of the work of communicating with a

  607. WSGI application, as long as they are given a CGI-like environment, along with

  608. input, output, and error streams.</p>

  609. <dl class="py class">

  610. <dt class="sig sig-object py" id="wsgiref.handlers.CGIHandler">

  611. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">CGIHandler</span></span><a class="headerlink" href="#wsgiref.handlers.CGIHandler" title="Link to this definition">¶</a></dt>

  612. <dd><p>CGI-based invocation via <code class="docutils literal notranslate"><span class="pre">sys.stdin</span></code>, <code class="docutils literal notranslate"><span class="pre">sys.stdout</span></code>, <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code> and

  613. <code class="docutils literal notranslate"><span class="pre">os.environ</span></code>.  This is useful when you have a WSGI application and want to run

  614. it as a CGI script.  Simply invoke <code class="docutils literal notranslate"><span class="pre">CGIHandler().run(app)</span></code>, where <code class="docutils literal notranslate"><span class="pre">app</span></code> is

  615. the WSGI application object you wish to invoke.</p>

  616. <p>This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseCGIHandler</span></code></a> that sets <code class="docutils literal notranslate"><span class="pre">wsgi.run_once</span></code>

  617. to true, <code class="docutils literal notranslate"><span class="pre">wsgi.multithread</span></code> to false, and <code class="docutils literal notranslate"><span class="pre">wsgi.multiprocess</span></code> to true, and

  618. always uses <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys</span></code></a> and <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> to obtain the necessary CGI streams and

  619. environment.</p>

  620. </dd></dl>

  621. 

  622. <dl class="py class">

  623. <dt class="sig sig-object py" id="wsgiref.handlers.IISCGIHandler">

  624. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">IISCGIHandler</span></span><a class="headerlink" href="#wsgiref.handlers.IISCGIHandler" title="Link to this definition">¶</a></dt>

  625. <dd><p>A specialized alternative to <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a>, for use when deploying on

  626. Microsoft’s IIS web server, without having set the config allowPathInfo

  627. option (IIS&gt;=7) or metabase allowPathInfoForScriptMappings (IIS&lt;7).</p>

  628. <p>By default, IIS gives a <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code> that duplicates the <code class="docutils literal notranslate"><span class="pre">SCRIPT_NAME</span></code> at

  629. the front, causing problems for WSGI applications that wish to implement

  630. routing. This handler strips any such duplicated path.</p>

  631. <p>IIS can be configured to pass the correct <code class="docutils literal notranslate"><span class="pre">PATH_INFO</span></code>, but this causes

  632. another bug where <code class="docutils literal notranslate"><span class="pre">PATH_TRANSLATED</span></code> is wrong. Luckily this variable is

  633. rarely used and is not guaranteed by WSGI. On IIS&lt;7, though, the

  634. setting can only be made on a vhost level, affecting all other script

  635. mappings, many of which break when exposed to the <code class="docutils literal notranslate"><span class="pre">PATH_TRANSLATED</span></code> bug.

  636. For this reason IIS&lt;7 is almost never deployed with the fix (Even IIS7

  637. rarely uses it because there is still no UI for it.).</p>

  638. <p>There is no way for CGI code to tell whether the option was set, so a

  639. separate handler class is provided.  It is used in the same way as

  640. <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a>, i.e., by calling <code class="docutils literal notranslate"><span class="pre">IISCGIHandler().run(app)</span></code>, where

  641. <code class="docutils literal notranslate"><span class="pre">app</span></code> is the WSGI application object you wish to invoke.</p>

  642. <div class="versionadded">

  643. <p><span class="versionmodified added">New in version 3.2.</span></p>

  644. </div>

  645. </dd></dl>

  646. 

  647. <dl class="py class">

  648. <dt class="sig sig-object py" id="wsgiref.handlers.BaseCGIHandler">

  649. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">BaseCGIHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stdin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multithread</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiprocess</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseCGIHandler" title="Link to this definition">¶</a></dt>

  650. <dd><p>Similar to <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a>, but instead of using the <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><code class="xref py py-mod docutils literal notranslate"><span class="pre">sys</span></code></a> and

  651. <a class="reference internal" href="os.html#module-os" title="os: Miscellaneous operating system interfaces."><code class="xref py py-mod docutils literal notranslate"><span class="pre">os</span></code></a> modules, the CGI environment and I/O streams are specified explicitly.

  652. The <em>multithread</em> and <em>multiprocess</em> values are used to set the

  653. <code class="docutils literal notranslate"><span class="pre">wsgi.multithread</span></code> and <code class="docutils literal notranslate"><span class="pre">wsgi.multiprocess</span></code> flags for any applications run by

  654. the handler instance.</p>

  655. <p>This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.SimpleHandler" title="wsgiref.handlers.SimpleHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHandler</span></code></a> intended for use with

  656. software other than HTTP “origin servers”.  If you are writing a gateway

  657. protocol implementation (such as CGI, FastCGI, SCGI, etc.) that uses a

  658. <code class="docutils literal notranslate"><span class="pre">Status:</span></code> header to send an HTTP status, you probably want to subclass this

  659. instead of <a class="reference internal" href="#wsgiref.handlers.SimpleHandler" title="wsgiref.handlers.SimpleHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHandler</span></code></a>.</p>

  660. </dd></dl>

  661. 

  662. <dl class="py class">

  663. <dt class="sig sig-object py" id="wsgiref.handlers.SimpleHandler">

  664. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">SimpleHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stdin</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stdout</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stderr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">environ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multithread</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multiprocess</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.SimpleHandler" title="Link to this definition">¶</a></dt>

  665. <dd><p>Similar to <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseCGIHandler</span></code></a>, but designed for use with HTTP origin

  666. servers.  If you are writing an HTTP server implementation, you will probably

  667. want to subclass this instead of <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseCGIHandler</span></code></a>.</p>

  668. <p>This class is a subclass of <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>.  It overrides the

  669. <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code>, <a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stdin" title="wsgiref.handlers.BaseHandler.get_stdin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_stdin()</span></code></a>,

  670. <a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stderr" title="wsgiref.handlers.BaseHandler.get_stderr"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_stderr()</span></code></a>, <a class="reference internal" href="#wsgiref.handlers.BaseHandler.add_cgi_vars" title="wsgiref.handlers.BaseHandler.add_cgi_vars"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_cgi_vars()</span></code></a>,

  671. <a class="reference internal" href="#wsgiref.handlers.BaseHandler._write" title="wsgiref.handlers.BaseHandler._write"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_write()</span></code></a>, and <a class="reference internal" href="#wsgiref.handlers.BaseHandler._flush" title="wsgiref.handlers.BaseHandler._flush"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_flush()</span></code></a> methods to

  672. support explicitly setting the

  673. environment and streams via the constructor.  The supplied environment and

  674. streams are stored in the <code class="xref py py-attr docutils literal notranslate"><span class="pre">stdin</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">stdout</span></code>, <code class="xref py py-attr docutils literal notranslate"><span class="pre">stderr</span></code>, and

  675. <code class="xref py py-attr docutils literal notranslate"><span class="pre">environ</span></code> attributes.</p>

  676. <p>The <a class="reference internal" href="io.html#io.BufferedIOBase.write" title="io.BufferedIOBase.write"><code class="xref py py-meth docutils literal notranslate"><span class="pre">write()</span></code></a> method of <em>stdout</em> should write

  677. each chunk in full, like <a class="reference internal" href="io.html#io.BufferedIOBase" title="io.BufferedIOBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.BufferedIOBase</span></code></a>.</p>

  678. </dd></dl>

  679. 

  680. <dl class="py class">

  681. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler">

  682. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">BaseHandler</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler" title="Link to this definition">¶</a></dt>

  683. <dd><p>This is an abstract base class for running WSGI applications.  Each instance

  684. will handle a single HTTP request, although in principle you could create a

  685. subclass that was reusable for multiple requests.</p>

  686. <p><a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a> instances have only one method intended for external use:</p>

  687. <dl class="py method">

  688. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.run">

  689. <span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.run" title="Link to this definition">¶</a></dt>

  690. <dd><p>Run the specified WSGI application, <em>app</em>.</p>

  691. </dd></dl>

  692. 

  693. <p>All of the other <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a> methods are invoked by this method in the

  694. process of running the application, and thus exist primarily to allow

  695. customizing the process.</p>

  696. <p>The following methods MUST be overridden in a subclass:</p>

  697. <dl class="py method">

  698. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler._write">

  699. <span class="sig-name descname"><span class="pre">_write</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler._write" title="Link to this definition">¶</a></dt>

  700. <dd><p>Buffer the bytes <em>data</em> for transmission to the client.  It’s okay if this

  701. method actually transmits the data; <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a> just separates write

  702. and flush operations for greater efficiency when the underlying system actually

  703. has such a distinction.</p>

  704. </dd></dl>

  705. 

  706. <dl class="py method">

  707. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler._flush">

  708. <span class="sig-name descname"><span class="pre">_flush</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler._flush" title="Link to this definition">¶</a></dt>

  709. <dd><p>Force buffered data to be transmitted to the client.  It’s okay if this method

  710. is a no-op (i.e., if <a class="reference internal" href="#wsgiref.handlers.BaseHandler._write" title="wsgiref.handlers.BaseHandler._write"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_write()</span></code></a> actually sends the data).</p>

  711. </dd></dl>

  712. 

  713. <dl class="py method">

  714. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_stdin">

  715. <span class="sig-name descname"><span class="pre">get_stdin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_stdin" title="Link to this definition">¶</a></dt>

  716. <dd><p>Return an object compatible with <a class="reference internal" href="#wsgiref.types.InputStream" title="wsgiref.types.InputStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">InputStream</span></code></a>

  717. suitable for use as the <code class="docutils literal notranslate"><span class="pre">wsgi.input</span></code> of the

  718. request currently being processed.</p>

  719. </dd></dl>

  720. 

  721. <dl class="py method">

  722. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_stderr">

  723. <span class="sig-name descname"><span class="pre">get_stderr</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_stderr" title="Link to this definition">¶</a></dt>

  724. <dd><p>Return an object compatible with <a class="reference internal" href="#wsgiref.types.ErrorStream" title="wsgiref.types.ErrorStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorStream</span></code></a>

  725. suitable for use as the <code class="docutils literal notranslate"><span class="pre">wsgi.errors</span></code> of the

  726. request currently being processed.</p>

  727. </dd></dl>

  728. 

  729. <dl class="py method">

  730. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.add_cgi_vars">

  731. <span class="sig-name descname"><span class="pre">add_cgi_vars</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.add_cgi_vars" title="Link to this definition">¶</a></dt>

  732. <dd><p>Insert CGI variables for the current request into the <code class="xref py py-attr docutils literal notranslate"><span class="pre">environ</span></code> attribute.</p>

  733. </dd></dl>

  734. 

  735. <p>Here are some other methods and attributes you may wish to override. This list

  736. is only a summary, however, and does not include every method that can be

  737. overridden.  You should consult the docstrings and source code for additional

  738. information before attempting to create a customized <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>

  739. subclass.</p>

  740. <p>Attributes and methods for customizing the WSGI environment:</p>

  741. <dl class="py attribute">

  742. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_multithread">

  743. <span class="sig-name descname"><span class="pre">wsgi_multithread</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_multithread" title="Link to this definition">¶</a></dt>

  744. <dd><p>The value to be used for the <code class="docutils literal notranslate"><span class="pre">wsgi.multithread</span></code> environment variable.  It

  745. defaults to true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>, but may have a different default (or

  746. be set by the constructor) in the other subclasses.</p>

  747. </dd></dl>

  748. 

  749. <dl class="py attribute">

  750. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_multiprocess">

  751. <span class="sig-name descname"><span class="pre">wsgi_multiprocess</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_multiprocess" title="Link to this definition">¶</a></dt>

  752. <dd><p>The value to be used for the <code class="docutils literal notranslate"><span class="pre">wsgi.multiprocess</span></code> environment variable.  It

  753. defaults to true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>, but may have a different default (or

  754. be set by the constructor) in the other subclasses.</p>

  755. </dd></dl>

  756. 

  757. <dl class="py attribute">

  758. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_run_once">

  759. <span class="sig-name descname"><span class="pre">wsgi_run_once</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_run_once" title="Link to this definition">¶</a></dt>

  760. <dd><p>The value to be used for the <code class="docutils literal notranslate"><span class="pre">wsgi.run_once</span></code> environment variable.  It

  761. defaults to false in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>, but <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a> sets it to

  762. true by default.</p>

  763. </dd></dl>

  764. 

  765. <dl class="py attribute">

  766. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.os_environ">

  767. <span class="sig-name descname"><span class="pre">os_environ</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.os_environ" title="Link to this definition">¶</a></dt>

  768. <dd><p>The default environment variables to be included in every request’s WSGI

  769. environment.  By default, this is a copy of <code class="docutils literal notranslate"><span class="pre">os.environ</span></code> at the time that

  770. <a class="reference internal" href="#module-wsgiref.handlers" title="wsgiref.handlers: WSGI server/gateway base classes."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code></a> was imported, but subclasses can either create their own

  771. at the class or instance level.  Note that the dictionary should be considered

  772. read-only, since the default value is shared between multiple classes and

  773. instances.</p>

  774. </dd></dl>

  775. 

  776. <dl class="py attribute">

  777. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.server_software">

  778. <span class="sig-name descname"><span class="pre">server_software</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.server_software" title="Link to this definition">¶</a></dt>

  779. <dd><p>If the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate"><span class="pre">origin_server</span></code></a> attribute is set, this attribute’s value is used to

  780. set the default <code class="docutils literal notranslate"><span class="pre">SERVER_SOFTWARE</span></code> WSGI environment variable, and also to set a

  781. default <code class="docutils literal notranslate"><span class="pre">Server:</span></code> header in HTTP responses.  It is ignored for handlers (such

  782. as <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseCGIHandler</span></code></a> and <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a>) that are not HTTP origin

  783. servers.</p>

  784. <div class="versionchanged">

  785. <p><span class="versionmodified changed">Changed in version 3.3: </span>The term “Python” is replaced with implementation specific term like

  786. “CPython”, “Jython” etc.</p>

  787. </div>

  788. </dd></dl>

  789. 

  790. <dl class="py method">

  791. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.get_scheme">

  792. <span class="sig-name descname"><span class="pre">get_scheme</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.get_scheme" title="Link to this definition">¶</a></dt>

  793. <dd><p>Return the URL scheme being used for the current request.  The default

  794. implementation uses the <code class="xref py py-func docutils literal notranslate"><span class="pre">guess_scheme()</span></code> function from <a class="reference internal" href="#module-wsgiref.util" title="wsgiref.util: WSGI environment utilities."><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code></a>

  795. to guess whether the scheme should be “http” or “https”, based on the current

  796. request’s <code class="xref py py-attr docutils literal notranslate"><span class="pre">environ</span></code> variables.</p>

  797. </dd></dl>

  798. 

  799. <dl class="py method">

  800. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.setup_environ">

  801. <span class="sig-name descname"><span class="pre">setup_environ</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.setup_environ" title="Link to this definition">¶</a></dt>

  802. <dd><p>Set the <code class="xref py py-attr docutils literal notranslate"><span class="pre">environ</span></code> attribute to a fully populated WSGI environment.  The

  803. default implementation uses all of the above methods and attributes, plus the

  804. <a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stdin" title="wsgiref.handlers.BaseHandler.get_stdin"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_stdin()</span></code></a>, <a class="reference internal" href="#wsgiref.handlers.BaseHandler.get_stderr" title="wsgiref.handlers.BaseHandler.get_stderr"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_stderr()</span></code></a>, and <a class="reference internal" href="#wsgiref.handlers.BaseHandler.add_cgi_vars" title="wsgiref.handlers.BaseHandler.add_cgi_vars"><code class="xref py py-meth docutils literal notranslate"><span class="pre">add_cgi_vars()</span></code></a> methods and the

  805. <a class="reference internal" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="wsgiref.handlers.BaseHandler.wsgi_file_wrapper"><code class="xref py py-attr docutils literal notranslate"><span class="pre">wsgi_file_wrapper</span></code></a> attribute.  It also inserts a <code class="docutils literal notranslate"><span class="pre">SERVER_SOFTWARE</span></code> key

  806. if not present, as long as the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate"><span class="pre">origin_server</span></code></a> attribute is a true value

  807. and the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.server_software" title="wsgiref.handlers.BaseHandler.server_software"><code class="xref py py-attr docutils literal notranslate"><span class="pre">server_software</span></code></a> attribute is set.</p>

  808. </dd></dl>

  809. 

  810. <p>Methods and attributes for customizing exception handling:</p>

  811. <dl class="py method">

  812. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.log_exception">

  813. <span class="sig-name descname"><span class="pre">log_exception</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exc_info</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.log_exception" title="Link to this definition">¶</a></dt>

  814. <dd><p>Log the <em>exc_info</em> tuple in the server log.  <em>exc_info</em> is a <code class="docutils literal notranslate"><span class="pre">(type,</span> <span class="pre">value,</span>

  815. <span class="pre">traceback)</span></code> tuple.  The default implementation simply writes the traceback to

  816. the request’s <code class="docutils literal notranslate"><span class="pre">wsgi.errors</span></code> stream and flushes it.  Subclasses can override

  817. this method to change the format or retarget the output, mail the traceback to

  818. an administrator, or whatever other action may be deemed suitable.</p>

  819. </dd></dl>

  820. 

  821. <dl class="py attribute">

  822. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.traceback_limit">

  823. <span class="sig-name descname"><span class="pre">traceback_limit</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.traceback_limit" title="Link to this definition">¶</a></dt>

  824. <dd><p>The maximum number of frames to include in tracebacks output by the default

  825. <a class="reference internal" href="#wsgiref.handlers.BaseHandler.log_exception" title="wsgiref.handlers.BaseHandler.log_exception"><code class="xref py py-meth docutils literal notranslate"><span class="pre">log_exception()</span></code></a> method.  If <code class="docutils literal notranslate"><span class="pre">None</span></code>, all frames are included.</p>

  826. </dd></dl>

  827. 

  828. <dl class="py method">

  829. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_output">

  830. <span class="sig-name descname"><span class="pre">error_output</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">environ</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start_response</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_output" title="Link to this definition">¶</a></dt>

  831. <dd><p>This method is a WSGI application to generate an error page for the user.  It is

  832. only invoked if an error occurs before headers are sent to the client.</p>

  833. <p>This method can access the current error using <code class="docutils literal notranslate"><span class="pre">sys.exception()</span></code>,

  834. and should pass that information to <em>start_response</em> when calling it (as

  835. described in the “Error Handling” section of <span class="target" id="index-12"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>).</p>

  836. <p>The default implementation just uses the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_status" title="wsgiref.handlers.BaseHandler.error_status"><code class="xref py py-attr docutils literal notranslate"><span class="pre">error_status</span></code></a>,

  837. <a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_headers" title="wsgiref.handlers.BaseHandler.error_headers"><code class="xref py py-attr docutils literal notranslate"><span class="pre">error_headers</span></code></a>, and <a class="reference internal" href="#wsgiref.handlers.BaseHandler.error_body" title="wsgiref.handlers.BaseHandler.error_body"><code class="xref py py-attr docutils literal notranslate"><span class="pre">error_body</span></code></a> attributes to generate an output

  838. page.  Subclasses can override this to produce more dynamic error output.</p>

  839. <p>Note, however, that it’s not recommended from a security perspective to spit out

  840. diagnostics to any old user; ideally, you should have to do something special to

  841. enable diagnostic output, which is why the default implementation doesn’t

  842. include any.</p>

  843. </dd></dl>

  844. 

  845. <dl class="py attribute">

  846. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_status">

  847. <span class="sig-name descname"><span class="pre">error_status</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_status" title="Link to this definition">¶</a></dt>

  848. <dd><p>The HTTP status used for error responses.  This should be a status string as

  849. defined in <span class="target" id="index-13"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>; it defaults to a 500 code and message.</p>

  850. </dd></dl>

  851. 

  852. <dl class="py attribute">

  853. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_headers">

  854. <span class="sig-name descname"><span class="pre">error_headers</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_headers" title="Link to this definition">¶</a></dt>

  855. <dd><p>The HTTP headers used for error responses.  This should be a list of WSGI

  856. response headers (<code class="docutils literal notranslate"><span class="pre">(name,</span> <span class="pre">value)</span></code> tuples), as described in <span class="target" id="index-14"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.  The

  857. default list just sets the content type to <code class="docutils literal notranslate"><span class="pre">text/plain</span></code>.</p>

  858. </dd></dl>

  859. 

  860. <dl class="py attribute">

  861. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.error_body">

  862. <span class="sig-name descname"><span class="pre">error_body</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.error_body" title="Link to this definition">¶</a></dt>

  863. <dd><p>The error response body.  This should be an HTTP response body bytestring. It

  864. defaults to the plain text, “A server error occurred.  Please contact the

  865. administrator.”</p>

  866. </dd></dl>

  867. 

  868. <p>Methods and attributes for <span class="target" id="index-15"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>’s “Optional Platform-Specific File

  869. Handling” feature:</p>

  870. <dl class="py attribute">

  871. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.wsgi_file_wrapper">

  872. <span class="sig-name descname"><span class="pre">wsgi_file_wrapper</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="Link to this definition">¶</a></dt>

  873. <dd><p>A <code class="docutils literal notranslate"><span class="pre">wsgi.file_wrapper</span></code> factory, compatible with

  874. <a class="reference internal" href="#wsgiref.types.FileWrapper" title="wsgiref.types.FileWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">wsgiref.types.FileWrapper</span></code></a>, or <code class="docutils literal notranslate"><span class="pre">None</span></code>.  The default value

  875. of this attribute is the <a class="reference internal" href="#wsgiref.util.FileWrapper" title="wsgiref.util.FileWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">wsgiref.util.FileWrapper</span></code></a> class.</p>

  876. </dd></dl>

  877. 

  878. <dl class="py method">

  879. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.sendfile">

  880. <span class="sig-name descname"><span class="pre">sendfile</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.sendfile" title="Link to this definition">¶</a></dt>

  881. <dd><p>Override to implement platform-specific file transmission.  This method is

  882. called only if the application’s return value is an instance of the class

  883. specified by the <a class="reference internal" href="#wsgiref.handlers.BaseHandler.wsgi_file_wrapper" title="wsgiref.handlers.BaseHandler.wsgi_file_wrapper"><code class="xref py py-attr docutils literal notranslate"><span class="pre">wsgi_file_wrapper</span></code></a> attribute.  It should return a true

  884. value if it was able to successfully transmit the file, so that the default

  885. transmission code will not be executed. The default implementation of this

  886. method just returns a false value.</p>

  887. </dd></dl>

  888. 

  889. <p>Miscellaneous methods and attributes:</p>

  890. <dl class="py attribute">

  891. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.origin_server">

  892. <span class="sig-name descname"><span class="pre">origin_server</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.origin_server" title="Link to this definition">¶</a></dt>

  893. <dd><p>This attribute should be set to a true value if the handler’s <a class="reference internal" href="#wsgiref.handlers.BaseHandler._write" title="wsgiref.handlers.BaseHandler._write"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_write()</span></code></a> and

  894. <a class="reference internal" href="#wsgiref.handlers.BaseHandler._flush" title="wsgiref.handlers.BaseHandler._flush"><code class="xref py py-meth docutils literal notranslate"><span class="pre">_flush()</span></code></a> are being used to communicate directly to the client, rather than

  895. via a CGI-like gateway protocol that wants the HTTP status in a special

  896. <code class="docutils literal notranslate"><span class="pre">Status:</span></code> header.</p>

  897. <p>This attribute’s default value is true in <a class="reference internal" href="#wsgiref.handlers.BaseHandler" title="wsgiref.handlers.BaseHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHandler</span></code></a>, but false in

  898. <a class="reference internal" href="#wsgiref.handlers.BaseCGIHandler" title="wsgiref.handlers.BaseCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseCGIHandler</span></code></a> and <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a>.</p>

  899. </dd></dl>

  900. 

  901. <dl class="py attribute">

  902. <dt class="sig sig-object py" id="wsgiref.handlers.BaseHandler.http_version">

  903. <span class="sig-name descname"><span class="pre">http_version</span></span><a class="headerlink" href="#wsgiref.handlers.BaseHandler.http_version" title="Link to this definition">¶</a></dt>

  904. <dd><p>If <a class="reference internal" href="#wsgiref.handlers.BaseHandler.origin_server" title="wsgiref.handlers.BaseHandler.origin_server"><code class="xref py py-attr docutils literal notranslate"><span class="pre">origin_server</span></code></a> is true, this string attribute is used to set the HTTP

  905. version of the response set to the client.  It defaults to <code class="docutils literal notranslate"><span class="pre">&quot;1.0&quot;</span></code>.</p>

  906. </dd></dl>

  907. 

  908. </dd></dl>

  909. 

  910. <dl class="py function">

  911. <dt class="sig sig-object py" id="wsgiref.handlers.read_environ">

  912. <span class="sig-prename descclassname"><span class="pre">wsgiref.handlers.</span></span><span class="sig-name descname"><span class="pre">read_environ</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#wsgiref.handlers.read_environ" title="Link to this definition">¶</a></dt>

  913. <dd><p>Transcode CGI variables from <code class="docutils literal notranslate"><span class="pre">os.environ</span></code> to <span class="target" id="index-16"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a> “bytes in unicode”

  914. strings, returning a new dictionary.  This function is used by

  915. <a class="reference internal" href="#wsgiref.handlers.CGIHandler" title="wsgiref.handlers.CGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHandler</span></code></a> and <a class="reference internal" href="#wsgiref.handlers.IISCGIHandler" title="wsgiref.handlers.IISCGIHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">IISCGIHandler</span></code></a> in place of directly using

  916. <code class="docutils literal notranslate"><span class="pre">os.environ</span></code>, which is not necessarily WSGI-compliant on all platforms

  917. and web servers using Python 3 – specifically, ones where the OS’s

  918. actual environment is Unicode (i.e. Windows), or ones where the environment

  919. is bytes, but the system encoding used by Python to decode it is anything

  920. other than ISO-8859-1 (e.g. Unix systems using UTF-8).</p>

  921. <p>If you are implementing a CGI-based handler of your own, you probably want

  922. to use this routine instead of just copying values out of <code class="docutils literal notranslate"><span class="pre">os.environ</span></code>

  923. directly.</p>

  924. <div class="versionadded">

  925. <p><span class="versionmodified added">New in version 3.2.</span></p>

  926. </div>

  927. </dd></dl>

  928. 

  929. </section>

  930. <section id="module-wsgiref.types">

  931. <span id="wsgiref-types-wsgi-types-for-static-type-checking"></span><h2><a class="reference internal" href="#module-wsgiref.types" title="wsgiref.types: WSGI types for static type checking"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.types</span></code></a> – WSGI types for static type checking<a class="headerlink" href="#module-wsgiref.types" title="Link to this heading">¶</a></h2>

  932. <p>This module provides various types for static type checking as described

  933. in <span class="target" id="index-17"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>.</p>

  934. <div class="versionadded">

  935. <p><span class="versionmodified added">New in version 3.11.</span></p>

  936. </div>

  937. <dl class="py class">

  938. <dt class="sig sig-object py" id="wsgiref.types.StartResponse">

  939. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">StartResponse</span></span><a class="headerlink" href="#wsgiref.types.StartResponse" title="Link to this definition">¶</a></dt>

  940. <dd><p>A <a class="reference internal" href="typing.html#typing.Protocol" title="typing.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Protocol</span></code></a> describing <a class="reference external" href="https://peps.python.org/pep-3333/#the-start-response-callable">start_response()</a>

  941. callables (<span class="target" id="index-18"></span><a class="pep reference external" href="https://peps.python.org/pep-3333/"><strong>PEP 3333</strong></a>).</p>

  942. </dd></dl>

  943. 

  944. <dl class="py data">

  945. <dt class="sig sig-object py" id="wsgiref.types.WSGIEnvironment">

  946. <span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">WSGIEnvironment</span></span><a class="headerlink" href="#wsgiref.types.WSGIEnvironment" title="Link to this definition">¶</a></dt>

  947. <dd><p>A type alias describing a WSGI environment dictionary.</p>

  948. </dd></dl>

  949. 

  950. <dl class="py data">

  951. <dt class="sig sig-object py" id="wsgiref.types.WSGIApplication">

  952. <span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">WSGIApplication</span></span><a class="headerlink" href="#wsgiref.types.WSGIApplication" title="Link to this definition">¶</a></dt>

  953. <dd><p>A type alias describing a WSGI application callable.</p>

  954. </dd></dl>

  955. 

  956. <dl class="py class">

  957. <dt class="sig sig-object py" id="wsgiref.types.InputStream">

  958. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">InputStream</span></span><a class="headerlink" href="#wsgiref.types.InputStream" title="Link to this definition">¶</a></dt>

  959. <dd><p>A <a class="reference internal" href="typing.html#typing.Protocol" title="typing.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Protocol</span></code></a> describing a <a class="reference external" href="https://peps.python.org/pep-3333/#input-and-error-streams">WSGI Input Stream</a>.</p>

  960. </dd></dl>

  961. 

  962. <dl class="py class">

  963. <dt class="sig sig-object py" id="wsgiref.types.ErrorStream">

  964. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">ErrorStream</span></span><a class="headerlink" href="#wsgiref.types.ErrorStream" title="Link to this definition">¶</a></dt>

  965. <dd><p>A <a class="reference internal" href="typing.html#typing.Protocol" title="typing.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Protocol</span></code></a> describing a <a class="reference external" href="https://peps.python.org/pep-3333/#input-and-error-streams">WSGI Error Stream</a>.</p>

  966. </dd></dl>

  967. 

  968. <dl class="py class">

  969. <dt class="sig sig-object py" id="wsgiref.types.FileWrapper">

  970. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">wsgiref.types.</span></span><span class="sig-name descname"><span class="pre">FileWrapper</span></span><a class="headerlink" href="#wsgiref.types.FileWrapper" title="Link to this definition">¶</a></dt>

  971. <dd><p>A <a class="reference internal" href="typing.html#typing.Protocol" title="typing.Protocol"><code class="xref py py-class docutils literal notranslate"><span class="pre">typing.Protocol</span></code></a> describing a <a class="reference external" href="https://peps.python.org/pep-3333/#optional-platform-specific-file-handling">file wrapper</a>.

  972. See <a class="reference internal" href="#wsgiref.util.FileWrapper" title="wsgiref.util.FileWrapper"><code class="xref py py-class docutils literal notranslate"><span class="pre">wsgiref.util.FileWrapper</span></code></a> for a concrete implementation of this

  973. protocol.</p>

  974. </dd></dl>

  975. 

  976. </section>

  977. <section id="examples">

  978. <h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>

  979. <p>This is a working “Hello World” WSGI application:</p>

  980. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="sd">&quot;&quot;&quot;</span>

  981. <span class="sd">Every WSGI application must have an application object - a callable</span>

  982. <span class="sd">object that accepts two arguments. For that purpose, we&#39;re going to</span>

  983. <span class="sd">use a function (note that you&#39;re not limited to a function, you can</span>

  984. <span class="sd">use a class for example). The first argument passed to the function</span>

  985. <span class="sd">is a dictionary containing CGI-style environment variables and the</span>

  986. <span class="sd">second variable is the callable object.</span>

  987. <span class="sd">&quot;&quot;&quot;</span>

  988. <span class="kn">from</span> <span class="nn">wsgiref.simple_server</span> <span class="kn">import</span> <span class="n">make_server</span>

  989. 

  990. 

  991. <span class="k">def</span> <span class="nf">hello_world_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>

  992.     <span class="n">status</span> <span class="o">=</span> <span class="s2">&quot;200 OK&quot;</span>  <span class="c1"># HTTP Status</span>

  993.     <span class="n">headers</span> <span class="o">=</span> <span class="p">[(</span><span class="s2">&quot;Content-type&quot;</span><span class="p">,</span> <span class="s2">&quot;text/plain; charset=utf-8&quot;</span><span class="p">)]</span>  <span class="c1"># HTTP Headers</span>

  994.     <span class="n">start_response</span><span class="p">(</span><span class="n">status</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span>

  995. 

  996.     <span class="c1"># The returned object is going to be printed</span>

  997.     <span class="k">return</span> <span class="p">[</span><span class="sa">b</span><span class="s2">&quot;Hello World&quot;</span><span class="p">]</span>

  998. 

  999. <span class="k">with</span> <span class="n">make_server</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">,</span> <span class="n">hello_world_app</span><span class="p">)</span> <span class="k">as</span> <span class="n">httpd</span><span class="p">:</span>

  1000.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Serving on port 8000...&quot;</span><span class="p">)</span>

  1001. 

  1002.     <span class="c1"># Serve until process is killed</span>

  1003.     <span class="n">httpd</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  1004. </pre></div>

  1005. </div>

  1006. <p>Example of a WSGI application serving the current directory, accept optional

  1007. directory and port number (default: 8000) on the command line:</p>

  1008. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="sd">&quot;&quot;&quot;</span>

  1009. <span class="sd">Small wsgiref based web server. Takes a path to serve from and an</span>

  1010. <span class="sd">optional port number (defaults to 8000), then tries to serve files.</span>

  1011. <span class="sd">MIME types are guessed from the file names, 404 errors are raised</span>

  1012. <span class="sd">if the file is not found.</span>

  1013. <span class="sd">&quot;&quot;&quot;</span>

  1014. <span class="kn">import</span> <span class="nn">mimetypes</span>

  1015. <span class="kn">import</span> <span class="nn">os</span>

  1016. <span class="kn">import</span> <span class="nn">sys</span>

  1017. <span class="kn">from</span> <span class="nn">wsgiref</span> <span class="kn">import</span> <span class="n">simple_server</span><span class="p">,</span> <span class="n">util</span>

  1018. 

  1019. 

  1020. <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">respond</span><span class="p">):</span>

  1021.     <span class="c1"># Get the file name and MIME type</span>

  1022.     <span class="n">fn</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">environ</span><span class="p">[</span><span class="s2">&quot;PATH_INFO&quot;</span><span class="p">][</span><span class="mi">1</span><span class="p">:])</span>

  1023.     <span class="k">if</span> <span class="s2">&quot;.&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">fn</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>

  1024.         <span class="n">fn</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="s2">&quot;index.html&quot;</span><span class="p">)</span>

  1025.     <span class="n">mime_type</span> <span class="o">=</span> <span class="n">mimetypes</span><span class="o">.</span><span class="n">guess_type</span><span class="p">(</span><span class="n">fn</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>

  1026. 

  1027.     <span class="c1"># Return 200 OK if file exists, otherwise 404 Not Found</span>

  1028.     <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>

  1029.         <span class="n">respond</span><span class="p">(</span><span class="s2">&quot;200 OK&quot;</span><span class="p">,</span> <span class="p">[(</span><span class="s2">&quot;Content-Type&quot;</span><span class="p">,</span> <span class="n">mime_type</span><span class="p">)])</span>

  1030.         <span class="k">return</span> <span class="n">util</span><span class="o">.</span><span class="n">FileWrapper</span><span class="p">(</span><span class="nb">open</span><span class="p">(</span><span class="n">fn</span><span class="p">,</span> <span class="s2">&quot;rb&quot;</span><span class="p">))</span>

  1031.     <span class="k">else</span><span class="p">:</span>

  1032.         <span class="n">respond</span><span class="p">(</span><span class="s2">&quot;404 Not Found&quot;</span><span class="p">,</span> <span class="p">[(</span><span class="s2">&quot;Content-Type&quot;</span><span class="p">,</span> <span class="s2">&quot;text/plain&quot;</span><span class="p">)])</span>

  1033.         <span class="k">return</span> <span class="p">[</span><span class="sa">b</span><span class="s2">&quot;not found&quot;</span><span class="p">]</span>

  1034. 

  1035. 

  1036. <span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>

  1037.     <span class="c1"># Get the path and port from command-line arguments</span>

  1038.     <span class="n">path</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span> <span class="k">else</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>

  1039.     <span class="n">port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">2</span> <span class="k">else</span> <span class="mi">8000</span>

  1040. 

  1041.     <span class="c1"># Make and start the server until control-c</span>

  1042.     <span class="n">httpd</span> <span class="o">=</span> <span class="n">simple_server</span><span class="o">.</span><span class="n">make_server</span><span class="p">(</span><span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">app</span><span class="p">)</span>

  1043.     <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Serving </span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s2"> on port </span><span class="si">{</span><span class="n">port</span><span class="si">}</span><span class="s2">, control-C to stop&quot;</span><span class="p">)</span>

  1044.     <span class="k">try</span><span class="p">:</span>

  1045.         <span class="n">httpd</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  1046.     <span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>

  1047.         <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Shutting down.&quot;</span><span class="p">)</span>

  1048.         <span class="n">httpd</span><span class="o">.</span><span class="n">server_close</span><span class="p">()</span>

  1049. </pre></div>

  1050. </div>

  1051. </section>

  1052. </section>

  1053. 

  1054. 

  1055.             <div class="clearer"></div>

  1056.           </div>

  1057.         </div>

  1058.       </div>

  1059.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  1060.         <div class="sphinxsidebarwrapper">

  1061.   <div>

  1062.     <h3><a href="../contents.html">Table of Contents</a></h3>

  1063.     <ul>

  1064. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code> — WSGI Utilities and Reference Implementation</a><ul>

  1065. <li><a class="reference internal" href="#module-wsgiref.util"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.util</span></code> – WSGI environment utilities</a></li>

  1066. <li><a class="reference internal" href="#module-wsgiref.headers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.headers</span></code> – WSGI response header tools</a></li>

  1067. <li><a class="reference internal" href="#module-wsgiref.simple_server"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.simple_server</span></code> – a simple WSGI HTTP server</a></li>

  1068. <li><a class="reference internal" href="#module-wsgiref.validate"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.validate</span></code> — WSGI conformance checker</a></li>

  1069. <li><a class="reference internal" href="#module-wsgiref.handlers"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.handlers</span></code> – server/gateway base classes</a></li>

  1070. <li><a class="reference internal" href="#module-wsgiref.types"><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref.types</span></code> – WSGI types for static type checking</a></li>

  1071. <li><a class="reference internal" href="#examples">Examples</a></li>

  1072. </ul>

  1073. </li>

  1074. </ul>

  1075. 

  1076.   </div>

  1077.   <div>

  1078.     <h4>Previous topic</h4>

  1079.     <p class="topless"><a href="webbrowser.html"

  1080.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">webbrowser</span></code> — Convenient web-browser controller</a></p>

  1081.   </div>

  1082.   <div>

  1083.     <h4>Next topic</h4>

  1084.     <p class="topless"><a href="urllib.html"

  1085.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib</span></code> — URL handling modules</a></p>

  1086.   </div>

  1087.   <div role="note" aria-label="source link">

  1088.     <h3>This Page</h3>

  1089.     <ul class="this-page-menu">

  1090.       <li><a href="../bugs.html">Report a Bug</a></li>

  1091.       <li>

  1092.         <a href="https://github.com/python/cpython/blob/main/Doc/library/wsgiref.rst"

  1093.             rel="nofollow">Show Source

  1094.         </a>

  1095.       </li>

  1096.     </ul>

  1097.   </div>

  1098.         </div>

  1099. <div id="sidebarbutton" title="Collapse sidebar">

  1100. <span>«</span>

  1101. </div>

  1102. 

  1103.       </div>

  1104.       <div class="clearer"></div>

  1105.     </div>  

  1106.     <div class="related" role="navigation" aria-label="related navigation">

  1107.       <h3>Navigation</h3>

  1108.       <ul>

  1109.         <li class="right" style="margin-right: 10px">

  1110.           <a href="../genindex.html" title="General Index"

  1111.              >index</a></li>

  1112.         <li class="right" >

  1113.           <a href="../py-modindex.html" title="Python Module Index"

  1114.              >modules</a> |</li>

  1115.         <li class="right" >

  1116.           <a href="urllib.html" title="urllib — URL handling modules"

  1117.              >next</a> |</li>

  1118.         <li class="right" >

  1119.           <a href="webbrowser.html" title="webbrowser — Convenient web-browser controller"

  1120.              >previous</a> |</li>

  1121. 

  1122.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  1123.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  1124.           <li class="switchers">

  1125.             <div class="language_switcher_placeholder"></div>

  1126.             <div class="version_switcher_placeholder"></div>

  1127.           </li>

  1128.           <li>

  1129.               

  1130.           </li>

  1131.     <li id="cpython-language-and-version">

  1132.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  1133.     </li>

  1134. 

  1135.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  1136.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  1137.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">wsgiref</span></code> — WSGI Utilities and Reference Implementation</a></li>

  1138.                 <li class="right">

  1139.                     

  1140. 

  1141.     <div class="inline-search" role="search">

  1142.         <form class="inline-search" action="../search.html" method="get">

  1143.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  1144.           <input type="submit" value="Go" />

  1145.         </form>

  1146.     </div>

  1147.                      |

  1148.                 </li>

  1149.             <li class="right">

  1150. <label class="theme-selector-label">

  1151.     Theme

  1152.     <select class="theme-selector" oninput="activateTheme(this.value)">

  1153.         <option value="auto" selected>Auto</option>

  1154.         <option value="light">Light</option>

  1155.         <option value="dark">Dark</option>

  1156.     </select>

  1157. </label> |</li>

  1158.             

  1159.       </ul>

  1160.     </div>  

  1161.     <div class="footer">

  1162.     &copy; 

  1163.       <a href="../copyright.html">

  1164.     

  1165.     Copyright

  1166.     

  1167.       </a>

  1168.      2001-2024, Python Software Foundation.

  1169.     <br />

  1170.     This page is licensed under the Python Software Foundation License Version 2.

  1171.     <br />

  1172.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  1173.     <br />

  1174.     

  1175.       See <a href="/license.html">History and License</a> for more information.<br />

  1176.     

  1177.     

  1178.     <br />

  1179. 

  1180.     The Python Software Foundation is a non-profit corporation.

  1181. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  1182. <br />

  1183.     <br />

  1184.       Last updated on Apr 09, 2024 (13:47 UTC).

  1185.     

  1186.       <a href="/bugs.html">Found a bug</a>?

  1187.     

  1188.     <br />

  1189. 

  1190.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  1191.     </div>

  1192. 

  1193.   </body>

  1194. </html>
上海开阖软件有限公司 沪ICP备12045867号-1