[Python-checkins] r77264 - in python/trunk: Doc/library/httplib.rst Doc/library/socket.rst Lib/httplib.py Lib/test/test_httplib.py Misc/NEWS
gregory.p.smith
python-checkins at python.org
Sun Jan 3 03:06:07 CET 2010
Author: gregory.p.smith
Date: Sun Jan 3 03:06:07 2010
New Revision: 77264
Log:
issue3972: HTTPConnection and HTTPSConnection now support a
source_address parameter.
Also cleans up an annotation in the socket documentation.
Modified:
python/trunk/Doc/library/httplib.rst
python/trunk/Doc/library/socket.rst
python/trunk/Lib/httplib.py
python/trunk/Lib/test/test_httplib.py
python/trunk/Misc/NEWS
Modified: python/trunk/Doc/library/httplib.rst
==============================================================================
--- python/trunk/Doc/library/httplib.rst (original)
+++ python/trunk/Doc/library/httplib.rst Sun Jan 3 03:06:07 2010
@@ -34,7 +34,7 @@
The module provides the following classes:
-.. class:: HTTPConnection(host[, port[, strict[, timeout]]])
+.. class:: HTTPConnection(host[, port[, strict[, timeout[, source_address]]]])
An :class:`HTTPConnection` instance represents one transaction with an HTTP
server. It should be instantiated passing it a host and optional port
@@ -46,6 +46,8 @@
status line. If the optional *timeout* parameter is given, blocking
operations (like connection attempts) will timeout after that many seconds
(if it is not given, the global default timeout setting is used).
+ The optional *source_address* parameter may be a tuple of a (host, port)
+ to use as the source address the HTTP connection is made from.
For example, the following calls all create instances that connect to the server
at the same host and port::
@@ -60,8 +62,11 @@
.. versionchanged:: 2.6
*timeout* was added.
+ .. versionchanged:: 2.7
+ *source_address* was added.
-.. class:: HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout]]]]])
+
+.. class:: HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout[, source_address]]]]]])
A subclass of :class:`HTTPConnection` that uses SSL for communication with
secure servers. Default port is ``443``. *key_file* is the name of a PEM
@@ -77,6 +82,9 @@
.. versionchanged:: 2.6
*timeout* was added.
+ .. versionchanged:: 2.7
+ *source_address* was added.
+
.. class:: HTTPResponse(sock[, debuglevel=0][, strict=0])
Modified: python/trunk/Doc/library/socket.rst
==============================================================================
--- python/trunk/Doc/library/socket.rst (original)
+++ python/trunk/Doc/library/socket.rst Sun Jan 3 03:06:07 2010
@@ -213,13 +213,14 @@
*timeout* is supplied, the global default timeout setting returned by
:func:`getdefaulttimeout` is used.
- .. versionadded:: 2.6
-
If supplied, *source_address* must be a 2-tuple ``(host, port)`` for the
socket to bind to as its source address before connecting. If host or port
are '' or 0 respectively the OS default behavior will be used.
- .. versionadded:: 2.7
+ .. versionadded:: 2.6
+
+ .. versionchanged:: 2.7
+ *source_address* was added.
.. function:: getaddrinfo(host, port[, family[, socktype[, proto[, flags]]]])
Modified: python/trunk/Lib/httplib.py
==============================================================================
--- python/trunk/Lib/httplib.py (original)
+++ python/trunk/Lib/httplib.py Sun Jan 3 03:06:07 2010
@@ -658,8 +658,9 @@
strict = 0
def __init__(self, host, port=None, strict=None,
- timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
+ timeout=socket._GLOBAL_DEFAULT_TIMEOUT, source_address=None):
self.timeout = timeout
+ self.source_address = source_address
self.sock = None
self._buffer = []
self.__response = None
@@ -728,7 +729,7 @@
def connect(self):
"""Connect to the host and port specified in __init__."""
self.sock = socket.create_connection((self.host,self.port),
- self.timeout)
+ self.timeout, self.source_address)
if self._tunnel_host:
self._tunnel()
@@ -1133,15 +1134,18 @@
default_port = HTTPS_PORT
def __init__(self, host, port=None, key_file=None, cert_file=None,
- strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT):
- HTTPConnection.__init__(self, host, port, strict, timeout)
+ strict=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT,
+ source_address=None):
+ HTTPConnection.__init__(self, host, port, strict, timeout,
+ source_address)
self.key_file = key_file
self.cert_file = cert_file
def connect(self):
"Connect to a host on a given (SSL) port."
- sock = socket.create_connection((self.host, self.port), self.timeout)
+ sock = socket.create_connection((self.host, self.port),
+ self.timeout, self.source_address)
if self._tunnel_host:
self.sock = sock
self._tunnel()
Modified: python/trunk/Lib/test/test_httplib.py
==============================================================================
--- python/trunk/Lib/test/test_httplib.py (original)
+++ python/trunk/Lib/test/test_httplib.py Sun Jan 3 03:06:07 2010
@@ -3,7 +3,8 @@
import StringIO
import socket
-from unittest import TestCase
+import unittest
+TestCase = unittest.TestCase
from test import test_support
@@ -237,6 +238,38 @@
def test_responses(self):
self.assertEquals(httplib.responses[httplib.NOT_FOUND], "Not Found")
+
+class SourceAddressTest(TestCase):
+ def setUp(self):
+ self.serv = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+ self.port = test_support.bind_port(self.serv)
+ self.source_port = test_support.find_unused_port()
+ self.serv.listen(5)
+ self.conn = None
+
+ def tearDown(self):
+ if self.conn:
+ self.conn.close()
+ self.conn = None
+ self.serv.close()
+ self.serv = None
+
+ def testHTTPConnectionSourceAddress(self):
+ self.conn = httplib.HTTPConnection(HOST, self.port,
+ source_address=('', self.source_port))
+ self.conn.connect()
+ self.assertEqual(self.conn.sock.getsockname()[1], self.source_port)
+
+ @unittest.skipIf(not hasattr(httplib, 'HTTPSConnection'),
+ 'httplib.HTTPSConnection not defined')
+ def testHTTPSConnectionSourceAddress(self):
+ self.conn = httplib.HTTPSConnection(HOST, self.port,
+ source_address=('', self.source_port))
+ # We don't test anything here other the constructor not barfing as
+ # this code doesn't deal with setting up an active running SSL server
+ # for an ssl_wrapped connect() to actually return from.
+
+
class TimeoutTest(TestCase):
PORT = None
@@ -294,7 +327,7 @@
def test_main(verbose=None):
test_support.run_unittest(HeaderTests, OfflineTest, BasicTest, TimeoutTest,
- HTTPSTimeoutTest)
+ HTTPSTimeoutTest, SourceAddressTest)
if __name__ == '__main__':
test_main()
Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS (original)
+++ python/trunk/Misc/NEWS Sun Jan 3 03:06:07 2010
@@ -62,6 +62,9 @@
Library
-------
+_ Issue #3972: httplib.HTTPConnection now accepts an optional source_address
+ parameter to allow specifying where your connections come from.
+
- socket.create_connection now accepts an optional source_address parameter.
- Issue #5511: now zipfile.ZipFile can be used as a context manager.
More information about the Python-checkins
mailing list