Copy of #2582, Added proxy parameters for ClientSession

CHANGES/2580.feature

@@ -0,0 +1 @@
+Added proxy parameters for ClientSession.

CONTRIBUTORS.txt

@@ -91,6 +91,7 @@ Eugene Chernyshov
 Eugene Naydenov
 Eugene Tolmachev
 Evert Lammerts
+Fan Yu
 FichteFoll
 Frederik Gladhorn
 Frederik Peter Aalund
@@ -192,6 +193,7 @@ Pepe Osca
 Philipp A.
 Pieter van Beek
 Rafael Viotti
+Ratan Kulshreshtha
 Raúl Cumplido
 Required Field
 Robert Lu
@@ -262,4 +264,4 @@ Yuriy Shatrov
 Yury Selivanov
 Yusuke Tsutsumi
 Марк Коренберг
-Семён Марьясин
+Семён Марьясин

aiohttp/client.py

@@ -172,7 +172,8 @@ class ClientSession:
         '_timeout', '_raise_for_status', '_auto_decompress',
         '_trust_env', '_default_headers', '_skip_auto_headers',
         '_request_class', '_response_class',
-        '_ws_response_class', '_trace_configs')
+        '_ws_response_class', '_trace_configs', '_session_proxy',
+        '_session_proxy_auth', '_session_proxy_headers')
 
     def __init__(self, *, connector: Optional[BaseConnector]=None,
                  loop: Optional[asyncio.AbstractEventLoop]=None,
@@ -194,7 +195,10 @@ def __init__(self, *, connector: Optional[BaseConnector]=None,
                  auto_decompress: bool=True,
                  trust_env: bool=False,
                  requote_redirect_url: bool=True,
-                 trace_configs: Optional[List[TraceConfig]]=None) -> None:
+                 trace_configs: Optional[List[TraceConfig]]=None,
+                 proxy: Optional[StrOrURL]=None,
+                 proxy_auth: Optional[BasicAuth]=None,
+                 proxy_headers: Optional[LooseHeaders]=None) -> None:
 
         if loop is None:
             if connector is not None:
@@ -259,6 +263,10 @@ def __init__(self, *, connector: Optional[BaseConnector]=None,
         self._trust_env = trust_env
         self._requote_redirect_url = requote_redirect_url
 
+        self._session_proxy = proxy
+        self._session_proxy_auth = proxy_auth
+        self._session_proxy_headers = proxy_headers
+
         # Convert to list of tuples
         if headers:
             headers = CIMultiDict(headers)
@@ -372,12 +380,22 @@ async def _request(
             for i in skip_auto_headers:
                 skip_headers.add(istr(i))
 
-        if proxy is not None:
+        if proxy is not None and self._session_proxy is None:
             try:
                 proxy = URL(proxy)
             except ValueError:
                 raise InvalidURL(proxy)
 
+        if proxy is None and self._session_proxy is not None:
+            try:
+                proxy = self._session_proxy
+                proxy_auth = self._session_proxy_auth
+                proxy_headers = self._prepare_headers(
+                    self._session_proxy_headers
+                )
+            except ValueError:
+                raise InvalidURL(proxy)
+
         if timeout is sentinel:
             real_timeout = self._timeout  # type: ClientTimeout
         else:

docs/client_reference.rst

@@ -49,7 +49,10 @@ The client session supports the context manager protocol for self closing.
                          auto_decompress=True, \
                          requote_redirect_url=False, \
                          trust_env=False, \
-                         trace_configs=None)
+                         trace_configs=None, \
+                         proxy=None, \
+                         proxy_auth=None, \
+                         proxy_headers=None)
 
    The class for creating client sessions and making requests.
 
@@ -188,6 +191,12 @@ The client session supports the context manager protocol for self closing.
                          disabling.  See :ref:`aiohttp-client-tracing-reference` for
                          more information.
 
+   :param proxy: Proxy url that you want to use with the session.
+
+   :param proxy_auth: Authentication credentials for proxy url that you want to use with the session.
+
+   :param proxy_headers: Proxy headers that you want to use with the session.
+
    .. attribute:: closed
 
       ``True`` if the session has been closed, ``False`` otherwise.

tests/test_proxy_session.py

@@ -0,0 +1,120 @@
+from unittest import mock
+
+import pytest
+
+import aiohttp
+from aiohttp import web
+
+
+@pytest.fixture
+def proxy_test_server(aiohttp_raw_server, loop, monkeypatch):
+    """Handle all proxy requests and imitate remote server response."""
+
+    _patch_ssl_transport(monkeypatch)
+
+    default_response = {'status': 200, 'headers': None, 'body': None}
+
+    proxy_mock = mock.Mock()
+
+    async def proxy_handler(request):
+        proxy_mock.request = request
+        proxy_mock.requests_list.append(request)
+
+        response = default_response.copy()
+        if isinstance(proxy_mock.return_value, dict):
+            response.update(proxy_mock.return_value)
+
+        headers = response['headers']
+        if not headers:
+            headers = {}
+
+        if request.method == 'CONNECT':
+            response['body'] = None
+
+        response['headers'] = headers
+
+        resp = web.Response(**response)
+        await resp.prepare(request)
+        await resp.write_eof()
+        return resp
+
+    async def proxy_server():
+        proxy_mock.request = None
+        proxy_mock.auth = None
+        proxy_mock.requests_list = []
+
+        server = await aiohttp_raw_server(proxy_handler)
+
+        proxy_mock.server = server
+        proxy_mock.url = server.make_url('/')
+
+        return proxy_mock
+
+    return proxy_server
+
+
+@pytest.fixture()
+def get_request(loop):
+    async def _request(method='GET', *, url, trust_env=False, **kwargs):
+        connector = aiohttp.TCPConnector(verify_ssl=False, loop=loop)
+        client = aiohttp.ClientSession(connector=connector,
+                                       trust_env=trust_env)
+        try:
+            resp = await client.request(method, url, **kwargs)
+            await resp.release()
+            return resp
+        finally:
+            await client.close()
+    return _request
+
+
+def _patch_ssl_transport(monkeypatch) -> None:
+    """Make ssl transport substitution to prevent ssl handshake."""
+    def _make_ssl_transport_dummy(self, rawsock, protocol, sslcontext,
+                                  waiter=None, **kwargs):
+        return self._make_socket_transport(rawsock, protocol, waiter,
+                                           extra=kwargs.get('extra'),
+                                           server=kwargs.get('server'))
+
+    monkeypatch.setattr(
+        "asyncio.selector_events.BaseSelectorEventLoop._make_ssl_transport",
+        _make_ssl_transport_dummy)
+
+
+async def test_session_proxy_http(proxy_test_server, loop) -> None:
+    url = 'http://aiohttp.io/path'
+    proxy = await proxy_test_server()
+    proxy.return_value = dict(body=b'test')
+
+    conn = aiohttp.TCPConnector(loop=loop)
+    sess = aiohttp.ClientSession(connector=conn, loop=loop, proxy=proxy.url)
+
+    resp = await sess.get(url)
+    assert (await resp.read()) == b'test'
+
+
+async def test_session_proxy_http_auth(proxy_test_server, loop) -> None:
+    url = 'http://aiohttp.io/path'
+    proxy = await proxy_test_server()
+
+    conn = aiohttp.TCPConnector(loop=loop)
+    sess = aiohttp.ClientSession(connector=conn, loop=loop, proxy=proxy.url)
+    await sess.get(url)
+    assert 'Authorization' not in proxy.request.headers
+    assert 'Proxy-Authorization' not in proxy.request.headers
+
+    conn = aiohttp.TCPConnector(loop=loop)
+    auth = aiohttp.BasicAuth('user', 'pass')
+    sess = aiohttp.ClientSession(connector=conn, loop=loop,
+                                 proxy_auth=auth, proxy=proxy.url)
+    await sess.get(url)
+    assert 'Authorization' not in proxy.request.headers
+    assert 'Proxy-Authorization' in proxy.request.headers
+
+    conn = aiohttp.TCPConnector(loop=loop)
+    auth = aiohttp.BasicAuth('user', 'pass')
+    sess = aiohttp.ClientSession(connector=conn, loop=loop,
+                                 auth=auth, proxy_auth=auth, proxy=proxy.url)
+    await sess.get(url)
+    assert 'Authorization' in proxy.request.headers
+    assert 'Proxy-Authorization' in proxy.request.headers