Async http client/server framework (asyncio)
Project description
Async http client/server framework
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 pluggable routing.
Getting started
Client
To get something from the web:
import aiohttp
import asyncio
async def fetch(session, url):
async with session.get(url) as response:
return await response.text()
async def main():
async with aiohttp.ClientSession() as session:
html = await fetch(session, 'http://python.org')
print(html)
if __name__ == '__main__':
loop = asyncio.get_event_loop()
loop.run_until_complete(main())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
Demos
External links
Feel free to make a Pull Request for adding your link to these pages!
Communication channels
aio-libs google group: https://groups.google.com/forum/#!forum/aio-libs
Feel free to post your questions and ideas here.
gitter chat https://gitter.im/aio-libs/Lobby
We support Stack Overflow. Please add aiohttp tag to your question there.
Requirements
Python >= 3.5.3
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.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 web_protocol.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 util classes #3660
Fix overshadowing of overlapped subbaps 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
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
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
File details
Details for the file aiohttp-3.6.0.tar.gz.
File metadata
- Download URL: aiohttp-3.6.0.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af7809ce7de6709afc7770403a70dfdbc4e988c91451108c8e123fac46b870d9 |
|
| MD5 | 5a9b961d1dc6a04fefc3e3aba10b3f1f |
|
| BLAKE2b-256 | 26d59de37b49a716b2e9a1f0813aab502ff1b815aa3748dbe98c4e73f1781390 |
Provenance
File details
Details for the file aiohttp-3.6.0-py3-none-any.whl.
File metadata
- Download URL: aiohttp-3.6.0-py3-none-any.whl
- Upload date:
- Size: 191.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a91251585acf5203842551e37d2700c13c0bb411fa61b13485ab9e8d2dd400e9 |
|
| MD5 | b7cdae8e71ffeb57bb2f1b366429201d |
|
| BLAKE2b-256 | 18024b93461b42791a0021ebda53dedaf1cb76b7eafa652c1f025e77bba5951a |
Provenance
File details
Details for the file aiohttp-3.6.0-cp37-cp37m-win_amd64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp37-cp37m-win_amd64.whl
- Upload date:
- Size: 617.4 kB
- Tags: CPython 3.7m, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6907359de725e7ccd04b458a0f3322c7d1ba78df3df02e2ceb5abb0e21c975e6 |
|
| MD5 | 5dff69b7ec99dc5bd86119b320edba0c |
|
| BLAKE2b-256 | a2b6f43ecd9d36bd4e514cdb72a4cd9e4b7afcaeba2840a1864a78e900acc83a |
Provenance
File details
Details for the file aiohttp-3.6.0-cp37-cp37m-win32.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp37-cp37m-win32.whl
- Upload date:
- Size: 589.7 kB
- Tags: CPython 3.7m, Windows x86
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 635bef0626e28446372511e1fd31585205db2f18dab37a43d8adb30b0483e1bf |
|
| MD5 | 93226cf9d8e4984e1fd4ebb8f29e64f8 |
|
| BLAKE2b-256 | 1bc536504584476bab207f035f73ace683615fb6f347ab4fcc0a075c11917613 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp37-cp37m-manylinux1_x86_64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp37-cp37m-manylinux1_x86_64.whl
- Upload date:
- Size: 1.2 MB
- Tags: CPython 3.7m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 315f55a8469284f3ee54534d76f525b5c104dc514999dca4a007524a458aaba2 |
|
| MD5 | df8197f4767e5d8ab0327e713d450705 |
|
| BLAKE2b-256 | 5e86f505d447c97cf57a0224c7e0e3a79b73b8cc3f0eb6eeed856e7fa48f8f64 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp37-cp37m-manylinux1_i686.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp37-cp37m-manylinux1_i686.whl
- Upload date:
- Size: 1.1 MB
- Tags: CPython 3.7m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 772cfc0ff7c088d9e211377951a51c8a5173110cf56214f3e3d08a89be07badc |
|
| MD5 | 47cccf97e39999a147fab75546b646a5 |
|
| BLAKE2b-256 | 3fb40aa23df1c733e846d1a5e20ca2784e7eff23eb328a1b82676df10819e270 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp36-cp36m-win_amd64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp36-cp36m-win_amd64.whl
- Upload date:
- Size: 617.2 kB
- Tags: CPython 3.6m, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fa155e309cc2277d6f9d099aecaf3ce78d86a31f5a62a994debc872e4c34ddf4 |
|
| MD5 | db808a0cb0b8d2f72c39c234f6233073 |
|
| BLAKE2b-256 | db18620ab7361efd4ebd7a5a1ff1dfbb1caf64200f94e96840549cee98a2d38e |
Provenance
File details
Details for the file aiohttp-3.6.0-cp36-cp36m-win32.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp36-cp36m-win32.whl
- Upload date:
- Size: 589.6 kB
- Tags: CPython 3.6m, Windows x86
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1cf5b433a0aa3cf45b0acd4adb14cb20d99166aaa967ab89f629635ac263ca64 |
|
| MD5 | 2d6b05a56e8338426c14cb81c3fe75ae |
|
| BLAKE2b-256 | d48b9d0b4670697bf1666a67957e1393a64b44db9ba6e1e9657e5cdbc8c3e982 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp36-cp36m-manylinux1_x86_64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp36-cp36m-manylinux1_x86_64.whl
- Upload date:
- Size: 1.2 MB
- Tags: CPython 3.6m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | acbbf0c47aa713d7a4baf52f11a356b01b82cabb53da452328546acaa21c6605 |
|
| MD5 | 6ec6435bbf73f0f74f8ec9d515e93a3e |
|
| BLAKE2b-256 | 203ebde50b8d1f5e7de24ea9119fab9ef33ea333a72bfcdd00345f6ba7c5cea6 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp36-cp36m-manylinux1_i686.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp36-cp36m-manylinux1_i686.whl
- Upload date:
- Size: 1.1 MB
- Tags: CPython 3.6m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e0fe698d1e6a852a27a88d2844a1a63839ee764d7cf214fd58cbea480407cc1d |
|
| MD5 | e95f00c3be7d9716b86b7a6ba970ddb6 |
|
| BLAKE2b-256 | db6f6dac934238a8f04fead3607f5c3a3b58ab0c6f6796cbd9c5941a9e657618 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp35-cp35m-win_amd64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp35-cp35m-win_amd64.whl
- Upload date:
- Size: 611.7 kB
- Tags: CPython 3.5m, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ab7ab0a710135133dcc2980dd48fdd92f6f6066b66ef0356f458f395aa375af |
|
| MD5 | 95979f2b5e61ecc91ee4fa90b74f478b |
|
| BLAKE2b-256 | ba74f99d00bc439f2a9788e9357c5d9c0d0aa56c2779e5d4649aeda11590c4e7 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp35-cp35m-win32.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp35-cp35m-win32.whl
- Upload date:
- Size: 583.7 kB
- Tags: CPython 3.5m, Windows x86
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.5.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 27b2bc8ca5555d5dadeee07cc2d6f8c06092c9d9c3f203c79c124d07474d3cf8 |
|
| MD5 | f639e993a1ed09b2abf364175d3245ee |
|
| BLAKE2b-256 | dec96c85af4b1c051855567543330df6cf700ad4edeb3ef8b8e640bab5cad11b |
Provenance
File details
Details for the file aiohttp-3.6.0-cp35-cp35m-manylinux1_x86_64.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp35-cp35m-manylinux1_x86_64.whl
- Upload date:
- Size: 1.1 MB
- Tags: CPython 3.5m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | de611d7b95c1067d9a415979c63503dbdc735b943d08779506886614b410644a |
|
| MD5 | 56d2ae12a0f026e869f73994a67eb006 |
|
| BLAKE2b-256 | dc58dc64aebcd4448b93b39ee3675bd16d8347fb2689162f9d2379add464b315 |
Provenance
File details
Details for the file aiohttp-3.6.0-cp35-cp35m-manylinux1_i686.whl.
File metadata
- Download URL: aiohttp-3.6.0-cp35-cp35m-manylinux1_i686.whl
- Upload date:
- Size: 1.1 MB
- Tags: CPython 3.5m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4f3c1572716ce2c8f22877a8185414ec213c057df35d27f7195f185691828608 |
|
| MD5 | 2673e0707fa278b4c250ea8f616450a6 |
|
| BLAKE2b-256 | 30876f499d1945d1375c1cd73d93241079ce2fad10ef0d4b6ff91b9e1d111e7e |
