traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

improve set_tunnel docs (closes #11448) 

Patch by Ryan Kelly, karl, and Nikolaus Rath.
This commit is contained in:
Benjamin Peterson 2014-03-16 15:55:39 -05:00
parent fda33559dc
commit a48d9eaa5c
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Doc/library/http.client.rst
View File

@ -451,11 +451,25 @@ HTTPConnection Objects
.. method:: HTTPConnection.set_tunnel(host, port=None, headers=None)
Set the host and the port for HTTP Connect Tunnelling. Normally used when it
is required to a HTTPS Connection through a proxy server.
Set the host and the port for HTTP Connect Tunnelling. This allows running
the connection through a proxy server.
The headers argument should be a mapping of extra HTTP headers to send
with the CONNECT request.
The host and port arguments specify the endpoint of the tunneled connection
(i.e. the address included in the CONNECT request, *not* the address of the
proxy server).
The headers argument should be a mapping of extra HTTP headers to send with
the CONNECT request.
For example, to tunnel through a HTTPS proxy server running locally on port
8080, we would pass the address of the proxy to the :class:`HTTPSConnection`
constructor, and the address of the host that we eventually want to reach to
the :meth:`~HTTPConnection.set_tunnel` method::
>>> import http.client
>>> conn = http.client.HTTPSConnection("localhost", 8080)
>>> conn.set_tunnel("www.python.org")
>>> conn.request("HEAD","/index.html")
.. versionadded:: 3.2