Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
ウォッチ 1
スター 0
Wiki 捐赠
gooderp18绿色标准版
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
ツリー: 0f75e31513
ブランチ タグ
${ item.name }
ブランチ ${ searchTerm } を作成
'0f75e31513' から
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/http.server.html

912 行
78KB
Raw Blame 履歴 

  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="http.server — HTTP servers" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/http/server.py This module defines classes for implementing HTTP servers. Availability: not Emscripten, not WASI. This module does not work or is not available on WebAssembly platf..." />

  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/http/server.py This module defines classes for implementing HTTP servers. Availability: not Emscripten, not WASI. This module does not work or is not available on WebAssembly platf..." />

  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>http.server — HTTP servers &#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="http.cookies — HTTP state management" href="http.cookies.html" />

  39.     <link rel="prev" title="socketserver — A framework for network servers" href="socketserver.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/http.server.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">http.server</span></code> — HTTP servers</a><ul>

  99. <li><a class="reference internal" href="#security-considerations">Security Considerations</a></li>

  100. </ul>

  101. </li>

  102. </ul>

  103. 

  104.   </div>

  105.   <div>

  106.     <h4>Previous topic</h4>

  107.     <p class="topless"><a href="socketserver.html"

  108.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socketserver</span></code> — A framework for network servers</a></p>

  109.   </div>

  110.   <div>

  111.     <h4>Next topic</h4>

  112.     <p class="topless"><a href="http.cookies.html"

  113.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.cookies</span></code> — HTTP state management</a></p>

  114.   </div>

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

  116.     <h3>This Page</h3>

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

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

  119.       <li>

  120.         <a href="https://github.com/python/cpython/blob/main/Doc/library/http.server.rst"

  121.             rel="nofollow">Show Source

  122.         </a>

  123.       </li>

  124.     </ul>

  125.   </div>

  126.         </nav>

  127.     </div>

  128. </div>

  129. 

  130.   

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

  132.       <h3>Navigation</h3>

  133.       <ul>

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

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

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

  137.         <li class="right" >

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

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

  140.         <li class="right" >

  141.           <a href="http.cookies.html" title="http.cookies — HTTP state management"

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

  143.         <li class="right" >

  144.           <a href="socketserver.html" title="socketserver — A framework for network servers"

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

  146. 

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

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

  149.           <li class="switchers">

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

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

  152.           </li>

  153.           <li>

  154.               

  155.           </li>

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

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

  158.     </li>

  159. 

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

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

  162.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.server</span></code> — HTTP servers</a></li>

  163.                 <li class="right">

  164.                     

  165. 

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

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

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

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

  170.         </form>

  171.     </div>

  172.                      |

  173.                 </li>

  174.             <li class="right">

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

  176.     Theme

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

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

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

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

  181.     </select>

  182. </label> |</li>

  183.             

  184.       </ul>

  185.     </div>    

  186. 

  187.     <div class="document">

  188.       <div class="documentwrapper">

  189.         <div class="bodywrapper">

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

  191.             

  192.   <section id="module-http.server">

  193. <span id="http-server-http-servers"></span><h1><a class="reference internal" href="#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> — HTTP servers<a class="headerlink" href="#module-http.server" title="Link to this heading">¶</a></h1>

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

  195. <hr class="docutils" id="index-0" />

  196. <p>This module defines classes for implementing HTTP servers.</p>

  197. <div class="admonition warning">

  198. <p class="admonition-title">Warning</p>

  199. <p><a class="reference internal" href="#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> is not recommended for production. It only implements

  200. <a class="reference internal" href="#http-server-security"><span class="std std-ref">basic security checks</span></a>.</p>

  201. </div>

  202. <div class="availability docutils container">

  203. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: not Emscripten, not WASI.</p>

  204. <p>This module does not work or is not available on WebAssembly platforms

  205. <code class="docutils literal notranslate"><span class="pre">wasm32-emscripten</span></code> and <code class="docutils literal notranslate"><span class="pre">wasm32-wasi</span></code>. See

  206. <a class="reference internal" href="intro.html#wasm-availability"><span class="std std-ref">WebAssembly platforms</span></a> for more information.</p>

  207. </div>

  208. <p>One class, <a class="reference internal" href="#http.server.HTTPServer" title="http.server.HTTPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPServer</span></code></a>, is a <a class="reference internal" href="socketserver.html#socketserver.TCPServer" title="socketserver.TCPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">socketserver.TCPServer</span></code></a> subclass.

  209. It creates and listens at the HTTP socket, dispatching the requests to a

  210. handler.  Code to create and run the server looks like this:</p>

  211. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">run</span><span class="p">(</span><span class="n">server_class</span><span class="o">=</span><span class="n">HTTPServer</span><span class="p">,</span> <span class="n">handler_class</span><span class="o">=</span><span class="n">BaseHTTPRequestHandler</span><span class="p">):</span>

  212.     <span class="n">server_address</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">)</span>

  213.     <span class="n">httpd</span> <span class="o">=</span> <span class="n">server_class</span><span class="p">(</span><span class="n">server_address</span><span class="p">,</span> <span class="n">handler_class</span><span class="p">)</span>

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

  215. </pre></div>

  216. </div>

  217. <dl class="py class">

  218. <dt class="sig sig-object py" id="http.server.HTTPServer">

  219. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.server.</span></span><span class="sig-name descname"><span class="pre">HTTPServer</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="#http.server.HTTPServer" title="Link to this definition">¶</a></dt>

  220. <dd><p>This class builds on the <a class="reference internal" href="socketserver.html#socketserver.TCPServer" title="socketserver.TCPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">TCPServer</span></code></a> class by storing

  221. the server address as instance variables named <code class="xref py py-attr docutils literal notranslate"><span class="pre">server_name</span></code> and

  222. <code class="xref py py-attr docutils literal notranslate"><span class="pre">server_port</span></code>. The server is accessible by the handler, typically

  223. through the handler’s <code class="xref py py-attr docutils literal notranslate"><span class="pre">server</span></code> instance variable.</p>

  224. </dd></dl>

  225. 

  226. <dl class="py class">

  227. <dt class="sig sig-object py" id="http.server.ThreadingHTTPServer">

  228. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.server.</span></span><span class="sig-name descname"><span class="pre">ThreadingHTTPServer</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="#http.server.ThreadingHTTPServer" title="Link to this definition">¶</a></dt>

  229. <dd><p>This class is identical to HTTPServer but uses threads to handle

  230. requests by using the <a class="reference internal" href="socketserver.html#socketserver.ThreadingMixIn" title="socketserver.ThreadingMixIn"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadingMixIn</span></code></a>. This

  231. is useful to handle web browsers pre-opening sockets, on which

  232. <a class="reference internal" href="#http.server.HTTPServer" title="http.server.HTTPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPServer</span></code></a> would wait indefinitely.</p>

  233. <div class="versionadded">

  234. <p><span class="versionmodified added">New in version 3.7.</span></p>

  235. </div>

  236. </dd></dl>

  237. 

  238. <p>The <a class="reference internal" href="#http.server.HTTPServer" title="http.server.HTTPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPServer</span></code></a> and <a class="reference internal" href="#http.server.ThreadingHTTPServer" title="http.server.ThreadingHTTPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">ThreadingHTTPServer</span></code></a> must be given

  239. a <em>RequestHandlerClass</em> on instantiation, of which this module

  240. provides three different variants:</p>

  241. <dl class="py class">

  242. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler">

  243. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.server.</span></span><span class="sig-name descname"><span class="pre">BaseHTTPRequestHandler</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="#http.server.BaseHTTPRequestHandler" title="Link to this definition">¶</a></dt>

  244. <dd><p>This class is used to handle the HTTP requests that arrive at the server.  By

  245. itself, it cannot respond to any actual HTTP requests; it must be subclassed

  246. to handle each request method (e.g. GET or POST).

  247. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a> provides a number of class and instance

  248. variables, and methods for use by subclasses.</p>

  249. <p>The handler will parse the request and the headers, then call a method

  250. specific to the request type. The method name is constructed from the

  251. request. For example, for the request method <code class="docutils literal notranslate"><span class="pre">SPAM</span></code>, the <code class="xref py py-meth docutils literal notranslate"><span class="pre">do_SPAM()</span></code>

  252. method will be called with no arguments. All of the relevant information is

  253. stored in instance variables of the handler.  Subclasses should not need to

  254. override or extend the <code class="xref py py-meth docutils literal notranslate"><span class="pre">__init__()</span></code> method.</p>

  255. <p><a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a> has the following instance variables:</p>

  256. <dl class="py attribute">

  257. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.client_address">

  258. <span class="sig-name descname"><span class="pre">client_address</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.client_address" title="Link to this definition">¶</a></dt>

  259. <dd><p>Contains a tuple of the form <code class="docutils literal notranslate"><span class="pre">(host,</span> <span class="pre">port)</span></code> referring to the client’s

  260. address.</p>

  261. </dd></dl>

  262. 

  263. <dl class="py attribute">

  264. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.server">

  265. <span class="sig-name descname"><span class="pre">server</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.server" title="Link to this definition">¶</a></dt>

  266. <dd><p>Contains the server instance.</p>

  267. </dd></dl>

  268. 

  269. <dl class="py attribute">

  270. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.close_connection">

  271. <span class="sig-name descname"><span class="pre">close_connection</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.close_connection" title="Link to this definition">¶</a></dt>

  272. <dd><p>Boolean that should be set before <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.handle_one_request" title="http.server.BaseHTTPRequestHandler.handle_one_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">handle_one_request()</span></code></a> returns,

  273. indicating if another request may be expected, or if the connection should

  274. be shut down.</p>

  275. </dd></dl>

  276. 

  277. <dl class="py attribute">

  278. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.requestline">

  279. <span class="sig-name descname"><span class="pre">requestline</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.requestline" title="Link to this definition">¶</a></dt>

  280. <dd><p>Contains the string representation of the HTTP request line. The

  281. terminating CRLF is stripped. This attribute should be set by

  282. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.handle_one_request" title="http.server.BaseHTTPRequestHandler.handle_one_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">handle_one_request()</span></code></a>. If no valid request line was processed, it

  283. should be set to the empty string.</p>

  284. </dd></dl>

  285. 

  286. <dl class="py attribute">

  287. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.command">

  288. <span class="sig-name descname"><span class="pre">command</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.command" title="Link to this definition">¶</a></dt>

  289. <dd><p>Contains the command (request type). For example, <code class="docutils literal notranslate"><span class="pre">'GET'</span></code>.</p>

  290. </dd></dl>

  291. 

  292. <dl class="py attribute">

  293. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.path">

  294. <span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.path" title="Link to this definition">¶</a></dt>

  295. <dd><p>Contains the request path. If query component of the URL is present,

  296. then <code class="docutils literal notranslate"><span class="pre">path</span></code> includes the query. Using the terminology of <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3986.html"><strong>RFC 3986</strong></a>,

  297. <code class="docutils literal notranslate"><span class="pre">path</span></code> here includes <code class="docutils literal notranslate"><span class="pre">hier-part</span></code> and the <code class="docutils literal notranslate"><span class="pre">query</span></code>.</p>

  298. </dd></dl>

  299. 

  300. <dl class="py attribute">

  301. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.request_version">

  302. <span class="sig-name descname"><span class="pre">request_version</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.request_version" title="Link to this definition">¶</a></dt>

  303. <dd><p>Contains the version string from the request. For example, <code class="docutils literal notranslate"><span class="pre">'HTTP/1.0'</span></code>.</p>

  304. </dd></dl>

  305. 

  306. <dl class="py attribute">

  307. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.headers">

  308. <span class="sig-name descname"><span class="pre">headers</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.headers" title="Link to this definition">¶</a></dt>

  309. <dd><p>Holds an instance of the class specified by the <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.MessageClass" title="http.server.BaseHTTPRequestHandler.MessageClass"><code class="xref py py-attr docutils literal notranslate"><span class="pre">MessageClass</span></code></a> class

  310. variable. This instance parses and manages the headers in the HTTP

  311. request. The <a class="reference internal" href="http.client.html#http.client.parse_headers" title="http.client.parse_headers"><code class="xref py py-func docutils literal notranslate"><span class="pre">parse_headers()</span></code></a> function from

  312. <a class="reference internal" href="http.client.html#module-http.client" title="http.client: HTTP and HTTPS protocol client (requires sockets)."><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.client</span></code></a> is used to parse the headers and it requires that the

  313. HTTP request provide a valid <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2822.html"><strong>RFC 2822</strong></a> style header.</p>

  314. </dd></dl>

  315. 

  316. <dl class="py attribute">

  317. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.rfile">

  318. <span class="sig-name descname"><span class="pre">rfile</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.rfile" title="Link to this definition">¶</a></dt>

  319. <dd><p>An <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> input stream, ready to read from

  320. the start of the optional input data.</p>

  321. </dd></dl>

  322. 

  323. <dl class="py attribute">

  324. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.wfile">

  325. <span class="sig-name descname"><span class="pre">wfile</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.wfile" title="Link to this definition">¶</a></dt>

  326. <dd><p>Contains the output stream for writing a response back to the

  327. client. Proper adherence to the HTTP protocol must be used when writing to

  328. this stream in order to achieve successful interoperation with HTTP

  329. clients.</p>

  330. <div class="versionchanged">

  331. <p><span class="versionmodified changed">Changed in version 3.6: </span>This is an <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> stream.</p>

  332. </div>

  333. </dd></dl>

  334. 

  335. <p><a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a> has the following attributes:</p>

  336. <dl class="py attribute">

  337. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.server_version">

  338. <span class="sig-name descname"><span class="pre">server_version</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.server_version" title="Link to this definition">¶</a></dt>

  339. <dd><p>Specifies the server software version.  You may want to override this. The

  340. format is multiple whitespace-separated strings, where each string is of

  341. the form name[/version]. For example, <code class="docutils literal notranslate"><span class="pre">'BaseHTTP/0.2'</span></code>.</p>

  342. </dd></dl>

  343. 

  344. <dl class="py attribute">

  345. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.sys_version">

  346. <span class="sig-name descname"><span class="pre">sys_version</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.sys_version" title="Link to this definition">¶</a></dt>

  347. <dd><p>Contains the Python system version, in a form usable by the

  348. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.version_string" title="http.server.BaseHTTPRequestHandler.version_string"><code class="xref py py-attr docutils literal notranslate"><span class="pre">version_string</span></code></a> method and the <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.server_version" title="http.server.BaseHTTPRequestHandler.server_version"><code class="xref py py-attr docutils literal notranslate"><span class="pre">server_version</span></code></a> class

  349. variable. For example, <code class="docutils literal notranslate"><span class="pre">'Python/1.4'</span></code>.</p>

  350. </dd></dl>

  351. 

  352. <dl class="py attribute">

  353. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.error_message_format">

  354. <span class="sig-name descname"><span class="pre">error_message_format</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.error_message_format" title="Link to this definition">¶</a></dt>

  355. <dd><p>Specifies a format string that should be used by <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_error" title="http.server.BaseHTTPRequestHandler.send_error"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_error()</span></code></a> method

  356. for building an error response to the client. The string is filled by

  357. default with variables from <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.responses" title="http.server.BaseHTTPRequestHandler.responses"><code class="xref py py-attr docutils literal notranslate"><span class="pre">responses</span></code></a> based on the status code

  358. that passed to <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_error" title="http.server.BaseHTTPRequestHandler.send_error"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_error()</span></code></a>.</p>

  359. </dd></dl>

  360. 

  361. <dl class="py attribute">

  362. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.error_content_type">

  363. <span class="sig-name descname"><span class="pre">error_content_type</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.error_content_type" title="Link to this definition">¶</a></dt>

  364. <dd><p>Specifies the Content-Type HTTP header of error responses sent to the

  365. client.  The default value is <code class="docutils literal notranslate"><span class="pre">'text/html'</span></code>.</p>

  366. </dd></dl>

  367. 

  368. <dl class="py attribute">

  369. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.protocol_version">

  370. <span class="sig-name descname"><span class="pre">protocol_version</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.protocol_version" title="Link to this definition">¶</a></dt>

  371. <dd><p>Specifies the HTTP version to which the server is conformant. It is sent

  372. in responses to let the client know the server’s communication

  373. capabilities for future requests. If set to

  374. <code class="docutils literal notranslate"><span class="pre">'HTTP/1.1'</span></code>, the server will permit HTTP persistent connections;

  375. however, your server <em>must</em> then include an accurate <code class="docutils literal notranslate"><span class="pre">Content-Length</span></code>

  376. header (using <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_header" title="http.server.BaseHTTPRequestHandler.send_header"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_header()</span></code></a>) in all of its responses to clients.

  377. For backwards compatibility, the setting defaults to <code class="docutils literal notranslate"><span class="pre">'HTTP/1.0'</span></code>.</p>

  378. </dd></dl>

  379. 

  380. <dl class="py attribute">

  381. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.MessageClass">

  382. <span class="sig-name descname"><span class="pre">MessageClass</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.MessageClass" title="Link to this definition">¶</a></dt>

  383. <dd><p>Specifies an <a class="reference internal" href="email.compat32-message.html#email.message.Message" title="email.message.Message"><code class="xref py py-class docutils literal notranslate"><span class="pre">email.message.Message</span></code></a>-like class to parse HTTP

  384. headers.  Typically, this is not overridden, and it defaults to

  385. <a class="reference internal" href="http.client.html#http.client.HTTPMessage" title="http.client.HTTPMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">http.client.HTTPMessage</span></code></a>.</p>

  386. </dd></dl>

  387. 

  388. <dl class="py attribute">

  389. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.responses">

  390. <span class="sig-name descname"><span class="pre">responses</span></span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.responses" title="Link to this definition">¶</a></dt>

  391. <dd><p>This attribute contains a mapping of error code integers to two-element tuples

  392. containing a short and long message. For example, <code class="docutils literal notranslate"><span class="pre">{code:</span> <span class="pre">(shortmessage,</span>

  393. <span class="pre">longmessage)}</span></code>. The <em>shortmessage</em> is usually used as the <em>message</em> key in an

  394. error response, and <em>longmessage</em> as the <em>explain</em> key.  It is used by

  395. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_response_only" title="http.server.BaseHTTPRequestHandler.send_response_only"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_response_only()</span></code></a> and <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_error" title="http.server.BaseHTTPRequestHandler.send_error"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_error()</span></code></a> methods.</p>

  396. </dd></dl>

  397. 

  398. <p>A <a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a> instance has the following methods:</p>

  399. <dl class="py method">

  400. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.handle">

  401. <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="#http.server.BaseHTTPRequestHandler.handle" title="Link to this definition">¶</a></dt>

  402. <dd><p>Calls <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.handle_one_request" title="http.server.BaseHTTPRequestHandler.handle_one_request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">handle_one_request()</span></code></a> once (or, if persistent connections are

  403. enabled, multiple times) to handle incoming HTTP requests. You should

  404. never need to override it; instead, implement appropriate <code class="xref py py-meth docutils literal notranslate"><span class="pre">do_*()</span></code>

  405. methods.</p>

  406. </dd></dl>

  407. 

  408. <dl class="py method">

  409. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.handle_one_request">

  410. <span class="sig-name descname"><span class="pre">handle_one_request</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.handle_one_request" title="Link to this definition">¶</a></dt>

  411. <dd><p>This method will parse and dispatch the request to the appropriate

  412. <code class="xref py py-meth docutils literal notranslate"><span class="pre">do_*()</span></code> method.  You should never need to override it.</p>

  413. </dd></dl>

  414. 

  415. <dl class="py method">

  416. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.handle_expect_100">

  417. <span class="sig-name descname"><span class="pre">handle_expect_100</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.handle_expect_100" title="Link to this definition">¶</a></dt>

  418. <dd><p>When an HTTP/1.1 conformant server receives an <code class="docutils literal notranslate"><span class="pre">Expect:</span> <span class="pre">100-continue</span></code>

  419. request header it responds back with a <code class="docutils literal notranslate"><span class="pre">100</span> <span class="pre">Continue</span></code> followed by <code class="docutils literal notranslate"><span class="pre">200</span>

  420. <span class="pre">OK</span></code> headers.

  421. This method can be overridden to raise an error if the server does not

  422. want the client to continue.  For e.g. server can choose to send <code class="docutils literal notranslate"><span class="pre">417</span>

  423. <span class="pre">Expectation</span> <span class="pre">Failed</span></code> as a response header and <code class="docutils literal notranslate"><span class="pre">return</span> <span class="pre">False</span></code>.</p>

  424. <div class="versionadded">

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

  426. </div>

  427. </dd></dl>

  428. 

  429. <dl class="py method">

  430. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.send_error">

  431. <span class="sig-name descname"><span class="pre">send_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">explain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.send_error" title="Link to this definition">¶</a></dt>

  432. <dd><p>Sends and logs a complete error reply to the client. The numeric <em>code</em>

  433. specifies the HTTP error code, with <em>message</em> as an optional, short, human

  434. readable description of the error.  The <em>explain</em> argument can be used to

  435. provide more detailed information about the error; it will be formatted

  436. using the <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.error_message_format" title="http.server.BaseHTTPRequestHandler.error_message_format"><code class="xref py py-attr docutils literal notranslate"><span class="pre">error_message_format</span></code></a> attribute and emitted, after

  437. a complete set of headers, as the response body.  The <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.responses" title="http.server.BaseHTTPRequestHandler.responses"><code class="xref py py-attr docutils literal notranslate"><span class="pre">responses</span></code></a>

  438. attribute holds the default values for <em>message</em> and <em>explain</em> that

  439. will be used if no value is provided; for unknown codes the default value

  440. for both is the string <code class="docutils literal notranslate"><span class="pre">???</span></code>. The body will be empty if the method is

  441. HEAD or the response code is one of the following: <code class="samp docutils literal notranslate"><span class="pre">1</span><em><span class="pre">xx</span></em></code>,

  442. <code class="docutils literal notranslate"><span class="pre">204</span> <span class="pre">No</span> <span class="pre">Content</span></code>, <code class="docutils literal notranslate"><span class="pre">205</span> <span class="pre">Reset</span> <span class="pre">Content</span></code>, <code class="docutils literal notranslate"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>.</p>

  443. <div class="versionchanged">

  444. <p><span class="versionmodified changed">Changed in version 3.4: </span>The error response includes a Content-Length header.

  445. Added the <em>explain</em> argument.</p>

  446. </div>

  447. </dd></dl>

  448. 

  449. <dl class="py method">

  450. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.send_response">

  451. <span class="sig-name descname"><span class="pre">send_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.send_response" title="Link to this definition">¶</a></dt>

  452. <dd><p>Adds a response header to the headers buffer and logs the accepted

  453. request. The HTTP response line is written to the internal buffer,

  454. followed by <em>Server</em> and <em>Date</em> headers. The values for these two headers

  455. are picked up from the <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.version_string" title="http.server.BaseHTTPRequestHandler.version_string"><code class="xref py py-meth docutils literal notranslate"><span class="pre">version_string()</span></code></a> and

  456. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.date_time_string" title="http.server.BaseHTTPRequestHandler.date_time_string"><code class="xref py py-meth docutils literal notranslate"><span class="pre">date_time_string()</span></code></a> methods, respectively. If the server does not

  457. intend to send any other headers using the <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_header" title="http.server.BaseHTTPRequestHandler.send_header"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_header()</span></code></a> method,

  458. then <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.send_response" title="http.server.BaseHTTPRequestHandler.send_response"><code class="xref py py-meth docutils literal notranslate"><span class="pre">send_response()</span></code></a> should be followed by an <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.end_headers" title="http.server.BaseHTTPRequestHandler.end_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">end_headers()</span></code></a>

  459. call.</p>

  460. <div class="versionchanged">

  461. <p><span class="versionmodified changed">Changed in version 3.3: </span>Headers are stored to an internal buffer and <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.end_headers" title="http.server.BaseHTTPRequestHandler.end_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">end_headers()</span></code></a>

  462. needs to be called explicitly.</p>

  463. </div>

  464. </dd></dl>

  465. 

  466. <dl class="py method">

  467. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.send_header">

  468. <span class="sig-name descname"><span class="pre">send_header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keyword</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.send_header" title="Link to this definition">¶</a></dt>

  469. <dd><p>Adds the HTTP header to an internal buffer which will be written to the

  470. output stream when either <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.end_headers" title="http.server.BaseHTTPRequestHandler.end_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">end_headers()</span></code></a> or <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.flush_headers" title="http.server.BaseHTTPRequestHandler.flush_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">flush_headers()</span></code></a> is

  471. invoked. <em>keyword</em> should specify the header keyword, with <em>value</em>

  472. specifying its value. Note that, after the send_header calls are done,

  473. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.end_headers" title="http.server.BaseHTTPRequestHandler.end_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">end_headers()</span></code></a> MUST BE called in order to complete the operation.</p>

  474. <div class="versionchanged">

  475. <p><span class="versionmodified changed">Changed in version 3.2: </span>Headers are stored in an internal buffer.</p>

  476. </div>

  477. </dd></dl>

  478. 

  479. <dl class="py method">

  480. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.send_response_only">

  481. <span class="sig-name descname"><span class="pre">send_response_only</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.send_response_only" title="Link to this definition">¶</a></dt>

  482. <dd><p>Sends the response header only, used for the purposes when <code class="docutils literal notranslate"><span class="pre">100</span>

  483. <span class="pre">Continue</span></code> response is sent by the server to the client. The headers not

  484. buffered and sent directly the output stream.If the <em>message</em> is not

  485. specified, the HTTP message corresponding the response <em>code</em>  is sent.</p>

  486. <div class="versionadded">

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

  488. </div>

  489. </dd></dl>

  490. 

  491. <dl class="py method">

  492. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.end_headers">

  493. <span class="sig-name descname"><span class="pre">end_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.end_headers" title="Link to this definition">¶</a></dt>

  494. <dd><p>Adds a blank line

  495. (indicating the end of the HTTP headers in the response)

  496. to the headers buffer and calls <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.flush_headers" title="http.server.BaseHTTPRequestHandler.flush_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">flush_headers()</span></code></a>.</p>

  497. <div class="versionchanged">

  498. <p><span class="versionmodified changed">Changed in version 3.2: </span>The buffered headers are written to the output stream.</p>

  499. </div>

  500. </dd></dl>

  501. 

  502. <dl class="py method">

  503. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.flush_headers">

  504. <span class="sig-name descname"><span class="pre">flush_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.flush_headers" title="Link to this definition">¶</a></dt>

  505. <dd><p>Finally send the headers to the output stream and flush the internal

  506. headers buffer.</p>

  507. <div class="versionadded">

  508. <p><span class="versionmodified added">New in version 3.3.</span></p>

  509. </div>

  510. </dd></dl>

  511. 

  512. <dl class="py method">

  513. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.log_request">

  514. <span class="sig-name descname"><span class="pre">log_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'-'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'-'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.log_request" title="Link to this definition">¶</a></dt>

  515. <dd><p>Logs an accepted (successful) request. <em>code</em> should specify the numeric

  516. HTTP code associated with the response. If a size of the response is

  517. available, then it should be passed as the <em>size</em> parameter.</p>

  518. </dd></dl>

  519. 

  520. <dl class="py method">

  521. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.log_error">

  522. <span class="sig-name descname"><span class="pre">log_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.log_error" title="Link to this definition">¶</a></dt>

  523. <dd><p>Logs an error when a request cannot be fulfilled. By default, it passes

  524. the message to <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.log_message" title="http.server.BaseHTTPRequestHandler.log_message"><code class="xref py py-meth docutils literal notranslate"><span class="pre">log_message()</span></code></a>, so it takes the same arguments

  525. (<em>format</em> and additional values).</p>

  526. </dd></dl>

  527. 

  528. <dl class="py method">

  529. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.log_message">

  530. <span class="sig-name descname"><span class="pre">log_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.log_message" title="Link to this definition">¶</a></dt>

  531. <dd><p>Logs an arbitrary message to <code class="docutils literal notranslate"><span class="pre">sys.stderr</span></code>. This is typically overridden

  532. to create custom error logging mechanisms. The <em>format</em> argument is a

  533. standard printf-style format string, where the additional arguments to

  534. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.log_message" title="http.server.BaseHTTPRequestHandler.log_message"><code class="xref py py-meth docutils literal notranslate"><span class="pre">log_message()</span></code></a> are applied as inputs to the formatting. The client

  535. ip address and current date and time are prefixed to every message logged.</p>

  536. </dd></dl>

  537. 

  538. <dl class="py method">

  539. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.version_string">

  540. <span class="sig-name descname"><span class="pre">version_string</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.version_string" title="Link to this definition">¶</a></dt>

  541. <dd><p>Returns the server software’s version string. This is a combination of the

  542. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.server_version" title="http.server.BaseHTTPRequestHandler.server_version"><code class="xref py py-attr docutils literal notranslate"><span class="pre">server_version</span></code></a> and <a class="reference internal" href="#http.server.BaseHTTPRequestHandler.sys_version" title="http.server.BaseHTTPRequestHandler.sys_version"><code class="xref py py-attr docutils literal notranslate"><span class="pre">sys_version</span></code></a> attributes.</p>

  543. </dd></dl>

  544. 

  545. <dl class="py method">

  546. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.date_time_string">

  547. <span class="sig-name descname"><span class="pre">date_time_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.date_time_string" title="Link to this definition">¶</a></dt>

  548. <dd><p>Returns the date and time given by <em>timestamp</em> (which must be <code class="docutils literal notranslate"><span class="pre">None</span></code> or in

  549. the format returned by <a class="reference internal" href="time.html#time.time" title="time.time"><code class="xref py py-func docutils literal notranslate"><span class="pre">time.time()</span></code></a>), formatted for a message

  550. header. If <em>timestamp</em> is omitted, it uses the current date and time.</p>

  551. <p>The result looks like <code class="docutils literal notranslate"><span class="pre">'Sun,</span> <span class="pre">06</span> <span class="pre">Nov</span> <span class="pre">1994</span> <span class="pre">08:49:37</span> <span class="pre">GMT'</span></code>.</p>

  552. </dd></dl>

  553. 

  554. <dl class="py method">

  555. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.log_date_time_string">

  556. <span class="sig-name descname"><span class="pre">log_date_time_string</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.log_date_time_string" title="Link to this definition">¶</a></dt>

  557. <dd><p>Returns the current date and time, formatted for logging.</p>

  558. </dd></dl>

  559. 

  560. <dl class="py method">

  561. <dt class="sig sig-object py" id="http.server.BaseHTTPRequestHandler.address_string">

  562. <span class="sig-name descname"><span class="pre">address_string</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.BaseHTTPRequestHandler.address_string" title="Link to this definition">¶</a></dt>

  563. <dd><p>Returns the client address.</p>

  564. <div class="versionchanged">

  565. <p><span class="versionmodified changed">Changed in version 3.3: </span>Previously, a name lookup was performed. To avoid name resolution

  566. delays, it now always returns the IP address.</p>

  567. </div>

  568. </dd></dl>

  569. 

  570. </dd></dl>

  571. 

  572. <dl class="py class">

  573. <dt class="sig sig-object py" id="http.server.SimpleHTTPRequestHandler">

  574. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.server.</span></span><span class="sig-name descname"><span class="pre">SimpleHTTPRequestHandler</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>, <em class="sig-param"><span class="n"><span class="pre">directory</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.server.SimpleHTTPRequestHandler" title="Link to this definition">¶</a></dt>

  575. <dd><p>This class serves files from the directory <em>directory</em> and below,

  576. or the current directory if <em>directory</em> is not provided, directly

  577. mapping the directory structure to HTTP requests.</p>

  578. <div class="versionchanged">

  579. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <em>directory</em> parameter.</p>

  580. </div>

  581. <div class="versionchanged">

  582. <p><span class="versionmodified changed">Changed in version 3.9: </span>The <em>directory</em> parameter accepts a <a class="reference internal" href="../glossary.html#term-path-like-object"><span class="xref std std-term">path-like object</span></a>.</p>

  583. </div>

  584. <p>A lot of the work, such as parsing the request, is done by the base class

  585. <a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a>.  This class implements the <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler.do_GET" title="http.server.SimpleHTTPRequestHandler.do_GET"><code class="xref py py-func docutils literal notranslate"><span class="pre">do_GET()</span></code></a>

  586. and <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler.do_HEAD" title="http.server.SimpleHTTPRequestHandler.do_HEAD"><code class="xref py py-func docutils literal notranslate"><span class="pre">do_HEAD()</span></code></a> functions.</p>

  587. <p>The following are defined as class-level attributes of

  588. <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a>:</p>

  589. <dl class="py attribute">

  590. <dt class="sig sig-object py" id="http.server.SimpleHTTPRequestHandler.server_version">

  591. <span class="sig-name descname"><span class="pre">server_version</span></span><a class="headerlink" href="#http.server.SimpleHTTPRequestHandler.server_version" title="Link to this definition">¶</a></dt>

  592. <dd><p>This will be <code class="docutils literal notranslate"><span class="pre">&quot;SimpleHTTP/&quot;</span> <span class="pre">+</span> <span class="pre">__version__</span></code>, where <code class="docutils literal notranslate"><span class="pre">__version__</span></code> is

  593. defined at the module level.</p>

  594. </dd></dl>

  595. 

  596. <dl class="py attribute">

  597. <dt class="sig sig-object py" id="http.server.SimpleHTTPRequestHandler.extensions_map">

  598. <span class="sig-name descname"><span class="pre">extensions_map</span></span><a class="headerlink" href="#http.server.SimpleHTTPRequestHandler.extensions_map" title="Link to this definition">¶</a></dt>

  599. <dd><p>A dictionary mapping suffixes into MIME types, contains custom overrides

  600. for the default system mappings. The mapping is used case-insensitively,

  601. and so should contain only lower-cased keys.</p>

  602. <div class="versionchanged">

  603. <p><span class="versionmodified changed">Changed in version 3.9: </span>This dictionary is no longer filled with the default system mappings,

  604. but only contains overrides.</p>

  605. </div>

  606. </dd></dl>

  607. 

  608. <p>The <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a> class defines the following methods:</p>

  609. <dl class="py method">

  610. <dt class="sig sig-object py" id="http.server.SimpleHTTPRequestHandler.do_HEAD">

  611. <span class="sig-name descname"><span class="pre">do_HEAD</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.SimpleHTTPRequestHandler.do_HEAD" title="Link to this definition">¶</a></dt>

  612. <dd><p>This method serves the <code class="docutils literal notranslate"><span class="pre">'HEAD'</span></code> request type: it sends the headers it

  613. would send for the equivalent <code class="docutils literal notranslate"><span class="pre">GET</span></code> request. See the <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler.do_GET" title="http.server.SimpleHTTPRequestHandler.do_GET"><code class="xref py py-meth docutils literal notranslate"><span class="pre">do_GET()</span></code></a>

  614. method for a more complete explanation of the possible headers.</p>

  615. </dd></dl>

  616. 

  617. <dl class="py method">

  618. <dt class="sig sig-object py" id="http.server.SimpleHTTPRequestHandler.do_GET">

  619. <span class="sig-name descname"><span class="pre">do_GET</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.SimpleHTTPRequestHandler.do_GET" title="Link to this definition">¶</a></dt>

  620. <dd><p>The request is mapped to a local file by interpreting the request as a

  621. path relative to the current working directory.</p>

  622. <p>If the request was mapped to a directory, the directory is checked for a

  623. file named <code class="docutils literal notranslate"><span class="pre">index.html</span></code> or <code class="docutils literal notranslate"><span class="pre">index.htm</span></code> (in that order). If found, the

  624. file’s contents are returned; otherwise a directory listing is generated

  625. by calling the <code class="xref py py-meth docutils literal notranslate"><span class="pre">list_directory()</span></code> method. This method uses

  626. <a class="reference internal" href="os.html#os.listdir" title="os.listdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.listdir()</span></code></a> to scan the directory, and returns a <code class="docutils literal notranslate"><span class="pre">404</span></code> error

  627. response if the <a class="reference internal" href="os.html#os.listdir" title="os.listdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">listdir()</span></code></a> fails.</p>

  628. <p>If the request was mapped to a file, it is opened. Any <a class="reference internal" href="exceptions.html#OSError" title="OSError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">OSError</span></code></a>

  629. exception in opening the requested file is mapped to a <code class="docutils literal notranslate"><span class="pre">404</span></code>,

  630. <code class="docutils literal notranslate"><span class="pre">'File</span> <span class="pre">not</span> <span class="pre">found'</span></code> error. If there was a <code class="docutils literal notranslate"><span class="pre">'If-Modified-Since'</span></code>

  631. header in the request, and the file was not modified after this time,

  632. a <code class="docutils literal notranslate"><span class="pre">304</span></code>, <code class="docutils literal notranslate"><span class="pre">'Not</span> <span class="pre">Modified'</span></code> response is sent. Otherwise, the content

  633. type is guessed by calling the <code class="xref py py-meth docutils literal notranslate"><span class="pre">guess_type()</span></code> method, which in turn

  634. uses the <em>extensions_map</em> variable, and the file contents are returned.</p>

  635. <p>A <code class="docutils literal notranslate"><span class="pre">'Content-type:'</span></code> header with the guessed content type is output,

  636. followed by a <code class="docutils literal notranslate"><span class="pre">'Content-Length:'</span></code> header with the file’s size and a

  637. <code class="docutils literal notranslate"><span class="pre">'Last-Modified:'</span></code> header with the file’s modification time.</p>

  638. <p>Then follows a blank line signifying the end of the headers, and then the

  639. contents of the file are output. If the file’s MIME type starts with

  640. <code class="docutils literal notranslate"><span class="pre">text/</span></code> the file is opened in text mode; otherwise binary mode is used.</p>

  641. <p>For example usage, see the implementation of the <code class="docutils literal notranslate"><span class="pre">test</span></code> function

  642. in <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/http/server.py">Lib/http/server.py</a>.</p>

  643. <div class="versionchanged">

  644. <p><span class="versionmodified changed">Changed in version 3.7: </span>Support of the <code class="docutils literal notranslate"><span class="pre">'If-Modified-Since'</span></code> header.</p>

  645. </div>

  646. </dd></dl>

  647. 

  648. </dd></dl>

  649. 

  650. <p>The <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a> class can be used in the following

  651. manner in order to create a very basic webserver serving files relative to

  652. the current directory:</p>

  653. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">http.server</span>

  654. <span class="kn">import</span> <span class="nn">socketserver</span>

  655. 

  656. <span class="n">PORT</span> <span class="o">=</span> <span class="mi">8000</span>

  657. 

  658. <span class="n">Handler</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">SimpleHTTPRequestHandler</span>

  659. 

  660. <span class="k">with</span> <span class="n">socketserver</span><span class="o">.</span><span class="n">TCPServer</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">Handler</span><span class="p">)</span> <span class="k">as</span> <span class="n">httpd</span><span class="p">:</span>

  661.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;serving at port&quot;</span><span class="p">,</span> <span class="n">PORT</span><span class="p">)</span>

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

  663. </pre></div>

  664. </div>

  665. <p><a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a> can also be subclassed to enhance behavior,

  666. such as using different index file names by overriding the class attribute

  667. <code class="xref py py-attr docutils literal notranslate"><span class="pre">index_pages</span></code>.</p>

  668. <p id="http-server-cli"><a class="reference internal" href="#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> can also be invoked directly using the <a class="reference internal" href="../using/cmdline.html#cmdoption-m"><code class="xref std std-option docutils literal notranslate"><span class="pre">-m</span></code></a>

  669. switch of the interpreter.  Similar to

  670. the previous example, this serves files relative to the current directory:</p>

  671. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span>

  672. </pre></div>

  673. </div>

  674. <p>The server listens to port 8000 by default. The default can be overridden

  675. by passing the desired port number as an argument:</p>

  676. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span> <span class="mi">9000</span>

  677. </pre></div>

  678. </div>

  679. <p>By default, the server binds itself to all interfaces.  The option <code class="docutils literal notranslate"><span class="pre">-b/--bind</span></code>

  680. specifies a specific address to which it should bind. Both IPv4 and IPv6

  681. addresses are supported. For example, the following command causes the server

  682. to bind to localhost only:</p>

  683. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span> <span class="o">--</span><span class="n">bind</span> <span class="mf">127.0.0.1</span>

  684. </pre></div>

  685. </div>

  686. <div class="versionchanged">

  687. <p><span class="versionmodified changed">Changed in version 3.4: </span>Added the <code class="docutils literal notranslate"><span class="pre">--bind</span></code> option.</p>

  688. </div>

  689. <div class="versionchanged">

  690. <p><span class="versionmodified changed">Changed in version 3.8: </span>Support IPv6 in the <code class="docutils literal notranslate"><span class="pre">--bind</span></code> option.</p>

  691. </div>

  692. <p>By default, the server uses the current directory. The option <code class="docutils literal notranslate"><span class="pre">-d/--directory</span></code>

  693. specifies a directory to which it should serve the files. For example,

  694. the following command uses a specific directory:</p>

  695. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span> <span class="o">--</span><span class="n">directory</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span>

  696. </pre></div>

  697. </div>

  698. <div class="versionchanged">

  699. <p><span class="versionmodified changed">Changed in version 3.7: </span>Added the <code class="docutils literal notranslate"><span class="pre">--directory</span></code> option.</p>

  700. </div>

  701. <p>By default, the server is conformant to HTTP/1.0. The option <code class="docutils literal notranslate"><span class="pre">-p/--protocol</span></code>

  702. specifies the HTTP version to which the server is conformant. For example, the

  703. following command runs an HTTP/1.1 conformant server:</p>

  704. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span> <span class="o">--</span><span class="n">protocol</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>

  705. </pre></div>

  706. </div>

  707. <div class="versionchanged">

  708. <p><span class="versionmodified changed">Changed in version 3.11: </span>Added the <code class="docutils literal notranslate"><span class="pre">--protocol</span></code> option.</p>

  709. </div>

  710. <dl class="py class">

  711. <dt class="sig sig-object py" id="http.server.CGIHTTPRequestHandler">

  712. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.server.</span></span><span class="sig-name descname"><span class="pre">CGIHTTPRequestHandler</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="#http.server.CGIHTTPRequestHandler" title="Link to this definition">¶</a></dt>

  713. <dd><p>This class is used to serve either files or output of CGI scripts from the

  714. current directory and below. Note that mapping HTTP hierarchic structure to

  715. local directory structure is exactly as in <a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a>.</p>

  716. <div class="admonition note">

  717. <p class="admonition-title">Note</p>

  718. <p>CGI scripts run by the <a class="reference internal" href="#http.server.CGIHTTPRequestHandler" title="http.server.CGIHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHTTPRequestHandler</span></code></a> class cannot execute

  719. redirects (HTTP code 302), because code 200 (script output follows) is

  720. sent prior to execution of the CGI script.  This pre-empts the status

  721. code.</p>

  722. </div>

  723. <p>The class will however, run the CGI script, instead of serving it as a file,

  724. if it guesses it to be a CGI script.  Only directory-based CGI are used —

  725. the other common server configuration is to treat special extensions as

  726. denoting CGI scripts.</p>

  727. <p>The <code class="xref py py-func docutils literal notranslate"><span class="pre">do_GET()</span></code> and <code class="xref py py-func docutils literal notranslate"><span class="pre">do_HEAD()</span></code> functions are modified to run CGI scripts

  728. and serve the output, instead of serving files, if the request leads to

  729. somewhere below the <code class="docutils literal notranslate"><span class="pre">cgi_directories</span></code> path.</p>

  730. <p>The <a class="reference internal" href="#http.server.CGIHTTPRequestHandler" title="http.server.CGIHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHTTPRequestHandler</span></code></a> defines the following data member:</p>

  731. <dl class="py attribute">

  732. <dt class="sig sig-object py" id="http.server.CGIHTTPRequestHandler.cgi_directories">

  733. <span class="sig-name descname"><span class="pre">cgi_directories</span></span><a class="headerlink" href="#http.server.CGIHTTPRequestHandler.cgi_directories" title="Link to this definition">¶</a></dt>

  734. <dd><p>This defaults to <code class="docutils literal notranslate"><span class="pre">['/cgi-bin',</span> <span class="pre">'/htbin']</span></code> and describes directories to

  735. treat as containing CGI scripts.</p>

  736. </dd></dl>

  737. 

  738. <p>The <a class="reference internal" href="#http.server.CGIHTTPRequestHandler" title="http.server.CGIHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHTTPRequestHandler</span></code></a> defines the following method:</p>

  739. <dl class="py method">

  740. <dt class="sig sig-object py" id="http.server.CGIHTTPRequestHandler.do_POST">

  741. <span class="sig-name descname"><span class="pre">do_POST</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.server.CGIHTTPRequestHandler.do_POST" title="Link to this definition">¶</a></dt>

  742. <dd><p>This method serves the <code class="docutils literal notranslate"><span class="pre">'POST'</span></code> request type, only allowed for CGI

  743. scripts.  Error 501, “Can only POST to CGI scripts”, is output when trying

  744. to POST to a non-CGI url.</p>

  745. </dd></dl>

  746. 

  747. <p>Note that CGI scripts will be run with UID of user nobody, for security

  748. reasons.  Problems with the CGI script will be translated to error 403.</p>

  749. </dd></dl>

  750. 

  751. <p><a class="reference internal" href="#http.server.CGIHTTPRequestHandler" title="http.server.CGIHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHTTPRequestHandler</span></code></a> can be enabled in the command line by passing

  752. the <code class="docutils literal notranslate"><span class="pre">--cgi</span></code> option:</p>

  753. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">http</span><span class="o">.</span><span class="n">server</span> <span class="o">--</span><span class="n">cgi</span>

  754. </pre></div>

  755. </div>

  756. <div class="admonition warning">

  757. <p class="admonition-title">Warning</p>

  758. <p><a class="reference internal" href="#http.server.CGIHTTPRequestHandler" title="http.server.CGIHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIHTTPRequestHandler</span></code></a> and the <code class="docutils literal notranslate"><span class="pre">--cgi</span></code> command line option

  759. are not intended for use by untrusted clients and may be vulnerable

  760. to exploitation. Always use within a secure environment.</p>

  761. </div>

  762. <section id="security-considerations">

  763. <span id="http-server-security"></span><h2>Security Considerations<a class="headerlink" href="#security-considerations" title="Link to this heading">¶</a></h2>

  764. <p id="index-3"><a class="reference internal" href="#http.server.SimpleHTTPRequestHandler" title="http.server.SimpleHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleHTTPRequestHandler</span></code></a> will follow symbolic links when handling

  765. requests, this makes it possible for files outside of the specified directory

  766. to be served.</p>

  767. <p>Earlier versions of Python did not scrub control characters from the

  768. log messages emitted to stderr from <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">http.server</span></code> or the

  769. default <a class="reference internal" href="#http.server.BaseHTTPRequestHandler" title="http.server.BaseHTTPRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BaseHTTPRequestHandler</span></code></a> <code class="docutils literal notranslate"><span class="pre">.log_message</span></code>

  770. implementation. This could allow remote clients connecting to your

  771. server to send nefarious control codes to your terminal.</p>

  772. <div class="versionchanged">

  773. <p><span class="versionmodified changed">Changed in version 3.12: </span>Control characters are scrubbed in stderr logs.</p>

  774. </div>

  775. </section>

  776. </section>

  777. 

  778. 

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

  780.           </div>

  781.         </div>

  782.       </div>

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

  784.         <div class="sphinxsidebarwrapper">

  785.   <div>

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

  787.     <ul>

  788. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.server</span></code> — HTTP servers</a><ul>

  789. <li><a class="reference internal" href="#security-considerations">Security Considerations</a></li>

  790. </ul>

  791. </li>

  792. </ul>

  793. 

  794.   </div>

  795.   <div>

  796.     <h4>Previous topic</h4>

  797.     <p class="topless"><a href="socketserver.html"

  798.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">socketserver</span></code> — A framework for network servers</a></p>

  799.   </div>

  800.   <div>

  801.     <h4>Next topic</h4>

  802.     <p class="topless"><a href="http.cookies.html"

  803.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.cookies</span></code> — HTTP state management</a></p>

  804.   </div>

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

  806.     <h3>This Page</h3>

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

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

  809.       <li>

  810.         <a href="https://github.com/python/cpython/blob/main/Doc/library/http.server.rst"

  811.             rel="nofollow">Show Source

  812.         </a>

  813.       </li>

  814.     </ul>

  815.   </div>

  816.         </div>

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

  818. <span>«</span>

  819. </div>

  820. 

  821.       </div>

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

  823.     </div>  

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

  825.       <h3>Navigation</h3>

  826.       <ul>

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

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

  829.              >index</a></li>

  830.         <li class="right" >

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

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

  833.         <li class="right" >

  834.           <a href="http.cookies.html" title="http.cookies — HTTP state management"

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

  836.         <li class="right" >

  837.           <a href="socketserver.html" title="socketserver — A framework for network servers"

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

  839. 

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

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

  842.           <li class="switchers">

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

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

  845.           </li>

  846.           <li>

  847.               

  848.           </li>

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

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

  851.     </li>

  852. 

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

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

  855.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">http.server</span></code> — HTTP servers</a></li>

  856.                 <li class="right">

  857.                     

  858. 

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

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

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

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

  863.         </form>

  864.     </div>

  865.                      |

  866.                 </li>

  867.             <li class="right">

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

  869.     Theme

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

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

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

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

  874.     </select>

  875. </label> |</li>

  876.             

  877.       </ul>

  878.     </div>  

  879.     <div class="footer">

  880.     &copy; 

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

  882.     

  883.     Copyright

  884.     

  885.       </a>

  886.      2001-2024, Python Software Foundation.

  887.     <br />

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

  889.     <br />

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

  891.     <br />

  892.     

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

  894.     

  895.     

  896.     <br />

  897. 

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

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

  900. <br />

  901.     <br />

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

  903.     

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

  905.     

  906.     <br />

  907. 

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

  909.     </div>

  910. 

  911.   </body>

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