From 7cdecf9bfe5ef0c960b782493c8e5cad6b5fa552 Mon Sep 17 00:00:00 2001 From: nibrag Date: Fri, 17 Jun 2016 22:22:02 +0300 Subject: [PATCH] Added more info about proxy_connector --- README.rst | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 599a570..ee989f5 100644 --- a/README.rst +++ b/README.rst @@ -137,7 +137,7 @@ aiohttp usage import aiohttp import aiosocks from aiosocks.connector import ( - SocksConnector, proxy_connector, HttpProxyAddr, HttpProxyAuth + SocksConnector, HttpProxyAddr, HttpProxyAuth ) @@ -151,16 +151,6 @@ aiohttp usage # or locale resolve conn = SocksConnector(proxy=addr, proxy_auth=auth, remote_resolve=False) - # or use shortcut function for automatically create - # SocksConnector/aiohttp.ProxyConnector (socks or http proxy) - conn = proxy_connector(aiosocks.SocksAddr(...), - remote_resolve=True, verify_ssl=False) - # return SocksConnector - - conn = proxy_connector(HttpProxyAddr('http://proxy'), - HttpProxyAuth('login', 'pwd')) - # return aiohttp.ProxyConnector (http proxy connector) - try: with aiohttp.ClientSession(connector=conn) as ses: async with session.get('http://github.com/') as resp: @@ -176,3 +166,26 @@ aiohttp usage loop = asyncio.get_event_loop() loop.run_until_complete(load_github_main()) loop.close() + +proxy_connector +^^^^^^^^^^^^^^^ +A unified method to create `connector`. + +.. code-block:: python + + import asyncio + import aiohttp + import aiosocks + from aiosocks.connector import ( + proxy_connector, HttpProxyAddr, HttpProxyAuth + ) + + # make SocksConnector + conn = proxy_connector(aiosocks.Socks5Addr(...), + remote_resolve=True, verify_ssl=False) + # return SocksConnector instance + + # make aiohttp.ProxyConnector (http proxy) + conn = proxy_connector(HttpProxyAddr('http://proxy'), + HttpProxyAuth('login', 'pwd'), verify_ssl=True) + # return aiohttp.ProxyConnector instance