Skip to main content

SOCKS proxy connector for aiohttp

Project description

aiohttp-socks

Build Status Coverage Status PyPI version

SOCKS proxy connector for aiohttp. SOCKS4(a) and SOCKS5 are supported.

Requirements

  • Python >= 3.5.3
  • aiohttp >= 2.3.2 # including v3.x

Installation

pip install aiohttp_socks

Usage

aiohttp usage:

import aiohttp
from aiohttp_socks import SocksConnector, SocksVer


async def fetch(url):
    connector = SocksConnector.from_url('socks5://user:password@127.0.0.1:1080')
    ### or use SocksConnector constructor
    # connector = SocksConnector(
    #     socks_ver=SocksVer.SOCKS5,
    #     host='127.0.0.1',
    #     port=1080,
    #     username='user',
    #     password='password',
    #     rdns=True
    # )
    async with aiohttp.ClientSession(connector=connector) as session:
        async with session.get(url) as response:
            return await response.text()

aiohttp-socks also provides open_connection and create_connection functions:

from aiohttp_socks import open_connection

async def fetch():
    reader, writer = await open_connection(
        socks_url='socks5://user:password@127.0.0.1:1080',
        host='check-host.net',
        port=80
    )
    request = (b"GET /ip HTTP/1.1\r\n"
               b"Host: check-host.net\r\n"
               b"Connection: close\r\n\r\n")

    writer.write(request)
    return await reader.read(-1)

Why yet another SOCKS connector for aiohttp

Unlike aiosocksy, aiohttp_socks has only single point of integration with aiohttp. This makes it easier to maintain compatibility with new aiohttp versions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiohttp-socks, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size aiohttp_socks-0.2.2-py3-none-any.whl (11.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size aiohttp_socks-0.2.2.tar.gz (10.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page