Skip to main content

An asyncio-compatible socket pool

Project description

Circle CI Black Code Style

aiosocketpool

An asyncio-compatible socket pool. Simple, compact, easily extended.

If your application needs to connect to many remote hosts simultaneously (and often), it probably makes sense to keep connections open and re-use them rather than establishing a new connection for every request. Combining an asyncio event loop and a socket pool might be the way to go!

Based on socketpool.

Requires Python 3.7 or above.

Examples

Run a simple TCP echo server in a background thread, using the asyncio library.

import asyncio
import threading


# start a new event loop running in a background thread
def run_loop_forever(loop):
    loop.run_forever()


loop = asyncio.new_event_loop()

t = threading.Thread(name="BackgroundEventLoop", target=run_loop_forever, args=[loop], daemon=True)
t.start()


# run a tcp echo server using asyncio in the background event loop
async def echo_handler(reader, writer):
    writer.write(await reader.read(32))
    await writer.drain()
    writer.close()


async def echo_server(tcp_port):
    server = await asyncio.start_server(echo_handler, "127.0.0.1", tcp_port)
    await server.serve_forever()


asyncio.run_coroutine_threadsafe(echo_server(12345), loop)

Create a new TCP connection pool in the main thread, get a connection, and send and receive data.

from aiosocketpool import AsyncConnectionPool, AsyncTcpConnector


pool = AsyncConnectionPool(
    factory=AsyncTcpConnector,
    reap_connections=True,  # a background task will destroy old and idle connections
    max_lifetime=10,  # connections will remain idle at most 10 seconds
    max_size=10,  # we will maintain at most 10 idle connections in the pool
)


async def hello_world():
    async with pool.connection(host="127.0.0.1", port=12345) as conn:
        await conn.sendall(b"hello world")
        print(await conn.recv(32))


await hello_world()

Create a bunch of connections and run them all concurrently.

loop = asyncio.get_event_loop()

tasks = []

for _ in range(25):
    tasks.append(loop.create_task(hello_world()))

loop.run_until_complete(asyncio.gather(*tasks))

Project details


Download files

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

Source Distribution

aiosocketpool-0.0.3.tar.gz (7.4 kB view details)

Uploaded Source

File details

Details for the file aiosocketpool-0.0.3.tar.gz.

File metadata

  • Download URL: aiosocketpool-0.0.3.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.2

File hashes

Hashes for aiosocketpool-0.0.3.tar.gz
Algorithm Hash digest
SHA256 8e649108f63001679ddea7158909e6fe755403b39755f3587edc0293f0ff07ba
MD5 aeeb289130397cbd97c0e6c7253106e9
BLAKE2b-256 879f283017b10f99afe095f0a103adc8c8b82bcc46d58f82023b4ec22bafe54a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page