**This work has been overtaken by the `http3` project:** https://www.encode.io/http3/
We now recommend using `http3.AsyncClient()` for async/await support with a requests-compatible API.
**Note**: Use `ipython` to try this from the console, since it supports `await`.
```python
>>> import http3
>>> client = http3.AsyncClient()
>>> r = await client.get('https://www.example.org/')
>>> r.status_code
200
>>> r.text
'<!doctype html>\n<html>\n<head>\n<title>Example Domain</title>...'
```
---
# requests-async
Brings support for `async`/`await` syntax to Python's fabulous `requests` library.
<p>
<a href="https://travis-ci.org/encode/requests-async">
<img src="https://travis-ci.org/encode/requests-async.svg?branch=master" alt="Build Status">
</a>
<a href="https://codecov.io/gh/encode/requests-async">
<img src="https://codecov.io/gh/encode/requests-async/branch/master/graph/badge.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/requests-async/">
<img src="https://badge.fury.io/py/requests-async.svg?cache0" alt="Package version">
</a>
</p>
## Requirements
* Python 3.6+
## Installation
```shell
$ pip install requests-async
```
## Usage
Just use *the standard requests API*, but use `await` for making requests.
**Note**: Use `ipython` to try this from the console, since it supports `await`.
```python
import requests_async as requests
response = await requests.get('https://example.org')
print(response.status_code)
print(response.text)
```
Or use explicit sessions, with an async context manager.
```python
import requests_async as requests
async with requests.Session() as session:
response = await session.get('https://example.org')
print(response.status_code)
print(response.text)
```
The `requests_async` package subclasses `requests`, so you're getting all the
standard behavior and API you'd expect.
## Streaming responses & requests
The `iter_content()` and `iter_lines()` methods are async iterators.
```python
response = await requests.get('https://example.org', stream=True)
async for chunk in response.iter_content():
...
```
The method signatures remain the same as the standard `requests` API:
* `iter_content(chunk_size=1, decode_unicode=False)`
* `iter_lines(chunk_size=512, decode_unicode=False, delimiter=None)`
The methods will yield text if `decode_unicode` is set and the response includes
an encoding. Otherwise the methods will yield bytes.
You can also stream request bodies. To do this you should use an asynchronous
generator that yields bytes.
```python
async def stream_body():
...
response = await requests.post('https://example.org', data=stream_body())
```
## Mock Requests
In some situations, such as when you're testing a web application, you may
not want to make actual outgoing network requests, but would prefer instead
to mock out the endpoints.
You can do this using the `ASGISession`, which allows you to plug into
any ASGI application, instead of making actual network requests.
```python
import requests_async
# Create a mock service, with Starlette, Responder, Quart, FastAPI, Bocadillo,
# or any other ASGI web framework.
mock_app = ...
if TESTING:
# Issue requests to the mocked application.
requests = requests_async.ASGISession(mock_app)
else:
# Make live network requests.
requests = requests_async.Session()
```
## Test Client
You can also use `ASGISession` as a test client for any ASGI application.
You'll probably want to install `pytest` and `pytest-asyncio`, or something
equivalent, to allow you to write `async` test cases.
```python
from requests_async import ASGISession
from myproject import app
import pytest
@pytest.mark.asyncio
async def test_homepage():
client = ASGISession(app)
response = await client.get("/")
assert response.status_code == 200
```
## Alternatives
* The [`http3` package][http3] both sync and async HTTP clients, with a requests-compatible API.
* The [`aiohttp` package][aiohttp] provides an alternative client for making async HTTP requests.
[issues]: https://github.com/encode/requests-async/issues
[aiohttp]: https://docs.aiohttp.org/en/stable/client.html
[http3]: https://github.com/encode/http3
Raw data
{
"_id": null,
"home_page": "https://github.com/encode/requests-async",
"name": "requests-async",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Tom Christie",
"author_email": "tom@tomchristie.com",
"download_url": "https://files.pythonhosted.org/packages/4a/e7/afbe47fa17068c80a5e80d75e1e960a98a5cfefe3590108ba76d9560cefc/requests-async-0.6.2.tar.gz",
"platform": "",
"description": "**This work has been overtaken by the `http3` project:** https://www.encode.io/http3/\n\nWe now recommend using `http3.AsyncClient()` for async/await support with a requests-compatible API.\n\n**Note**: Use `ipython` to try this from the console, since it supports `await`.\n\n```python\n>>> import http3\n>>> client = http3.AsyncClient()\n>>> r = await client.get('https://www.example.org/')\n>>> r.status_code\n200\n>>> r.text\n'<!doctype html>\\n<html>\\n<head>\\n<title>Example Domain</title>...'\n```\n\n---\n\n# requests-async\n\nBrings support for `async`/`await` syntax to Python's fabulous `requests` library.\n\n<p>\n<a href=\"https://travis-ci.org/encode/requests-async\">\n <img src=\"https://travis-ci.org/encode/requests-async.svg?branch=master\" alt=\"Build Status\">\n</a>\n<a href=\"https://codecov.io/gh/encode/requests-async\">\n <img src=\"https://codecov.io/gh/encode/requests-async/branch/master/graph/badge.svg\" alt=\"Coverage\">\n</a>\n<a href=\"https://pypi.org/project/requests-async/\">\n <img src=\"https://badge.fury.io/py/requests-async.svg?cache0\" alt=\"Package version\">\n</a>\n</p>\n\n## Requirements\n\n* Python 3.6+\n\n## Installation\n\n```shell\n$ pip install requests-async\n```\n\n## Usage\n\nJust use *the standard requests API*, but use `await` for making requests.\n\n**Note**: Use `ipython` to try this from the console, since it supports `await`.\n\n```python\nimport requests_async as requests\n\n\nresponse = await requests.get('https://example.org')\nprint(response.status_code)\nprint(response.text)\n```\n\nOr use explicit sessions, with an async context manager.\n\n```python\nimport requests_async as requests\n\n\nasync with requests.Session() as session:\n response = await session.get('https://example.org')\n print(response.status_code)\n print(response.text)\n```\n\nThe `requests_async` package subclasses `requests`, so you're getting all the\nstandard behavior and API you'd expect.\n\n## Streaming responses & requests\n\nThe `iter_content()` and `iter_lines()` methods are async iterators.\n\n```python\nresponse = await requests.get('https://example.org', stream=True)\nasync for chunk in response.iter_content():\n ...\n```\n\nThe method signatures remain the same as the standard `requests` API:\n\n* `iter_content(chunk_size=1, decode_unicode=False)`\n* `iter_lines(chunk_size=512, decode_unicode=False, delimiter=None)`\n\nThe methods will yield text if `decode_unicode` is set and the response includes\nan encoding. Otherwise the methods will yield bytes.\n\nYou can also stream request bodies. To do this you should use an asynchronous\ngenerator that yields bytes.\n\n```python\nasync def stream_body():\n ...\n\nresponse = await requests.post('https://example.org', data=stream_body())\n```\n\n## Mock Requests\n\nIn some situations, such as when you're testing a web application, you may\nnot want to make actual outgoing network requests, but would prefer instead\nto mock out the endpoints.\n\nYou can do this using the `ASGISession`, which allows you to plug into\nany ASGI application, instead of making actual network requests.\n\n```python\nimport requests_async\n\n#\u00a0Create a mock service, with Starlette, Responder, Quart, FastAPI, Bocadillo,\n# or any other ASGI web framework.\nmock_app = ...\n\nif TESTING:\n #\u00a0Issue requests to the mocked application.\n requests = requests_async.ASGISession(mock_app)\nelse:\n # Make live network requests.\n requests = requests_async.Session()\n```\n\n## Test Client\n\nYou can also use `ASGISession` as a test client for any ASGI application.\n\nYou'll probably want to install `pytest` and `pytest-asyncio`, or something\nequivalent, to allow you to write `async` test cases.\n\n```python\nfrom requests_async import ASGISession\nfrom myproject import app\nimport pytest\n\n@pytest.mark.asyncio\nasync def test_homepage():\n client = ASGISession(app)\n response = await client.get(\"/\")\n assert response.status_code == 200\n```\n\n## Alternatives\n\n* The [`http3` package][http3] both sync and async HTTP clients, with a requests-compatible API.\n* The [`aiohttp` package][aiohttp] provides an alternative client for making async HTTP requests.\n\n[issues]: https://github.com/encode/requests-async/issues\n[aiohttp]: https://docs.aiohttp.org/en/stable/client.html\n[http3]: https://github.com/encode/http3",
"bugtrack_url": null,
"license": "BSD",
"summary": "async-await support for `requests`.",
"version": "0.6.2",
"project_urls": {
"Homepage": "https://github.com/encode/requests-async"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ae7afbe47fa17068c80a5e80d75e1e960a98a5cfefe3590108ba76d9560cefc",
"md5": "b03f7a535f906eaef28439b8d744d726",
"sha256": "8f128b66dec2974aa263e24410914b1829d3e1506497364c2edfa10112f55e0b"
},
"downloads": -1,
"filename": "requests-async-0.6.2.tar.gz",
"has_sig": false,
"md5_digest": "b03f7a535f906eaef28439b8d744d726",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 12856,
"upload_time": "2019-06-21T12:52:21",
"upload_time_iso_8601": "2019-06-21T12:52:21.709954Z",
"url": "https://files.pythonhosted.org/packages/4a/e7/afbe47fa17068c80a5e80d75e1e960a98a5cfefe3590108ba76d9560cefc/requests-async-0.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-06-21 12:52:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "encode",
"github_project": "requests-async",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "http3",
"specs": [
[
"==",
"0.6.*"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.*"
]
]
},
{
"name": "black",
"specs": []
},
{
"name": "isort",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "pytest-asyncio",
"specs": []
},
{
"name": "pytest-cov",
"specs": []
},
{
"name": "python-multipart",
"specs": []
},
{
"name": "starlette",
"specs": [
[
"==",
"0.12.0b1"
]
]
},
{
"name": "uvicorn",
"specs": []
}
],
"lcname": "requests-async"
}
JSON
