commit 5ccd260911e2db802fa97498ae92558fac8c8057
author Martin Carroll <martin.carroll@nokia.com> Sat Sep 03 01:03:00 2016 -0400
committer Alex Yu <stinky2nine@users.noreply.github.com> Sat Sep 03 01:03:00 2016 -0400
tree 244dcdcd26db034164a41f67a6ad96b391c5143f
parent 8dd5057d9d8aeccda08f18a63a8b6caec0db2f8a

NEW: Add proxy_headers argument to ProxyInfo constructor. (#21)

This argument lets the user add to or override the headers in the
HTTP CONNECT request sent to the proxy.  Some proxy servers need
additional arguments that are not provided by default by httplib2.
Note that although this commit makes this enhancement for both the
python2 and python3 versions of this library, the python3 version
does not implement ProxyInfo at all (and never has).

Signed-off-by: Martin Carroll <martin.carroll@nokia-bell-labs.com>

python3/httplib2/__init__.py

diff --git a/python3/httplib2/__init__.py b/python3/httplib2/__init__.py
index f666c70..b78df67 100644
--- a/python3/httplib2/__init__.py
+++ b/python3/httplib2/__init__.py
@@ -719,7 +719,7 @@
 
 class ProxyInfo(object):
   """Collect information required to use a proxy."""
-  def __init__(self, proxy_type, proxy_host, proxy_port, proxy_rdns=True, proxy_user=None, proxy_pass=None):
+  def __init__(self, proxy_type, proxy_host, proxy_port, proxy_rdns=True, proxy_user=None, proxy_pass=None, proxy_headers=None):
       """
         Args:
           proxy_type: The type of proxy server.  This must be set to one of
@@ -740,12 +740,14 @@
           proxy_user: The username used to authenticate with the proxy server.
 
           proxy_pass: The password used to authenticate with the proxy server.
+
+          proxy_headers: Additional or modified headers for the proxy connect request.
       """
-      self.proxy_type, self.proxy_host, self.proxy_port, self.proxy_rdns, self.proxy_user, self.proxy_pass = proxy_type, proxy_host, proxy_port, proxy_rdns, proxy_user, proxy_pass
+      self.proxy_type, self.proxy_host, self.proxy_port, self.proxy_rdns, self.proxy_user, self.proxy_pass, self.proxy_headers = proxy_type, proxy_host, proxy_port, proxy_rdns, proxy_user, proxy_pass, proxy_headers
 
   def astuple(self):
     return (self.proxy_type, self.proxy_host, self.proxy_port, self.proxy_rdns,
-            self.proxy_user, self.proxy_pass)
+            self.proxy_user, self.proxy_pass, self.proxy_headers)
 
   def isgood(self):
     return socks and (self.proxy_host != None) and (self.proxy_port != None)
@@ -798,6 +800,7 @@
         proxy_port = port,
         proxy_user = username or None,
         proxy_pass = password or None,
+        proxy_headers = None,
     )
 
 
@@ -815,6 +818,7 @@
     def __init__(self, host, port=None, timeout=None, proxy_info=None):
         http.client.HTTPConnection.__init__(self, host, port=port,
                                             timeout=timeout)
+        # TODO: implement proxy_info
         self.proxy_info = proxy_info
 
 
@@ -831,6 +835,7 @@
     def __init__(self, host, port=None, key_file=None, cert_file=None,
                  timeout=None, proxy_info=None,
                  ca_certs=None, disable_ssl_certificate_validation=False):
+        # TODO: implement proxy_info
         self.proxy_info = proxy_info
         context = None
         if ca_certs is None:

python3/httplib2test.py

diff --git a/python3/httplib2test.py b/python3/httplib2test.py
index 246956a..a0dca80 100755
--- a/python3/httplib2test.py
+++ b/python3/httplib2test.py
@@ -1625,6 +1625,10 @@
         pi = httplib2.proxy_info_from_environment()

         self.assertEqual(pi, None)

 

+    def test_proxy_headers(self):

+        headers = {'key0': 'val0', 'key1': 'val1'}

+        pi = httplib2.ProxyInfo(httplib2.socks.PROXY_TYPE_HTTP, 'localhost', 1234, proxy_headers = headers)

+        self.assertEqual(pi.proxy_headers, headers)

 

 if __name__ == '__main__':

     unittest.main()