Document the headers parameter for set_tunnel.

This commit is contained in:
Senthil Kumaran 2009-12-20 07:29:31 +00:00
parent 7713acf201
commit 0732fd952b
1 changed files with 4 additions and 1 deletions

View File

@ -428,11 +428,14 @@ HTTPConnection Objects
debug level is ``0``, meaning no debugging output is printed. debug level is ``0``, meaning no debugging output is printed.
.. method:: HTTPConnection.set_tunnel(host,port=None) .. method:: HTTPConnection.set_tunnel(host,port=None, headers=None)
Set the host and the port for HTTP Connect Tunnelling. Normally used when Set the host and the port for HTTP Connect Tunnelling. Normally used when
it is required to do HTTPS Conection through a proxy server. it is required to do HTTPS Conection through a proxy server.
The headers argument should be a mapping of extra HTTP headers to to sent
with the CONNECT request.
.. versionadded:: 2.7 .. versionadded:: 2.7