aiohttp

Async http client/server framework (asyncio)

These details have been verified by PyPI

Owner

aio-libs

Maintainers

Andrew.Svetlov bdraco Dreamsorcerer fafhrd webknjaz

These details have not been verified by PyPI

Project links

Project description

Async http client/server framework

Azure Pipelines status for master branch

Key Features

Supports both client and server side of HTTP protocol.
Supports both client and server Web-Sockets out-of-the-box and avoids Callback Hell.
Provides Web-server with middlewares and plugable routing.

Getting started

Client

To get something from the web:

import aiohttp
import asyncio

async def main():

    async with aiohttp.ClientSession() as session:
        async with session.get('http://python.org') as response:

            print("Status:", response.status)
            print("Content-type:", response.headers['content-type'])

            html = await response.text()
            print("Body:", html[:15], "...")

loop = asyncio.get_event_loop()
loop.run_until_complete(main())

This prints:

Status: 200
Content-type: text/html; charset=utf-8
Body: <!doctype html> ...

Comming from requests ? Read why we need so many lines.

Server

An example using a simple server:

# examples/server_simple.py
from aiohttp import web

async def handle(request):
    name = request.match_info.get('name', "Anonymous")
    text = "Hello, " + name
    return web.Response(text=text)

async def wshandle(request):
    ws = web.WebSocketResponse()
    await ws.prepare(request)

    async for msg in ws:
        if msg.type == web.WSMsgType.text:
            await ws.send_str("Hello, {}".format(msg.data))
        elif msg.type == web.WSMsgType.binary:
            await ws.send_bytes(msg.data)
        elif msg.type == web.WSMsgType.close:
            break

    return ws


app = web.Application()
app.add_routes([web.get('/', handle),
                web.get('/echo', wshandle),
                web.get('/{name}', handle)])

if __name__ == '__main__':
    web.run_app(app)

Documentation

https://aiohttp.readthedocs.io/

Demos

https://github.com/aio-libs/aiohttp-demos

External links

Feel free to make a Pull Request for adding your link to these pages!

Communication channels

aio-libs discourse group: https://aio-libs.discourse.group

gitter chat https://gitter.im/aio-libs/Lobby

We support Stack Overflow. Please add aiohttp tag to your question there.

Requirements

Optionally you may install the cChardet and aiodns libraries (highly recommended for sake of speed).

License

aiohttp is offered under the Apache 2 license.

Keepsafe

The aiohttp community would like to thank Keepsafe (https://www.getkeepsafe.com) for its support in the early days of the project.

Source code

The latest developer version is available in a GitHub repository: https://github.com/aio-libs/aiohttp

Benchmarks

If you are interested in efficiency, the AsyncIO community maintains a list of benchmarks on the official wiki: https://github.com/python/asyncio/wiki/Benchmarks

Changelog

3.6.3 (2020-10-12)

Bugfixes

Pin yarl to <1.6.0 to avoid buggy behavior that will be fixed by the next aiohttp release.

3.6.2 (2019-10-09)

Features

Made exceptions pickleable. Also changed the repr of some exceptions. #4077
Use Iterable type hint instead of Sequence for Application middleware parameter. #4125

Bugfixes

Reset the sock_read timeout each time data is received for a aiohttp.ClientResponse. #3808
Fix handling of expired cookies so they are not stored in CookieJar. #4063
Fix misleading message in the string representation of ClientConnectorError; self.ssl == None means default SSL context, not SSL disabled #4097
Don’t clobber HTTP status when using FileResponse. #4106

Improved Documentation

Added minimal required logging configuration to logging documentation. #2469
Update docs to reflect proxy support. #4100
Fix typo in code example in testing docs. #4108

Misc

#4102

3.6.1 (2019-09-19)

Features

Compatibility with Python 3.8. #4056

Bugfixes

correct some exception string format #4068
Emit a warning when ssl.OP_NO_COMPRESSION is unavailable because the runtime is built against an outdated OpenSSL. #4052
Update multidict requirement to >= 4.5 #4057

Improved Documentation

Provide pytest-aiohttp namespace for pytest fixtures in docs. #3723

3.6.0 (2019-09-06)

Features

Add support for Named Pipes (Site and Connector) under Windows. This feature requires Proactor event loop to work. #3629
Removed Transfer-Encoding: chunked header from websocket responses to be compatible with more http proxy servers. #3798
Accept non-GET request for starting websocket handshake on server side. #3980

Bugfixes

Raise a ClientResponseError instead of an AssertionError for a blank HTTP Reason Phrase. #3532
Fix an issue where cookies would sometimes not be set during a redirect. #3576
Change normalize_path_middleware to use 308 redirect instead of 301.

This behavior should prevent clients from being unable to use PUT/POST methods on endpoints that are redirected because of a trailing slash. #3579
Drop the processed task from all_tasks() list early. It prevents logging about a task with unhandled exception when the server is used in conjunction with asyncio.run(). #3587
Signal type annotation changed from Signal[Callable[['TraceConfig'], Awaitable[None]]] to Signal[Callable[ClientSession, SimpleNamespace, ...]. #3595
Use sanitized URL as Location header in redirects #3614
Improve typing annotations for multipart.py along with changes required by mypy in files that references multipart.py. #3621
Close session created inside aiohttp.request when unhandled exception occurs #3628
Cleanup per-chunk data in generic data read. Memory leak fixed. #3631
Use correct type for add_view and family #3633
Fix _keepalive field in __slots__ of RequestHandler. #3644
Properly handle ConnectionResetError, to silence the “Cannot write to closing transport” exception when clients disconnect uncleanly. #3648
Suppress pytest warnings due to test_utils classes #3660
Fix overshadowing of overlapped sub-application prefixes. #3701
Fixed return type annotation for WSMessage.json() #3720
Properly expose TooManyRedirects publicly as documented. #3818
Fix missing brackets for IPv6 in proxy CONNECT request #3841
Make the signature of aiohttp.test_utils.TestClient.request match asyncio.ClientSession.request according to the docs #3852
Use correct style for re-exported imports, makes mypy --strict mode happy. #3868
Fixed type annotation for add_view method of UrlDispatcher to accept any subclass of View #3880
Made cython HTTP parser set Reason-Phrase of the response to an empty string if it is missing. #3906
Add URL to the string representation of ClientResponseError. #3959
Accept istr keys in LooseHeaders type hints. #3976
Fixed race conditions in _resolve_host caching and throttling when tracing is enabled. #4013
For URLs like “unix://localhost/…” set Host HTTP header to “localhost” instead of “localhost:None”. #4039

Improved Documentation

Modify documentation for Background Tasks to remove deprecated usage of event loop. #3526
use if __name__ == '__main__': in server examples. #3775
Update documentation reference to the default access logger. #3783
Improve documentation for web.BaseRequest.path and web.BaseRequest.raw_path. #3791
Removed deprecation warning in tracing example docs #3964

3.5.4 (2019-01-12)

Bugfixes

Fix stream .read() / .readany() / .iter_any() which used to return a partial content only in case of compressed content #3525

3.5.3 (2019-01-10)

Bugfixes

Fix type stubs for aiohttp.web.run_app(access_log=True) and fix edge case of access_log=True and the event loop being in debug mode. #3504
Fix aiohttp.ClientTimeout type annotations to accept None for fields #3511
Send custom per-request cookies even if session jar is empty #3515
Restore Linux binary wheels publishing on PyPI

3.5.2 (2019-01-08)

Features

FileResponse from web_fileresponse.py uses a ThreadPoolExecutor to work with files asynchronously. I/O based payloads from payload.py uses a ThreadPoolExecutor to work with I/O objects asynchronously. #3313
Internal Server Errors in plain text if the browser does not support HTML. #3483

Bugfixes

Preserve MultipartWriter parts headers on write. Refactor the way how Payload.headers are handled. Payload instances now always have headers and Content-Type defined. Fix Payload Content-Disposition header reset after initial creation. #3035
Log suppressed exceptions in GunicornWebWorker. #3464
Remove wildcard imports. #3468
Use the same task for app initialization and web server handling in gunicorn workers. It allows to use Python3.7 context vars smoothly. #3471
Fix handling of chunked+gzipped response when first chunk does not give uncompressed data #3477
Replace collections.MutableMapping with collections.abc.MutableMapping to avoid a deprecation warning. #3480
Payload.size type annotation changed from Optional[float] to Optional[int]. #3484
Ignore done tasks when cancels pending activities on web.run_app finalization. #3497

Improved Documentation

Add documentation for aiohttp.web.HTTPException. #3490

Misc

#3487

3.5.1 (2018-12-24)

Fix a regression about ClientSession._requote_redirect_url modification in debug mode.

3.5.0 (2018-12-22)

Features

The library type annotations are checked in strict mode now.
Add support for setting cookies for individual request (#2387)
Application.add_domain implementation (#2809)
The default app in the request returned by test_utils.make_mocked_request can now have objects assigned to it and retrieved using the [] operator. (#3174)
Make request.url accessible when transport is closed. (#3177)
Add zlib_executor_size argument to Response constructor to allow compression to run in a background executor to avoid blocking the main thread and potentially triggering health check failures. (#3205)
Enable users to set ClientTimeout in aiohttp.request (#3213)
Don’t raise a warning if NETRC environment variable is not set and ~/.netrc file doesn’t exist. (#3267)
Add default logging handler to web.run_app If the Application.debug` flag is set and the default logger aiohttp.access is used, access logs will now be output using a stderr StreamHandler if no handlers are attached. Furthermore, if the default logger has no log level set, the log level will be set to DEBUG. (#3324)
Add method argument to session.ws_connect(). Sometimes server API requires a different HTTP method for WebSocket connection establishment. For example, Docker exec needs POST. (#3378)
Create a task per request handling. (#3406)

Bugfixes

Enable passing access_log_class via handler_args (#3158)
Return empty bytes with end-of-chunk marker in empty stream reader. (#3186)
Accept CIMultiDictProxy instances for headers argument in web.Response constructor. (#3207)
Don’t uppercase HTTP method in parser (#3233)
Make method match regexp RFC-7230 compliant (#3235)
Add app.pre_frozen state to properly handle startup signals in sub-applications. (#3237)
Enhanced parsing and validation of helpers.BasicAuth.decode. (#3239)
Change imports from collections module in preparation for 3.8. (#3258)
Ensure Host header is added first to ClientRequest to better replicate browser (#3265)
Fix forward compatibility with Python 3.8: importing ABCs directly from the collections module will not be supported anymore. (#3273)
Keep the query string by normalize_path_middleware. (#3278)
Fix missing parameter raise_for_status for aiohttp.request() (#3290)
Bracket IPv6 addresses in the HOST header (#3304)
Fix default message for server ping and pong frames. (#3308)
Fix tests/test_connector.py typo and tests/autobahn/server.py duplicate loop def. (#3337)
Fix false-negative indicator end_of_HTTP_chunk in StreamReader.readchunk function (#3361)
Release HTTP response before raising status exception (#3364)
Fix task cancellation when sendfile() syscall is used by static file handling. (#3383)
Fix stack trace for asyncio.TimeoutError which was not logged, when it is caught in the handler. (#3414)

Improved Documentation

Improve documentation of Application.make_handler parameters. (#3152)
Fix BaseRequest.raw_headers doc. (#3215)
Fix typo in TypeError exception reason in web.Application._handle (#3229)
Make server access log format placeholder %b documentation reflect behavior and docstring. (#3307)

Deprecations and Removals

Deprecate modification of session.requote_redirect_url (#2278)
Deprecate stream.unread_data() (#3260)
Deprecated use of boolean in resp.enable_compression() (#3318)
Encourage creation of aiohttp public objects inside a coroutine (#3331)
Drop dead Connection.detach() and Connection.writer. Both methods were broken for more than 2 years. (#3358)
Deprecate app.loop, request.loop, client.loop and connector.loop properties. (#3374)
Deprecate explicit debug argument. Use asyncio debug mode instead. (#3381)
Deprecate body parameter in HTTPException (and derived classes) constructor. (#3385)
Deprecate bare connector close, use async with connector: and await connector.close() instead. (#3417)
Deprecate obsolete read_timeout and conn_timeout in ClientSession constructor. (#3438)

Misc

#3341, #3351

Project details

These details have been verified by PyPI

Owner

aio-libs

Maintainers

Andrew.Svetlov bdraco Dreamsorcerer fafhrd webknjaz

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

4.0.0a1 pre-release yanked

Oct 9, 2019

Reason this release was yanked:

It confuses people who expect the highest pre-release to be the newest one. This has been built from a years-old version of the master branch.

4.0.0a0 pre-release yanked

Jan 9, 2019

Reason this release was yanked:

It confuses people who expect the highest pre-release to be the newest one. This has been built from a years-old version of the master branch.

3.11.0rc1 pre-release

Nov 11, 2024

3.11.0rc0 pre-release

Nov 10, 2024

3.11.0b5 pre-release

Nov 10, 2024

3.11.0b4 pre-release

Nov 8, 2024

3.11.0b3 pre-release

Nov 6, 2024

3.11.0b2 pre-release

Nov 3, 2024

3.11.0b1 pre-release

Nov 2, 2024

3.11.0b0 pre-release

Oct 29, 2024

3.10.10

Oct 10, 2024

3.10.9

Oct 4, 2024

3.10.8

Sep 28, 2024

3.10.7

Sep 27, 2024

3.10.6

Sep 24, 2024

3.10.6rc2 pre-release

Sep 24, 2024

3.10.6rc1 pre-release

Sep 23, 2024

3.10.6rc0 pre-release

Sep 23, 2024

3.10.5

Aug 19, 2024

3.10.4

Aug 17, 2024

3.10.3

Aug 10, 2024

3.10.2

Aug 8, 2024

3.10.1

Aug 4, 2024

3.10.0

Jul 30, 2024

3.10.0rc0 pre-release

Jul 29, 2024

3.10.0b1 pre-release

Jul 22, 2024

3.9.5

Apr 16, 2024

3.9.4

Apr 11, 2024

3.9.4rc0 pre-release

Feb 16, 2024

3.9.3

Jan 29, 2024

3.9.2

Jan 28, 2024

3.9.1

Nov 26, 2023

3.9.0

Nov 18, 2023

3.9.0rc0 pre-release

Nov 14, 2023

3.9.0b1 pre-release

Nov 6, 2023

3.9.0b0 pre-release

Oct 7, 2023

3.8.6

Oct 7, 2023

3.8.5

Jul 19, 2023

3.8.4

Feb 12, 2023

3.8.3

Sep 21, 2022

3.8.2 yanked

Sep 21, 2022

Reason this release was yanked:

This version includes overly restrictive multidict upper boundary disallowing multidict v6+. The previous patch version didn't have that and this is now causing dependency resolution problems for the users who have an "incompatible" version pinned. This is not really necessary anymore and will be addressed in the next release v3.8.3 https://github.com/aio-libs/aiohttp/pull/6950

3.8.1

Nov 14, 2021

3.8.0

Oct 31, 2021

3.8.0b0 pre-release

Oct 31, 2021

3.8.0a7 pre-release

Oct 30, 2021

3.7.4.post0

Mar 6, 2021

3.7.4

Feb 25, 2021

3.7.3

Nov 18, 2020

3.7.2

Oct 27, 2020

3.7.1

Oct 25, 2020

3.7.0

Oct 24, 2020

3.7.0b1 pre-release

Oct 22, 2020

This version

3.7.0b0 pre-release

Oct 21, 2020

3.6.3

Oct 12, 2020

3.6.2

Oct 9, 2019

3.6.2a2 pre-release

Oct 9, 2019

3.6.2a1 pre-release

Oct 9, 2019

3.6.2a0 pre-release

Oct 9, 2019

3.6.1

Sep 19, 2019

3.6.1b4 pre-release

Sep 17, 2019

3.6.1b3 pre-release

Sep 15, 2019

3.6.0

Sep 6, 2019

3.6.0b0 pre-release

Sep 5, 2019

3.6.0a12 pre-release

Aug 29, 2019

3.6.0a11 pre-release

Aug 29, 2019

3.6.0a9 pre-release

Aug 29, 2019

3.6.0a8 pre-release

Aug 20, 2019

3.6.0a7 pre-release

Aug 20, 2019

3.6.0a6 pre-release

Aug 20, 2019

3.6.0a5 pre-release

Aug 20, 2019

3.6.0a4 pre-release

Aug 20, 2019

3.6.0a3 pre-release

Aug 19, 2019

3.6.0a2 pre-release

Aug 19, 2019

3.6.0a1 pre-release

Aug 12, 2019

3.6.0a0 pre-release

Aug 12, 2019

3.5.4

Jan 12, 2019

3.5.3

Jan 10, 2019

3.5.2

Jan 8, 2019

3.5.1

Dec 24, 2018

3.5.0

Dec 22, 2018

3.5.0b3 pre-release

Dec 22, 2018

3.5.0b2 pre-release

Dec 21, 2018

3.5.0b1 pre-release

Dec 20, 2018

3.5.0a1 pre-release

Nov 20, 2018

3.4.4

Sep 5, 2018

3.4.3

Sep 4, 2018

3.4.2

Sep 1, 2018

3.4.1

Aug 28, 2018

3.4.0

Aug 25, 2018

3.4.0b2 pre-release

Aug 24, 2018

3.4.0b1 pre-release

Aug 24, 2018

3.4.0a3 pre-release

Aug 20, 2018

3.4.0a0 pre-release

Aug 11, 2018

3.3.2

Jun 12, 2018

3.3.2a0 pre-release

Jun 12, 2018

3.3.1

Jun 5, 2018

3.3.0

Jun 1, 2018

3.3.0a0 pre-release

Jun 2, 2018

3.2.1

May 10, 2018

3.2.0

May 6, 2018

3.1.3

Apr 13, 2018

3.1.2

Apr 5, 2018

3.1.1

Mar 27, 2018

3.1.0

Mar 21, 2018

3.0.9

Mar 14, 2018

3.0.8

Mar 13, 2018

3.0.7

Mar 8, 2018

3.0.6

Mar 4, 2018

3.0.5

Feb 27, 2018

3.0.4

Feb 26, 2018

3.0.3

Feb 25, 2018

3.0.2

Feb 23, 2018

3.0.1

Feb 12, 2018

3.0.0

Feb 12, 2018

3.0.0b4 pre-release

Feb 9, 2018

3.0.0b3 pre-release

Feb 8, 2018

3.0.0b2 pre-release

Feb 8, 2018

3.0.0b1 pre-release

Feb 8, 2018

3.0.0b0 pre-release

Feb 8, 2018

2.3.10

Feb 2, 2018

2.3.9

Jan 17, 2018

2.3.8

Jan 15, 2018

2.3.7

Dec 27, 2017

2.3.6

Dec 4, 2017

2.3.5

Nov 30, 2017

2.3.4

Nov 29, 2017

2.3.3

Nov 17, 2017

2.3.2

Nov 1, 2017

2.3.2b3 pre-release

Nov 1, 2017

2.3.2b2 pre-release

Nov 1, 2017

2.3.1

Oct 19, 2017

2.3.1a1 pre-release

Oct 18, 2017

2.3.0

Oct 18, 2017

2.3.0a4 pre-release

Oct 17, 2017

2.3.0a3 pre-release

Oct 17, 2017

2.3.0a2 pre-release

Oct 17, 2017

2.3.0a1 pre-release

Oct 17, 2017

2.2.5

Aug 3, 2017

2.2.4

Aug 2, 2017

2.2.3

Jul 4, 2017

2.2.2

Jul 3, 2017

2.2.1

Jul 2, 2017

2.2.0

Jun 20, 2017

2.1.0

May 26, 2017

2.0.7

Apr 12, 2017

2.0.6

Apr 6, 2017

2.0.5

Mar 29, 2017

2.0.4

Mar 27, 2017

2.0.3

Mar 24, 2017

2.0.2

Mar 23, 2017

2.0.1

Mar 21, 2017

2.0.0

Mar 20, 2017

2.0.0rc1 pre-release

Mar 15, 2017

1.3.5

Mar 16, 2017

1.3.4

Mar 15, 2017

1.3.3

Feb 20, 2017

1.3.2

Feb 16, 2017

1.3.1

Feb 9, 2017

1.3.0

Feb 8, 2017

1.2.0

Dec 17, 2016

1.1.6

Nov 28, 2016

1.1.5

Nov 16, 2016

1.1.4

Nov 14, 2016

1.1.3

Nov 10, 2016

1.1.2

Nov 8, 2016

1.1.1

Nov 4, 2016

1.1.0

Nov 3, 2016

1.0.5

Oct 11, 2016

1.0.3

Oct 4, 2016

1.0.2

Sep 22, 2016

1.0.1

Sep 16, 2016

1.0.0

Sep 16, 2016

0.22.5

Aug 2, 2016

0.22.4

Jul 28, 2016

0.22.3

Jul 26, 2016

0.22.2

Jul 23, 2016

0.22.1

Jul 16, 2016

0.22.0

Jul 15, 2016

0.22.0b6 pre-release

Jul 14, 2016

0.22.0b5 pre-release

Jul 14, 2016

0.22.0b4 pre-release

Jul 14, 2016

0.22.0b3 pre-release

Jul 14, 2016

0.22.0b2 pre-release

Jul 14, 2016

0.22.0b1 pre-release

Jul 14, 2016

0.22.0b0 pre-release

Jul 14, 2016

0.22.0a0 pre-release

May 5, 2016

0.21.6

May 5, 2016

0.21.5

Mar 22, 2016

0.21.4

Mar 13, 2016

0.21.2

Feb 16, 2016

0.21.1

Feb 10, 2016

0.21.0

Feb 4, 2016

0.20.2

Jan 7, 2016

0.20.1

Dec 30, 2015

0.20.0

Dec 28, 2015

0.19.0

Nov 25, 2015

0.18.4

Nov 13, 2015

0.18.3

Oct 25, 2015

0.18.2

Oct 22, 2015

0.18.1

Oct 20, 2015

0.18.0

Oct 20, 2015

0.17.4

Sep 29, 2015

0.17.3

Aug 28, 2015

0.17.2

Aug 11, 2015

0.17.1

Aug 10, 2015

0.17.0

Aug 4, 2015

0.16.6

Jul 15, 2015

0.16.5

Jun 13, 2015

0.16.4

Jun 13, 2015

0.16.3

May 30, 2015

0.16.2

May 27, 2015

0.16.1

May 27, 2015

0.16.0

May 26, 2015

0.15.3

Apr 22, 2015

0.15.2

Apr 19, 2015

0.15.1

Mar 31, 2015

0.15.0

Mar 27, 2015

0.14.4

Jan 29, 2015

0.14.3

Jan 28, 2015

0.14.2

Jan 23, 2015

0.14.1

Jan 15, 2015

0.14.0

Jan 15, 2015

0.13.1

Dec 31, 2014

0.13.0

Dec 29, 2014

0.12.0

Dec 12, 2014

0.11.0

Nov 29, 2014

0.10.2

Nov 19, 2014

0.10.1

Nov 17, 2014

0.10.0

Nov 13, 2014

0.9.3

Oct 30, 2014

0.9.2

Oct 16, 2014

0.9.1

Aug 30, 2014

0.9.0

Jul 8, 2014

0.8.4

Jul 4, 2014

0.8.3

Jul 4, 2014

0.8.2

Jun 22, 2014

0.8.1

Jun 19, 2014

0.8.0

Jun 9, 2014

0.7.3

May 19, 2014

0.7.2

May 14, 2014

0.7.1

Apr 28, 2014

0.7.0

Apr 16, 2014

0.6.5

Mar 29, 2014

0.6.4

Feb 28, 2014

0.6.3

Feb 28, 2014

0.6.2

Feb 18, 2014

0.6.1

Feb 18, 2014

0.6.0

Feb 12, 2014

0.5.0

Jan 29, 2014

0.4.4

Nov 15, 2013

0.4.3

Nov 15, 2013

0.4.2

Nov 14, 2013

0.4.1

Nov 12, 2013

0.4

Nov 7, 2013

0.3

Nov 4, 2013

0.2

Oct 25, 2013

0.1

Oct 25, 2013

Download files

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

Source Distribution

aiohttp-3.7.0b0.tar.gz (1.1 MB view details)

Uploaded Oct 21, 2020 Source