Skip to content

Latest commit

 

History

History
161 lines (117 loc) · 4.36 KB

README.md

File metadata and controls

161 lines (117 loc) · 4.36 KB
Raw

github status Coverage Status PyPI version Documentation Status Discord

aiosonic - lightweight Python asyncio http client

Very fast, lightweight Python asyncio http client

Here is some documentation.

There is a performance script in tests folder which shows very nice numbers

» python tests/performance.py
doing tests...
{
 "aiosonic": "1000 requests in 105.53 ms",
 "aiosonic cyclic": "1000 requests in 104.08 ms",
 "aiohttp": "1000 requests in 184.51 ms",
 "requests": "1000 requests in 1644.21 ms"
}
aiosonic is 74.84% faster than aiohttp
aiosonic is 1457.99% faster than requests
aiosonic is -1.38% faster than aiosonic cyclic

This is a very basic, dummy test, machine dependant. If you look for performance, test and compare your code with this and other packages like aiohttp.

You can perform this test by installing all test dependencies with pip install -e ".[test]" and doing python tests/performance.py in your own machine

Requirements:

  • Python>=3.8
  • PyPy>=3.8

Features:

  • Keepalive and smart pool of connections
  • Multipart File Uploads
  • Chunked responses handling
  • Chunked requests
  • Connection Timeouts
  • Automatic Decompression
  • Follow Redirects
  • Fully type annotated.
  • 100% test coverage (Sometimes not).
  • HTTP2 (BETA) when using the correct flag

Installation

pip install aiosonic

Usage

import asyncio
import aiosonic
import json


async def run():
    client = aiosonic.HTTPClient()

    # ##################
    # Sample get request
    # ##################
    response = await client.get('https://www.google.com/')
    assert response.status_code == 200
    assert 'Google' in (await response.text())

    # ##################
    # Post data as multipart form
    # ##################
    url = "https://postman-echo.com/post"
    posted_data = {'foo': 'bar'}
    response = await client.post(url, data=posted_data)

    assert response.status_code == 200
    data = json.loads(await response.content())
    assert data['form'] == posted_data

    # ##################
    # Posted as json
    # ##################
    response = await client.post(url, json=posted_data)

    assert response.status_code == 200
    data = json.loads(await response.content())
    assert data['json'] == posted_data

    # ##################
    # Sample request + timeout
    # ##################
    from aiosonic.timeout import Timeouts
    timeouts = Timeouts(
        sock_read=10,
        sock_connect=3
    )
    response = await client.get('https://www.google.com/', timeouts=timeouts)
    assert response.status_code == 200
    assert 'Google' in (await response.text())

    print('success')


if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(run())

TODO'S

  • HTTP2
    • Get
    • Request with data sending
    • Do a aiosonic release with stable http2
  • Better documentation
  • International Domains and URLs (idna + cache)
  • Basic/Digest Authentication
  • Requests using a http proxy
  • Sessions with Cookie Persistence
  • Elegant Key/Value Cookies

Development

Install packages with poetry

Reference: https://python-poetry.org/docs/

poetry install

It is advised that you should install poetry in a serparate virtualenv (I suggest to install it with apt/pacman/etc.), other than the one you may use for development in aiosonic.

I do configure poetry with poetry config virtualenvs.in-project true so it uses a virtualenv created in .venv/, in aiosonic folder.

Running tests

poetry run py.test

Contribute

  1. Fork
  2. create a branch feature/your_feature
  3. commit - push - pull request

Thanks :)

Contributors