Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
보기 1
좋아요 0
위키 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
트리: 0f75e31513
브랜치 태그
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/http.client.html

1023 lines
93KB
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.client — HTTP protocol client" />

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

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

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

  11. <meta property="og:description" content="Source code: Lib/http/client.py This module defines classes that implement the client side of the HTTP and HTTPS protocols. It is normally not used directly — the module urllib.request uses it to h..." />

  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/client.py This module defines classes that implement the client side of the HTTP and HTTPS protocols. It is normally not used directly — the module urllib.request uses it to h..." />

  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.client — HTTP protocol client &#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="ftplib — FTP protocol client" href="ftplib.html" />

  39.     <link rel="prev" title="http — HTTP modules" href="http.html" />

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

  99. <li><a class="reference internal" href="#httpconnection-objects">HTTPConnection Objects</a></li>

  100. <li><a class="reference internal" href="#httpresponse-objects">HTTPResponse Objects</a></li>

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

  102. <li><a class="reference internal" href="#httpmessage-objects">HTTPMessage Objects</a></li>

  103. </ul>

  104. </li>

  105. </ul>

  106. 

  107.   </div>

  108.   <div>

  109.     <h4>Previous topic</h4>

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

  111.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">http</span></code> — HTTP modules</a></p>

  112.   </div>

  113.   <div>

  114.     <h4>Next topic</h4>

  115.     <p class="topless"><a href="ftplib.html"

  116.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ftplib</span></code> — FTP protocol client</a></p>

  117.   </div>

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

  119.     <h3>This Page</h3>

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

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

  122.       <li>

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

  124.             rel="nofollow">Show Source

  125.         </a>

  126.       </li>

  127.     </ul>

  128.   </div>

  129.         </nav>

  130.     </div>

  131. </div>

  132. 

  133.   

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

  135.       <h3>Navigation</h3>

  136.       <ul>

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

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

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

  140.         <li class="right" >

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

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

  143.         <li class="right" >

  144.           <a href="ftplib.html" title="ftplib — FTP protocol client"

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

  146.         <li class="right" >

  147.           <a href="http.html" title="http — HTTP modules"

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

  149. 

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

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

  152.           <li class="switchers">

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

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

  155.           </li>

  156.           <li>

  157.               

  158.           </li>

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

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

  161.     </li>

  162. 

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

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

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

  166.                 <li class="right">

  167.                     

  168. 

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

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

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

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

  173.         </form>

  174.     </div>

  175.                      |

  176.                 </li>

  177.             <li class="right">

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

  179.     Theme

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

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

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

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

  184.     </select>

  185. </label> |</li>

  186.             

  187.       </ul>

  188.     </div>    

  189. 

  190.     <div class="document">

  191.       <div class="documentwrapper">

  192.         <div class="bodywrapper">

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

  194.             

  195.   <section id="module-http.client">

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

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

  198. <span id="index-0"></span><hr class="docutils" id="index-1" />

  199. <p>This module defines classes that implement the client side of the HTTP and

  200. HTTPS protocols.  It is normally not used directly — the module

  201. <a class="reference internal" href="urllib.request.html#module-urllib.request" title="urllib.request: Extensible library for opening URLs."><code class="xref py py-mod docutils literal notranslate"><span class="pre">urllib.request</span></code></a> uses it to handle URLs that use HTTP and HTTPS.</p>

  202. <div class="admonition seealso">

  203. <p class="admonition-title">See also</p>

  204. <p>The <a class="reference external" href="https://requests.readthedocs.io/en/latest/">Requests package</a>

  205. is recommended for a higher-level HTTP client interface.</p>

  206. </div>

  207. <div class="admonition note">

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

  209. <p>HTTPS support is only available if Python was compiled with SSL support

  210. (through the <a class="reference internal" href="ssl.html#module-ssl" title="ssl: TLS/SSL wrapper for socket objects"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ssl</span></code></a> module).</p>

  211. </div>

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

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

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

  215. <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

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

  217. </div>

  218. <p>The module provides the following classes:</p>

  219. <dl class="py class">

  220. <dt class="sig sig-object py" id="http.client.HTTPConnection">

  221. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPConnection</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=None</span></span></em>, <span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">source_address=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocksize=8192</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection" title="Link to this definition">¶</a></dt>

  222. <dd><p>An <a class="reference internal" href="#http.client.HTTPConnection" title="http.client.HTTPConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPConnection</span></code></a> instance represents one transaction with an HTTP

  223. server.  It should be instantiated by passing it a host and optional port

  224. number.  If no port number is passed, the port is extracted from the host

  225. string if it has the form <code class="docutils literal notranslate"><span class="pre">host:port</span></code>, else the default HTTP port (80) is

  226. used.  If the optional <em>timeout</em> parameter is given, blocking

  227. operations (like connection attempts) will timeout after that many seconds

  228. (if it is not given, the global default timeout setting is used).

  229. The optional <em>source_address</em> parameter may be a tuple of a (host, port)

  230. to use as the source address the HTTP connection is made from.

  231. The optional <em>blocksize</em> parameter sets the buffer size in bytes for

  232. sending a file-like message body.</p>

  233. <p>For example, the following calls all create instances that connect to the server

  234. at the same host and port:</p>

  235. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">h1</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s1">&#39;www.python.org&#39;</span><span class="p">)</span>

  236. <span class="gp">&gt;&gt;&gt; </span><span class="n">h2</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s1">&#39;www.python.org:80&#39;</span><span class="p">)</span>

  237. <span class="gp">&gt;&gt;&gt; </span><span class="n">h3</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s1">&#39;www.python.org&#39;</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>

  238. <span class="gp">&gt;&gt;&gt; </span><span class="n">h4</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s1">&#39;www.python.org&#39;</span><span class="p">,</span> <span class="mi">80</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>

  239. </pre></div>

  240. </div>

  241. <div class="versionchanged">

  242. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>source_address</em> was added.</p>

  243. </div>

  244. <div class="versionchanged">

  245. <p><span class="versionmodified changed">Changed in version 3.4: </span>The  <em>strict</em> parameter was removed. HTTP 0.9-style “Simple Responses” are

  246. no longer supported.</p>

  247. </div>

  248. <div class="versionchanged">

  249. <p><span class="versionmodified changed">Changed in version 3.7: </span><em>blocksize</em> parameter was added.</p>

  250. </div>

  251. </dd></dl>

  252. 

  253. <dl class="py class">

  254. <dt class="sig sig-object py" id="http.client.HTTPSConnection">

  255. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPSConnection</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=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span></em>, <span class="optional">]</span><em class="sig-param"><span class="n"><span class="pre">source_address=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">blocksize=8192</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPSConnection" title="Link to this definition">¶</a></dt>

  256. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPConnection" title="http.client.HTTPConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPConnection</span></code></a> that uses SSL for communication with

  257. secure servers.  Default port is <code class="docutils literal notranslate"><span class="pre">443</span></code>.  If <em>context</em> is specified, it

  258. must be a <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate"><span class="pre">ssl.SSLContext</span></code></a> instance describing the various SSL

  259. options.</p>

  260. <p>Please read <a class="reference internal" href="ssl.html#ssl-security"><span class="std std-ref">Security considerations</span></a> for more information on best practices.</p>

  261. <div class="versionchanged">

  262. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>source_address</em>, <em>context</em> and <em>check_hostname</em> were added.</p>

  263. </div>

  264. <div class="versionchanged">

  265. <p><span class="versionmodified changed">Changed in version 3.2: </span>This class now supports HTTPS virtual hosts if possible (that is,

  266. if <a class="reference internal" href="ssl.html#ssl.HAS_SNI" title="ssl.HAS_SNI"><code class="xref py py-const docutils literal notranslate"><span class="pre">ssl.HAS_SNI</span></code></a> is true).</p>

  267. </div>

  268. <div class="versionchanged">

  269. <p><span class="versionmodified changed">Changed in version 3.4: </span>The <em>strict</em> parameter was removed. HTTP 0.9-style “Simple Responses” are

  270. no longer supported.</p>

  271. </div>

  272. <div class="versionchanged">

  273. <p><span class="versionmodified changed">Changed in version 3.4.3: </span>This class now performs all the necessary certificate and hostname checks

  274. by default. To revert to the previous, unverified, behavior

  275. <code class="xref py py-func docutils literal notranslate"><span class="pre">ssl._create_unverified_context()</span></code> can be passed to the <em>context</em>

  276. parameter.</p>

  277. </div>

  278. <div class="versionchanged">

  279. <p><span class="versionmodified changed">Changed in version 3.8: </span>This class now enables TLS 1.3

  280. <a class="reference internal" href="ssl.html#ssl.SSLContext.post_handshake_auth" title="ssl.SSLContext.post_handshake_auth"><code class="xref py py-attr docutils literal notranslate"><span class="pre">ssl.SSLContext.post_handshake_auth</span></code></a> for the default <em>context</em> or

  281. when <em>cert_file</em> is passed with a custom <em>context</em>.</p>

  282. </div>

  283. <div class="versionchanged">

  284. <p><span class="versionmodified changed">Changed in version 3.10: </span>This class now sends an ALPN extension with protocol indicator

  285. <code class="docutils literal notranslate"><span class="pre">http/1.1</span></code> when no <em>context</em> is given. Custom <em>context</em> should set

  286. ALPN protocols with <a class="reference internal" href="ssl.html#ssl.SSLContext.set_alpn_protocols" title="ssl.SSLContext.set_alpn_protocols"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_alpn_protocols()</span></code></a>.</p>

  287. </div>

  288. <div class="versionchanged">

  289. <p><span class="versionmodified changed">Changed in version 3.12: </span>The deprecated <em>key_file</em>, <em>cert_file</em> and <em>check_hostname</em> parameters

  290. have been removed.</p>

  291. </div>

  292. </dd></dl>

  293. 

  294. <dl class="py class">

  295. <dt class="sig sig-object py" id="http.client.HTTPResponse">

  296. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPResponse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sock</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debuglevel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</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">url</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.client.HTTPResponse" title="Link to this definition">¶</a></dt>

  297. <dd><p>Class whose instances are returned upon successful connection.  Not

  298. instantiated directly by user.</p>

  299. <div class="versionchanged">

  300. <p><span class="versionmodified changed">Changed in version 3.4: </span>The <em>strict</em> parameter was removed. HTTP 0.9 style “Simple Responses” are

  301. no longer supported.</p>

  302. </div>

  303. </dd></dl>

  304. 

  305. <p>This module provides the following function:</p>

  306. <dl class="py function">

  307. <dt class="sig sig-object py" id="http.client.parse_headers">

  308. <span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">parse_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fp</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.parse_headers" title="Link to this definition">¶</a></dt>

  309. <dd><p>Parse the headers from a file pointer <em>fp</em> representing a HTTP

  310. request/response. The file has to be a <a class="reference internal" href="io.html#io.BufferedIOBase" title="io.BufferedIOBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">BufferedIOBase</span></code></a> reader

  311. (i.e. not text) and must 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>

  312. <p>This function returns an instance of <a class="reference internal" href="#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>

  313. that holds the header fields, but no payload

  314. (the same as <a class="reference internal" href="#http.client.HTTPResponse.msg" title="http.client.HTTPResponse.msg"><code class="xref py py-attr docutils literal notranslate"><span class="pre">HTTPResponse.msg</span></code></a>

  315. and <a class="reference internal" href="http.server.html#http.server.BaseHTTPRequestHandler.headers" title="http.server.BaseHTTPRequestHandler.headers"><code class="xref py py-attr docutils literal notranslate"><span class="pre">http.server.BaseHTTPRequestHandler.headers</span></code></a>).

  316. After returning, the file pointer <em>fp</em> is ready to read the HTTP body.</p>

  317. <div class="admonition note">

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

  319. <p><a class="reference internal" href="#http.client.parse_headers" title="http.client.parse_headers"><code class="xref py py-meth docutils literal notranslate"><span class="pre">parse_headers()</span></code></a> does not parse the start-line of a HTTP message;

  320. it only parses the <code class="docutils literal notranslate"><span class="pre">Name:</span> <span class="pre">value</span></code> lines. The file has to be ready to

  321. read these field lines, so the first line should already be consumed

  322. before calling the function.</p>

  323. </div>

  324. </dd></dl>

  325. 

  326. <p>The following exceptions are raised as appropriate:</p>

  327. <dl class="py exception">

  328. <dt class="sig sig-object py" id="http.client.HTTPException">

  329. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPException</span></span><a class="headerlink" href="#http.client.HTTPException" title="Link to this definition">¶</a></dt>

  330. <dd><p>The base class of the other exceptions in this module.  It is a subclass of

  331. <a class="reference internal" href="exceptions.html#Exception" title="Exception"><code class="xref py py-exc docutils literal notranslate"><span class="pre">Exception</span></code></a>.</p>

  332. </dd></dl>

  333. 

  334. <dl class="py exception">

  335. <dt class="sig sig-object py" id="http.client.NotConnected">

  336. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">NotConnected</span></span><a class="headerlink" href="#http.client.NotConnected" title="Link to this definition">¶</a></dt>

  337. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  338. </dd></dl>

  339. 

  340. <dl class="py exception">

  341. <dt class="sig sig-object py" id="http.client.InvalidURL">

  342. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">InvalidURL</span></span><a class="headerlink" href="#http.client.InvalidURL" title="Link to this definition">¶</a></dt>

  343. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>, raised if a port is given and is either

  344. non-numeric or empty.</p>

  345. </dd></dl>

  346. 

  347. <dl class="py exception">

  348. <dt class="sig sig-object py" id="http.client.UnknownProtocol">

  349. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">UnknownProtocol</span></span><a class="headerlink" href="#http.client.UnknownProtocol" title="Link to this definition">¶</a></dt>

  350. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  351. </dd></dl>

  352. 

  353. <dl class="py exception">

  354. <dt class="sig sig-object py" id="http.client.UnknownTransferEncoding">

  355. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">UnknownTransferEncoding</span></span><a class="headerlink" href="#http.client.UnknownTransferEncoding" title="Link to this definition">¶</a></dt>

  356. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  357. </dd></dl>

  358. 

  359. <dl class="py exception">

  360. <dt class="sig sig-object py" id="http.client.UnimplementedFileMode">

  361. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">UnimplementedFileMode</span></span><a class="headerlink" href="#http.client.UnimplementedFileMode" title="Link to this definition">¶</a></dt>

  362. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  363. </dd></dl>

  364. 

  365. <dl class="py exception">

  366. <dt class="sig sig-object py" id="http.client.IncompleteRead">

  367. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">IncompleteRead</span></span><a class="headerlink" href="#http.client.IncompleteRead" title="Link to this definition">¶</a></dt>

  368. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  369. </dd></dl>

  370. 

  371. <dl class="py exception">

  372. <dt class="sig sig-object py" id="http.client.ImproperConnectionState">

  373. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">ImproperConnectionState</span></span><a class="headerlink" href="#http.client.ImproperConnectionState" title="Link to this definition">¶</a></dt>

  374. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.</p>

  375. </dd></dl>

  376. 

  377. <dl class="py exception">

  378. <dt class="sig sig-object py" id="http.client.CannotSendRequest">

  379. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">CannotSendRequest</span></span><a class="headerlink" href="#http.client.CannotSendRequest" title="Link to this definition">¶</a></dt>

  380. <dd><p>A subclass of <a class="reference internal" href="#http.client.ImproperConnectionState" title="http.client.ImproperConnectionState"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImproperConnectionState</span></code></a>.</p>

  381. </dd></dl>

  382. 

  383. <dl class="py exception">

  384. <dt class="sig sig-object py" id="http.client.CannotSendHeader">

  385. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">CannotSendHeader</span></span><a class="headerlink" href="#http.client.CannotSendHeader" title="Link to this definition">¶</a></dt>

  386. <dd><p>A subclass of <a class="reference internal" href="#http.client.ImproperConnectionState" title="http.client.ImproperConnectionState"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImproperConnectionState</span></code></a>.</p>

  387. </dd></dl>

  388. 

  389. <dl class="py exception">

  390. <dt class="sig sig-object py" id="http.client.ResponseNotReady">

  391. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">ResponseNotReady</span></span><a class="headerlink" href="#http.client.ResponseNotReady" title="Link to this definition">¶</a></dt>

  392. <dd><p>A subclass of <a class="reference internal" href="#http.client.ImproperConnectionState" title="http.client.ImproperConnectionState"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImproperConnectionState</span></code></a>.</p>

  393. </dd></dl>

  394. 

  395. <dl class="py exception">

  396. <dt class="sig sig-object py" id="http.client.BadStatusLine">

  397. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">BadStatusLine</span></span><a class="headerlink" href="#http.client.BadStatusLine" title="Link to this definition">¶</a></dt>

  398. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.  Raised if a server responds with a HTTP

  399. status code that we don’t understand.</p>

  400. </dd></dl>

  401. 

  402. <dl class="py exception">

  403. <dt class="sig sig-object py" id="http.client.LineTooLong">

  404. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">LineTooLong</span></span><a class="headerlink" href="#http.client.LineTooLong" title="Link to this definition">¶</a></dt>

  405. <dd><p>A subclass of <a class="reference internal" href="#http.client.HTTPException" title="http.client.HTTPException"><code class="xref py py-exc docutils literal notranslate"><span class="pre">HTTPException</span></code></a>.  Raised if an excessively long line

  406. is received in the HTTP protocol from the server.</p>

  407. </dd></dl>

  408. 

  409. <dl class="py exception">

  410. <dt class="sig sig-object py" id="http.client.RemoteDisconnected">

  411. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">RemoteDisconnected</span></span><a class="headerlink" href="#http.client.RemoteDisconnected" title="Link to this definition">¶</a></dt>

  412. <dd><p>A subclass of <a class="reference internal" href="exceptions.html#ConnectionResetError" title="ConnectionResetError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ConnectionResetError</span></code></a> and <a class="reference internal" href="#http.client.BadStatusLine" title="http.client.BadStatusLine"><code class="xref py py-exc docutils literal notranslate"><span class="pre">BadStatusLine</span></code></a>.  Raised

  413. by <a class="reference internal" href="#http.client.HTTPConnection.getresponse" title="http.client.HTTPConnection.getresponse"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HTTPConnection.getresponse()</span></code></a> when the attempt to read the response

  414. results in no data read from the connection, indicating that the remote end

  415. has closed the connection.</p>

  416. <div class="versionadded">

  417. <p><span class="versionmodified added">New in version 3.5: </span>Previously, <a class="reference internal" href="#http.client.BadStatusLine" title="http.client.BadStatusLine"><code class="xref py py-exc docutils literal notranslate"><span class="pre">BadStatusLine</span></code></a><code class="docutils literal notranslate"><span class="pre">('')</span></code> was raised.</p>

  418. </div>

  419. </dd></dl>

  420. 

  421. <p>The constants defined in this module are:</p>

  422. <dl class="py data">

  423. <dt class="sig sig-object py" id="http.client.HTTP_PORT">

  424. <span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTP_PORT</span></span><a class="headerlink" href="#http.client.HTTP_PORT" title="Link to this definition">¶</a></dt>

  425. <dd><p>The default port for the HTTP protocol (always <code class="docutils literal notranslate"><span class="pre">80</span></code>).</p>

  426. </dd></dl>

  427. 

  428. <dl class="py data">

  429. <dt class="sig sig-object py" id="http.client.HTTPS_PORT">

  430. <span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPS_PORT</span></span><a class="headerlink" href="#http.client.HTTPS_PORT" title="Link to this definition">¶</a></dt>

  431. <dd><p>The default port for the HTTPS protocol (always <code class="docutils literal notranslate"><span class="pre">443</span></code>).</p>

  432. </dd></dl>

  433. 

  434. <dl class="py data">

  435. <dt class="sig sig-object py" id="http.client.responses">

  436. <span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">responses</span></span><a class="headerlink" href="#http.client.responses" title="Link to this definition">¶</a></dt>

  437. <dd><p>This dictionary maps the HTTP 1.1 status codes to the W3C names.</p>

  438. <p>Example: <code class="docutils literal notranslate"><span class="pre">http.client.responses[http.client.NOT_FOUND]</span></code> is <code class="docutils literal notranslate"><span class="pre">'Not</span> <span class="pre">Found'</span></code>.</p>

  439. </dd></dl>

  440. 

  441. <p>See <a class="reference internal" href="http.html#http-status-codes"><span class="std std-ref">HTTP status codes</span></a> for a list of HTTP status codes that are

  442. available in this module as constants.</p>

  443. <section id="httpconnection-objects">

  444. <span id="id1"></span><h2>HTTPConnection Objects<a class="headerlink" href="#httpconnection-objects" title="Link to this heading">¶</a></h2>

  445. <p><a class="reference internal" href="#http.client.HTTPConnection" title="http.client.HTTPConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPConnection</span></code></a> instances have the following methods:</p>

  446. <dl class="py method">

  447. <dt class="sig sig-object py" id="http.client.HTTPConnection.request">

  448. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</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">headers</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encode_chunked</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="#http.client.HTTPConnection.request" title="Link to this definition">¶</a></dt>

  449. <dd><p>This will send a request to the server using the HTTP request

  450. method <em>method</em> and the request URI <em>url</em>. The provided <em>url</em> must be

  451. an absolute path to conform with <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2"><strong>RFC 2616 §5.1.2</strong></a>

  452. (unless connecting to an HTTP proxy server or using the <code class="docutils literal notranslate"><span class="pre">OPTIONS</span></code> or

  453. <code class="docutils literal notranslate"><span class="pre">CONNECT</span></code> methods).</p>

  454. <p>If <em>body</em> is specified, the specified data is sent after the headers are

  455. finished.  It may be a <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, a <a class="reference internal" href="../glossary.html#term-bytes-like-object"><span class="xref std std-term">bytes-like object</span></a>, an

  456. open <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a>, or an iterable of <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a>.  If <em>body</em>

  457. is a string, it is encoded as ISO-8859-1, the default for HTTP.  If it

  458. is a bytes-like object, the bytes are sent as is.  If it is a <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file

  459. object</span></a>, the contents of the file is sent; this file object should

  460. support at least the <code class="docutils literal notranslate"><span class="pre">read()</span></code> method.  If the file object is an

  461. instance of <a class="reference internal" href="io.html#io.TextIOBase" title="io.TextIOBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">io.TextIOBase</span></code></a>, the data returned by the <code class="docutils literal notranslate"><span class="pre">read()</span></code>

  462. method will be encoded as ISO-8859-1, otherwise the data returned by

  463. <code class="docutils literal notranslate"><span class="pre">read()</span></code> is sent as is.  If <em>body</em> is an iterable, the elements of the

  464. iterable are sent as is until the iterable is exhausted.</p>

  465. <p>The <em>headers</em> argument should be a mapping of extra HTTP headers to send

  466. with the request. A <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html#section-14.23"><strong>Host header</strong></a>

  467. must be provided to conform with <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2616.html#section-5.1.2"><strong>RFC 2616 §5.1.2</strong></a>

  468. (unless connecting to an HTTP proxy server or using the <code class="docutils literal notranslate"><span class="pre">OPTIONS</span></code> or

  469. <code class="docutils literal notranslate"><span class="pre">CONNECT</span></code> methods).</p>

  470. <p>If <em>headers</em> contains neither Content-Length nor Transfer-Encoding,

  471. but there is a request body, one of those

  472. header fields will be added automatically.  If

  473. <em>body</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the Content-Length header is set to <code class="docutils literal notranslate"><span class="pre">0</span></code> for

  474. methods that expect a body (<code class="docutils literal notranslate"><span class="pre">PUT</span></code>, <code class="docutils literal notranslate"><span class="pre">POST</span></code>, and <code class="docutils literal notranslate"><span class="pre">PATCH</span></code>).  If

  475. <em>body</em> is a string or a bytes-like object that is not also a

  476. <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file</span></a>, the Content-Length header is

  477. set to its length.  Any other type of <em>body</em> (files

  478. and iterables in general) will be chunk-encoded, and the

  479. Transfer-Encoding header will automatically be set instead of

  480. Content-Length.</p>

  481. <p>The <em>encode_chunked</em> argument is only relevant if Transfer-Encoding is

  482. specified in <em>headers</em>.  If <em>encode_chunked</em> is <code class="docutils literal notranslate"><span class="pre">False</span></code>, the

  483. HTTPConnection object assumes that all encoding is handled by the

  484. calling code.  If it is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the body will be chunk-encoded.</p>

  485. <p>For example, to perform a <code class="docutils literal notranslate"><span class="pre">GET</span></code> request to <code class="docutils literal notranslate"><span class="pre">https://docs.python.org/3/</span></code>:</p>

  486. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span>

  487. <span class="gp">&gt;&gt;&gt; </span><span class="n">host</span> <span class="o">=</span> <span class="s2">&quot;docs.python.org&quot;</span>

  488. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPSConnection</span><span class="p">(</span><span class="n">host</span><span class="p">)</span>

  489. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="s2">&quot;/3/&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;Host&quot;</span><span class="p">:</span> <span class="n">host</span><span class="p">})</span>

  490. <span class="gp">&gt;&gt;&gt; </span><span class="n">response</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  491. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  492. <span class="go">200 OK</span>

  493. </pre></div>

  494. </div>

  495. <div class="admonition note">

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

  497. <p>Chunked transfer encoding has been added to the HTTP protocol

  498. version 1.1.  Unless the HTTP server is known to handle HTTP 1.1,

  499. the caller must either specify the Content-Length, or must pass a

  500. <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a> or bytes-like object that is not also a file as the

  501. body representation.</p>

  502. </div>

  503. <div class="versionchanged">

  504. <p><span class="versionmodified changed">Changed in version 3.2: </span><em>body</em> can now be an iterable.</p>

  505. </div>

  506. <div class="versionchanged">

  507. <p><span class="versionmodified changed">Changed in version 3.6: </span>If neither Content-Length nor Transfer-Encoding are set in

  508. <em>headers</em>, file and iterable <em>body</em> objects are now chunk-encoded.

  509. The <em>encode_chunked</em> argument was added.

  510. No attempt is made to determine the Content-Length for file

  511. objects.</p>

  512. </div>

  513. </dd></dl>

  514. 

  515. <dl class="py method">

  516. <dt class="sig sig-object py" id="http.client.HTTPConnection.getresponse">

  517. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">getresponse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.getresponse" title="Link to this definition">¶</a></dt>

  518. <dd><p>Should be called after a request is sent to get the response from the server.

  519. Returns an <a class="reference internal" href="#http.client.HTTPResponse" title="http.client.HTTPResponse"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPResponse</span></code></a> instance.</p>

  520. <div class="admonition note">

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

  522. <p>Note that you must have read the whole response before you can send a new

  523. request to the server.</p>

  524. </div>

  525. <div class="versionchanged">

  526. <p><span class="versionmodified changed">Changed in version 3.5: </span>If a <a class="reference internal" href="exceptions.html#ConnectionError" title="ConnectionError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ConnectionError</span></code></a> or subclass is raised, the

  527. <a class="reference internal" href="#http.client.HTTPConnection" title="http.client.HTTPConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPConnection</span></code></a> object will be ready to reconnect when

  528. a new request is sent.</p>

  529. </div>

  530. </dd></dl>

  531. 

  532. <dl class="py method">

  533. <dt class="sig sig-object py" id="http.client.HTTPConnection.set_debuglevel">

  534. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">set_debuglevel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">level</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.set_debuglevel" title="Link to this definition">¶</a></dt>

  535. <dd><p>Set the debugging level.  The default debug level is <code class="docutils literal notranslate"><span class="pre">0</span></code>, meaning no

  536. debugging output is printed.  Any value greater than <code class="docutils literal notranslate"><span class="pre">0</span></code> will cause all

  537. currently defined debug output to be printed to stdout.  The <code class="docutils literal notranslate"><span class="pre">debuglevel</span></code>

  538. is passed to any new <a class="reference internal" href="#http.client.HTTPResponse" title="http.client.HTTPResponse"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPResponse</span></code></a> objects that are created.</p>

  539. <div class="versionadded">

  540. <p><span class="versionmodified added">New in version 3.1.</span></p>

  541. </div>

  542. </dd></dl>

  543. 

  544. <dl class="py method">

  545. <dt class="sig sig-object py" id="http.client.HTTPConnection.set_tunnel">

  546. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">set_tunnel</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><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">headers</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.client.HTTPConnection.set_tunnel" title="Link to this definition">¶</a></dt>

  547. <dd><p>Set the host and the port for HTTP Connect Tunnelling. This allows running

  548. the connection through a proxy server.</p>

  549. <p>The <em>host</em> and <em>port</em> arguments specify the endpoint of the tunneled connection

  550. (i.e. the address included in the CONNECT request, <em>not</em> the address of the

  551. proxy server).</p>

  552. <p>The <em>headers</em> argument should be a mapping of extra HTTP headers to send with

  553. the CONNECT request.</p>

  554. <p>As HTTP/1.1 is used for HTTP CONNECT tunnelling request, <a class="reference external" href="https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.6">as per the RFC</a>, a HTTP <code class="docutils literal notranslate"><span class="pre">Host:</span></code>

  555. header must be provided, matching the authority-form of the request target

  556. provided as the destination for the CONNECT request. If a HTTP <code class="docutils literal notranslate"><span class="pre">Host:</span></code>

  557. header is not provided via the headers argument, one is generated and

  558. transmitted automatically.</p>

  559. <p>For example, to tunnel through a HTTPS proxy server running locally on port

  560. 8080, we would pass the address of the proxy to the <a class="reference internal" href="#http.client.HTTPSConnection" title="http.client.HTTPSConnection"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPSConnection</span></code></a>

  561. constructor, and the address of the host that we eventually want to reach to

  562. the <a class="reference internal" href="#http.client.HTTPConnection.set_tunnel" title="http.client.HTTPConnection.set_tunnel"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set_tunnel()</span></code></a> method:</p>

  563. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span>

  564. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPSConnection</span><span class="p">(</span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span> <span class="mi">8080</span><span class="p">)</span>

  565. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">set_tunnel</span><span class="p">(</span><span class="s2">&quot;www.python.org&quot;</span><span class="p">)</span>

  566. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;HEAD&quot;</span><span class="p">,</span><span class="s2">&quot;/index.html&quot;</span><span class="p">)</span>

  567. </pre></div>

  568. </div>

  569. <div class="versionadded">

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

  571. </div>

  572. <div class="versionchanged">

  573. <p><span class="versionmodified changed">Changed in version 3.12: </span>HTTP CONNECT tunnelling requests use protocol HTTP/1.1, upgraded from

  574. protocol HTTP/1.0. <code class="docutils literal notranslate"><span class="pre">Host:</span></code> HTTP headers are mandatory for HTTP/1.1, so

  575. one will be automatically generated and transmitted if not provided in

  576. the headers argument.</p>

  577. </div>

  578. </dd></dl>

  579. 

  580. <dl class="py method">

  581. <dt class="sig sig-object py" id="http.client.HTTPConnection.get_proxy_response_headers">

  582. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">get_proxy_response_headers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.get_proxy_response_headers" title="Link to this definition">¶</a></dt>

  583. <dd><p>Returns a dictionary with the headers of the response received from

  584. the proxy server to the CONNECT request.</p>

  585. <p>If the CONNECT request was not sent, the method returns <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  586. <div class="versionadded">

  587. <p><span class="versionmodified added">New in version 3.12.</span></p>

  588. </div>

  589. </dd></dl>

  590. 

  591. <dl class="py method">

  592. <dt class="sig sig-object py" id="http.client.HTTPConnection.connect">

  593. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.connect" title="Link to this definition">¶</a></dt>

  594. <dd><p>Connect to the server specified when the object was created.  By default,

  595. this is called automatically when making a request if the client does not

  596. already have a connection.</p>

  597. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">http.client.connect</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">host</span></code>, <code class="docutils literal notranslate"><span class="pre">port</span></code>.</p>

  598. </dd></dl>

  599. 

  600. <dl class="py method">

  601. <dt class="sig sig-object py" id="http.client.HTTPConnection.close">

  602. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.close" title="Link to this definition">¶</a></dt>

  603. <dd><p>Close the connection to the server.</p>

  604. </dd></dl>

  605. 

  606. <dl class="py attribute">

  607. <dt class="sig sig-object py" id="http.client.HTTPConnection.blocksize">

  608. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">blocksize</span></span><a class="headerlink" href="#http.client.HTTPConnection.blocksize" title="Link to this definition">¶</a></dt>

  609. <dd><p>Buffer size in bytes for sending a file-like message body.</p>

  610. <div class="versionadded">

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

  612. </div>

  613. </dd></dl>

  614. 

  615. <p>As an alternative to using the <a class="reference internal" href="#http.client.HTTPConnection.request" title="http.client.HTTPConnection.request"><code class="xref py py-meth docutils literal notranslate"><span class="pre">request()</span></code></a> method described above, you can

  616. also send your request step by step, by using the four functions below.</p>

  617. <dl class="py method">

  618. <dt class="sig sig-object py" id="http.client.HTTPConnection.putrequest">

  619. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">putrequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_host</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skip_accept_encoding</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="#http.client.HTTPConnection.putrequest" title="Link to this definition">¶</a></dt>

  620. <dd><p>This should be the first call after the connection to the server has been

  621. made. It sends a line to the server consisting of the <em>method</em> string,

  622. the <em>url</em> string, and the HTTP version (<code class="docutils literal notranslate"><span class="pre">HTTP/1.1</span></code>).  To disable automatic

  623. sending of <code class="docutils literal notranslate"><span class="pre">Host:</span></code> or <code class="docutils literal notranslate"><span class="pre">Accept-Encoding:</span></code> headers (for example to accept

  624. additional content encodings), specify <em>skip_host</em> or <em>skip_accept_encoding</em>

  625. with non-False values.</p>

  626. </dd></dl>

  627. 

  628. <dl class="py method">

  629. <dt class="sig sig-object py" id="http.client.HTTPConnection.putheader">

  630. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">putheader</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">header</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">argument</span></span></em><span class="optional">[</span>, <em class="sig-param"><span class="n"><span class="pre">...</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPConnection.putheader" title="Link to this definition">¶</a></dt>

  631. <dd><p>Send an <span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc822.html"><strong>RFC 822</strong></a>-style header to the server.  It sends a line to the server

  632. consisting of the header, a colon and a space, and the first argument.  If more

  633. arguments are given, continuation lines are sent, each consisting of a tab and

  634. an argument.</p>

  635. </dd></dl>

  636. 

  637. <dl class="py method">

  638. <dt class="sig sig-object py" id="http.client.HTTPConnection.endheaders">

  639. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">endheaders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message_body</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="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encode_chunked</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="#http.client.HTTPConnection.endheaders" title="Link to this definition">¶</a></dt>

  640. <dd><p>Send a blank line to the server, signalling the end of the headers. The

  641. optional <em>message_body</em> argument can be used to pass a message body

  642. associated with the request.</p>

  643. <p>If <em>encode_chunked</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code>, the result of each iteration of

  644. <em>message_body</em> will be chunk-encoded as specified in <span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc7230.html"><strong>RFC 7230</strong></a>,

  645. Section 3.3.1.  How the data is encoded is dependent on the type of

  646. <em>message_body</em>.  If <em>message_body</em> implements the <a class="reference internal" href="../c-api/buffer.html#bufferobjects"><span class="std std-ref">buffer interface</span></a> the encoding will result in a single chunk.

  647. If <em>message_body</em> is a <a class="reference internal" href="collections.abc.html#collections.abc.Iterable" title="collections.abc.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">collections.abc.Iterable</span></code></a>, each iteration

  648. of <em>message_body</em> will result in a chunk.  If <em>message_body</em> is a

  649. <a class="reference internal" href="../glossary.html#term-file-object"><span class="xref std std-term">file object</span></a>, each call to <code class="docutils literal notranslate"><span class="pre">.read()</span></code> will result in a chunk.

  650. The method automatically signals the end of the chunk-encoded data

  651. immediately after <em>message_body</em>.</p>

  652. <div class="admonition note">

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

  654. <p>Due to the chunked encoding specification, empty chunks

  655. yielded by an iterator body will be ignored by the chunk-encoder.

  656. This is to avoid premature termination of the read of the request by

  657. the target server due to malformed encoding.</p>

  658. </div>

  659. <div class="versionchanged">

  660. <p><span class="versionmodified changed">Changed in version 3.6: </span>Added chunked encoding support and the <em>encode_chunked</em> parameter.</p>

  661. </div>

  662. </dd></dl>

  663. 

  664. <dl class="py method">

  665. <dt class="sig sig-object py" id="http.client.HTTPConnection.send">

  666. <span class="sig-prename descclassname"><span class="pre">HTTPConnection.</span></span><span class="sig-name descname"><span class="pre">send</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="#http.client.HTTPConnection.send" title="Link to this definition">¶</a></dt>

  667. <dd><p>Send data to the server.  This should be used directly only after the

  668. <a class="reference internal" href="#http.client.HTTPConnection.endheaders" title="http.client.HTTPConnection.endheaders"><code class="xref py py-meth docutils literal notranslate"><span class="pre">endheaders()</span></code></a> method has been called and before <a class="reference internal" href="#http.client.HTTPConnection.getresponse" title="http.client.HTTPConnection.getresponse"><code class="xref py py-meth docutils literal notranslate"><span class="pre">getresponse()</span></code></a> is

  669. called.</p>

  670. <p class="audit-hook">Raises an <a class="reference internal" href="sys.html#auditing"><span class="std std-ref">auditing event</span></a> <code class="docutils literal notranslate"><span class="pre">http.client.send</span></code> with arguments <code class="docutils literal notranslate"><span class="pre">self</span></code>, <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p>

  671. </dd></dl>

  672. 

  673. </section>

  674. <section id="httpresponse-objects">

  675. <span id="id2"></span><h2>HTTPResponse Objects<a class="headerlink" href="#httpresponse-objects" title="Link to this heading">¶</a></h2>

  676. <p>An <a class="reference internal" href="#http.client.HTTPResponse" title="http.client.HTTPResponse"><code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPResponse</span></code></a> instance wraps the HTTP response from the

  677. server.  It provides access to the request headers and the entity

  678. body.  The response is an iterable object and can be used in a with

  679. statement.</p>

  680. <div class="versionchanged">

  681. <p><span class="versionmodified changed">Changed in version 3.5: </span>The <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> interface is now implemented and

  682. all of its reader operations are supported.</p>

  683. </div>

  684. <dl class="py method">

  685. <dt class="sig sig-object py" id="http.client.HTTPResponse.read">

  686. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">read</span></span><span class="sig-paren">(</span><span class="optional">[</span><em class="sig-param"><span class="n"><span class="pre">amt</span></span></em><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.read" title="Link to this definition">¶</a></dt>

  687. <dd><p>Reads and returns the response body, or up to the next <em>amt</em> bytes.</p>

  688. </dd></dl>

  689. 

  690. <dl class="py method">

  691. <dt class="sig sig-object py" id="http.client.HTTPResponse.readinto">

  692. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">readinto</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">b</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.readinto" title="Link to this definition">¶</a></dt>

  693. <dd><p>Reads up to the next len(b) bytes of the response body into the buffer <em>b</em>.

  694. Returns the number of bytes read.</p>

  695. <div class="versionadded">

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

  697. </div>

  698. </dd></dl>

  699. 

  700. <dl class="py method">

  701. <dt class="sig sig-object py" id="http.client.HTTPResponse.getheader">

  702. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">getheader</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">default</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.client.HTTPResponse.getheader" title="Link to this definition">¶</a></dt>

  703. <dd><p>Return the value of the header <em>name</em>, or <em>default</em> if there is no header

  704. matching <em>name</em>.  If there is more than one  header with the name <em>name</em>,

  705. return all of the values joined by ‘, ‘.  If <em>default</em> is any iterable other

  706. than a single string, its elements are similarly returned joined by commas.</p>

  707. </dd></dl>

  708. 

  709. <dl class="py method">

  710. <dt class="sig sig-object py" id="http.client.HTTPResponse.getheaders">

  711. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">getheaders</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.getheaders" title="Link to this definition">¶</a></dt>

  712. <dd><p>Return a list of (header, value) tuples.</p>

  713. </dd></dl>

  714. 

  715. <dl class="py method">

  716. <dt class="sig sig-object py" id="http.client.HTTPResponse.fileno">

  717. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">fileno</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.fileno" title="Link to this definition">¶</a></dt>

  718. <dd><p>Return the <code class="docutils literal notranslate"><span class="pre">fileno</span></code> of the underlying socket.</p>

  719. </dd></dl>

  720. 

  721. <dl class="py attribute">

  722. <dt class="sig sig-object py" id="http.client.HTTPResponse.msg">

  723. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">msg</span></span><a class="headerlink" href="#http.client.HTTPResponse.msg" title="Link to this definition">¶</a></dt>

  724. <dd><p>A <a class="reference internal" href="#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> instance containing the response

  725. headers.  <a class="reference internal" href="#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> is a subclass of

  726. <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>.</p>

  727. </dd></dl>

  728. 

  729. <dl class="py attribute">

  730. <dt class="sig sig-object py" id="http.client.HTTPResponse.version">

  731. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#http.client.HTTPResponse.version" title="Link to this definition">¶</a></dt>

  732. <dd><p>HTTP protocol version used by server.  10 for HTTP/1.0, 11 for HTTP/1.1.</p>

  733. </dd></dl>

  734. 

  735. <dl class="py attribute">

  736. <dt class="sig sig-object py" id="http.client.HTTPResponse.url">

  737. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">url</span></span><a class="headerlink" href="#http.client.HTTPResponse.url" title="Link to this definition">¶</a></dt>

  738. <dd><p>URL of the resource retrieved, commonly used to determine if a redirect was followed.</p>

  739. </dd></dl>

  740. 

  741. <dl class="py attribute">

  742. <dt class="sig sig-object py" id="http.client.HTTPResponse.headers">

  743. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">headers</span></span><a class="headerlink" href="#http.client.HTTPResponse.headers" title="Link to this definition">¶</a></dt>

  744. <dd><p>Headers of the response in the form of an <a class="reference internal" href="email.message.html#email.message.EmailMessage" title="email.message.EmailMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">email.message.EmailMessage</span></code></a> instance.</p>

  745. </dd></dl>

  746. 

  747. <dl class="py attribute">

  748. <dt class="sig sig-object py" id="http.client.HTTPResponse.status">

  749. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">status</span></span><a class="headerlink" href="#http.client.HTTPResponse.status" title="Link to this definition">¶</a></dt>

  750. <dd><p>Status code returned by server.</p>

  751. </dd></dl>

  752. 

  753. <dl class="py attribute">

  754. <dt class="sig sig-object py" id="http.client.HTTPResponse.reason">

  755. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">reason</span></span><a class="headerlink" href="#http.client.HTTPResponse.reason" title="Link to this definition">¶</a></dt>

  756. <dd><p>Reason phrase returned by server.</p>

  757. </dd></dl>

  758. 

  759. <dl class="py attribute">

  760. <dt class="sig sig-object py" id="http.client.HTTPResponse.debuglevel">

  761. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">debuglevel</span></span><a class="headerlink" href="#http.client.HTTPResponse.debuglevel" title="Link to this definition">¶</a></dt>

  762. <dd><p>A debugging hook.  If <a class="reference internal" href="#http.client.HTTPResponse.debuglevel" title="http.client.HTTPResponse.debuglevel"><code class="xref py py-attr docutils literal notranslate"><span class="pre">debuglevel</span></code></a> is greater than zero, messages

  763. will be printed to stdout as the response is read and parsed.</p>

  764. </dd></dl>

  765. 

  766. <dl class="py attribute">

  767. <dt class="sig sig-object py" id="http.client.HTTPResponse.closed">

  768. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">closed</span></span><a class="headerlink" href="#http.client.HTTPResponse.closed" title="Link to this definition">¶</a></dt>

  769. <dd><p>Is <code class="docutils literal notranslate"><span class="pre">True</span></code> if the stream is closed.</p>

  770. </dd></dl>

  771. 

  772. <dl class="py method">

  773. <dt class="sig sig-object py" id="http.client.HTTPResponse.geturl">

  774. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">geturl</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.geturl" title="Link to this definition">¶</a></dt>

  775. <dd><div class="deprecated">

  776. <p><span class="versionmodified deprecated">Deprecated since version 3.9: </span>Deprecated in favor of <a class="reference internal" href="#http.client.HTTPResponse.url" title="http.client.HTTPResponse.url"><code class="xref py py-attr docutils literal notranslate"><span class="pre">url</span></code></a>.</p>

  777. </div>

  778. </dd></dl>

  779. 

  780. <dl class="py method">

  781. <dt class="sig sig-object py" id="http.client.HTTPResponse.info">

  782. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.info" title="Link to this definition">¶</a></dt>

  783. <dd><div class="deprecated">

  784. <p><span class="versionmodified deprecated">Deprecated since version 3.9: </span>Deprecated in favor of <a class="reference internal" href="#http.client.HTTPResponse.headers" title="http.client.HTTPResponse.headers"><code class="xref py py-attr docutils literal notranslate"><span class="pre">headers</span></code></a>.</p>

  785. </div>

  786. </dd></dl>

  787. 

  788. <dl class="py method">

  789. <dt class="sig sig-object py" id="http.client.HTTPResponse.getcode">

  790. <span class="sig-prename descclassname"><span class="pre">HTTPResponse.</span></span><span class="sig-name descname"><span class="pre">getcode</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPResponse.getcode" title="Link to this definition">¶</a></dt>

  791. <dd><div class="deprecated">

  792. <p><span class="versionmodified deprecated">Deprecated since version 3.9: </span>Deprecated in favor of <a class="reference internal" href="#http.client.HTTPResponse.status" title="http.client.HTTPResponse.status"><code class="xref py py-attr docutils literal notranslate"><span class="pre">status</span></code></a>.</p>

  793. </div>

  794. </dd></dl>

  795. 

  796. </section>

  797. <section id="examples">

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

  799. <p>Here is an example session that uses the <code class="docutils literal notranslate"><span class="pre">GET</span></code> method:</p>

  800. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span>

  801. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPSConnection</span><span class="p">(</span><span class="s2">&quot;www.python.org&quot;</span><span class="p">)</span>

  802. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">)</span>

  803. <span class="gp">&gt;&gt;&gt; </span><span class="n">r1</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  804. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">r1</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">r1</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  805. <span class="go">200 OK</span>

  806. <span class="gp">&gt;&gt;&gt; </span><span class="n">data1</span> <span class="o">=</span> <span class="n">r1</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>  <span class="c1"># This will return entire content.</span>

  807. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># The following example demonstrates reading data in chunks.</span>

  808. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">)</span>

  809. <span class="gp">&gt;&gt;&gt; </span><span class="n">r1</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  810. <span class="gp">&gt;&gt;&gt; </span><span class="k">while</span> <span class="n">chunk</span> <span class="o">:=</span> <span class="n">r1</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">200</span><span class="p">):</span>

  811. <span class="gp">... </span>    <span class="nb">print</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="n">chunk</span><span class="p">))</span>

  812. <span class="go">b&#39;&lt;!doctype html&gt;\n&lt;!--[if&quot;...</span>

  813. <span class="go">...</span>

  814. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># Example of an invalid request</span>

  815. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPSConnection</span><span class="p">(</span><span class="s2">&quot;docs.python.org&quot;</span><span class="p">)</span>

  816. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="s2">&quot;/parrot.spam&quot;</span><span class="p">)</span>

  817. <span class="gp">&gt;&gt;&gt; </span><span class="n">r2</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  818. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">r2</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">r2</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  819. <span class="go">404 Not Found</span>

  820. <span class="gp">&gt;&gt;&gt; </span><span class="n">data2</span> <span class="o">=</span> <span class="n">r2</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  821. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  822. </pre></div>

  823. </div>

  824. <p>Here is an example session that uses the <code class="docutils literal notranslate"><span class="pre">HEAD</span></code> method.  Note that the

  825. <code class="docutils literal notranslate"><span class="pre">HEAD</span></code> method never returns any data.</p>

  826. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span>

  827. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPSConnection</span><span class="p">(</span><span class="s2">&quot;www.python.org&quot;</span><span class="p">)</span>

  828. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;HEAD&quot;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">)</span>

  829. <span class="gp">&gt;&gt;&gt; </span><span class="n">res</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  830. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">res</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">res</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  831. <span class="go">200 OK</span>

  832. <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  833. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>

  834. <span class="go">0</span>

  835. <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">==</span> <span class="sa">b</span><span class="s1">&#39;&#39;</span>

  836. <span class="go">True</span>

  837. </pre></div>

  838. </div>

  839. <p>Here is an example session that uses the <code class="docutils literal notranslate"><span class="pre">POST</span></code> method:</p>

  840. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span><span class="o">,</span> <span class="nn">urllib.parse</span>

  841. <span class="gp">&gt;&gt;&gt; </span><span class="n">params</span> <span class="o">=</span> <span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;@number&#39;</span><span class="p">:</span> <span class="mi">12524</span><span class="p">,</span> <span class="s1">&#39;@type&#39;</span><span class="p">:</span> <span class="s1">&#39;issue&#39;</span><span class="p">,</span> <span class="s1">&#39;@action&#39;</span><span class="p">:</span> <span class="s1">&#39;show&#39;</span><span class="p">})</span>

  842. <span class="gp">&gt;&gt;&gt; </span><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;application/x-www-form-urlencoded&quot;</span><span class="p">,</span>

  843. <span class="gp">... </span>           <span class="s2">&quot;Accept&quot;</span><span class="p">:</span> <span class="s2">&quot;text/plain&quot;</span><span class="p">}</span>

  844. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s2">&quot;bugs.python.org&quot;</span><span class="p">)</span>

  845. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;POST&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">params</span><span class="p">,</span> <span class="n">headers</span><span class="p">)</span>

  846. <span class="gp">&gt;&gt;&gt; </span><span class="n">response</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  847. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  848. <span class="go">302 Found</span>

  849. <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>

  850. <span class="gp">&gt;&gt;&gt; </span><span class="n">data</span>

  851. <span class="go">b&#39;Redirecting to &lt;a href=&quot;https://bugs.python.org/issue12524&quot;&gt;https://bugs.python.org/issue12524&lt;/a&gt;&#39;</span>

  852. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>

  853. </pre></div>

  854. </div>

  855. <p>Client side HTTP <code class="docutils literal notranslate"><span class="pre">PUT</span></code> requests are very similar to <code class="docutils literal notranslate"><span class="pre">POST</span></code> requests. The

  856. difference lies only on the server side where HTTP servers will allow resources to

  857. be created via <code class="docutils literal notranslate"><span class="pre">PUT</span></code> requests. It should be noted that custom HTTP methods

  858. are also handled in <a class="reference internal" href="urllib.request.html#urllib.request.Request" title="urllib.request.Request"><code class="xref py py-class docutils literal notranslate"><span class="pre">urllib.request.Request</span></code></a> by setting the appropriate

  859. method attribute. Here is an example session that uses the <code class="docutils literal notranslate"><span class="pre">PUT</span></code> method:</p>

  860. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="c1"># This creates an HTTP request</span>

  861. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># with the content of BODY as the enclosed representation</span>

  862. <span class="gp">&gt;&gt;&gt; </span><span class="c1"># for the resource http://localhost:8080/file</span>

  863. <span class="gp">...</span>

  864. <span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">http.client</span>

  865. <span class="gp">&gt;&gt;&gt; </span><span class="n">BODY</span> <span class="o">=</span> <span class="s2">&quot;***filecontents***&quot;</span>

  866. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span> <span class="o">=</span> <span class="n">http</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">HTTPConnection</span><span class="p">(</span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span> <span class="mi">8080</span><span class="p">)</span>

  867. <span class="gp">&gt;&gt;&gt; </span><span class="n">conn</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s2">&quot;PUT&quot;</span><span class="p">,</span> <span class="s2">&quot;/file&quot;</span><span class="p">,</span> <span class="n">BODY</span><span class="p">)</span>

  868. <span class="gp">&gt;&gt;&gt; </span><span class="n">response</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">getresponse</span><span class="p">()</span>

  869. <span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">status</span><span class="p">,</span> <span class="n">response</span><span class="o">.</span><span class="n">reason</span><span class="p">)</span>

  870. <span class="go">200, OK</span>

  871. </pre></div>

  872. </div>

  873. </section>

  874. <section id="httpmessage-objects">

  875. <span id="id3"></span><h2>HTTPMessage Objects<a class="headerlink" href="#httpmessage-objects" title="Link to this heading">¶</a></h2>

  876. <dl class="py class">

  877. <dt class="sig sig-object py" id="http.client.HTTPMessage">

  878. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">http.client.</span></span><span class="sig-name descname"><span class="pre">HTTPMessage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">email.message.Message</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#http.client.HTTPMessage" title="Link to this definition">¶</a></dt>

  879. <dd></dd></dl>

  880. 

  881. <p>An <a class="reference internal" href="#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> instance holds the headers from an HTTP

  882. response.  It is implemented using the <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> class.</p>

  883. </section>

  884. </section>

  885. 

  886. 

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

  888.           </div>

  889.         </div>

  890.       </div>

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

  892.         <div class="sphinxsidebarwrapper">

  893.   <div>

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

  895.     <ul>

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

  897. <li><a class="reference internal" href="#httpconnection-objects">HTTPConnection Objects</a></li>

  898. <li><a class="reference internal" href="#httpresponse-objects">HTTPResponse Objects</a></li>

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

  900. <li><a class="reference internal" href="#httpmessage-objects">HTTPMessage Objects</a></li>

  901. </ul>

  902. </li>

  903. </ul>

  904. 

  905.   </div>

  906.   <div>

  907.     <h4>Previous topic</h4>

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

  909.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">http</span></code> — HTTP modules</a></p>

  910.   </div>

  911.   <div>

  912.     <h4>Next topic</h4>

  913.     <p class="topless"><a href="ftplib.html"

  914.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ftplib</span></code> — FTP protocol client</a></p>

  915.   </div>

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

  917.     <h3>This Page</h3>

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

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

  920.       <li>

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

  922.             rel="nofollow">Show Source

  923.         </a>

  924.       </li>

  925.     </ul>

  926.   </div>

  927.         </div>

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

  929. <span>«</span>

  930. </div>

  931. 

  932.       </div>

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

  934.     </div>  

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

  936.       <h3>Navigation</h3>

  937.       <ul>

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

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

  940.              >index</a></li>

  941.         <li class="right" >

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

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

  944.         <li class="right" >

  945.           <a href="ftplib.html" title="ftplib — FTP protocol client"

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

  947.         <li class="right" >

  948.           <a href="http.html" title="http — HTTP modules"

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

  950. 

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

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

  953.           <li class="switchers">

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

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

  956.           </li>

  957.           <li>

  958.               

  959.           </li>

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

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

  962.     </li>

  963. 

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

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

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

  967.                 <li class="right">

  968.                     

  969. 

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

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

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

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

  974.         </form>

  975.     </div>

  976.                      |

  977.                 </li>

  978.             <li class="right">

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

  980.     Theme

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

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

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

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

  985.     </select>

  986. </label> |</li>

  987.             

  988.       </ul>

  989.     </div>  

  990.     <div class="footer">

  991.     &copy; 

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

  993.     

  994.     Copyright

  995.     

  996.       </a>

  997.      2001-2024, Python Software Foundation.

  998.     <br />

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

  1000.     <br />

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

  1002.     <br />

  1003.     

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

  1005.     

  1006.     

  1007.     <br />

  1008. 

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

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

  1011. <br />

  1012.     <br />

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

  1014.     

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

  1016.     

  1017.     <br />

  1018. 

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

  1020.     </div>

  1021. 

  1022.   </body>

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