Document the headers parameter for set_tunnel.

This commit is contained in:
Senthil Kumaran 2009-12-20 07:31:21 +00:00
parent 47fff87027
commit 7e5229c3ab
1 changed files with 4 additions and 1 deletions

View File

@ -386,11 +386,14 @@ HTTPConnection Objects
.. versionadded:: 3.1
.. 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 it
is required to a HTTPS Connection through a proxy server.
The headers argument should be a mapping of extra HTTP headers to to sent
with the CONNECT request.
.. versionadded:: 3.2
.. method:: HTTPConnection.connect()