GithubHelp home page GithubHelp logo

euthygenes / requests-async Goto Github PK

View Code? Open in Web Editor NEW

This project forked from encode/requests-async

0.0 0.0 0.0 95 KB

async-await support for `requests`. ✨ 🍰 ✨

License: Other

Python 97.03% Shell 2.97%

requests-async's Introduction

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.

>>> 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.

Build Status Coverage Package version

Requirements

  • Python 3.6+

Installation

$ 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.

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.

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.

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.

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.

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.

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 both sync and async HTTP clients, with a requests-compatible API.
  • The aiohttp package provides an alternative client for making async HTTP requests.

requests-async's People

Contributors

blueyed avatar cclauss avatar iwoloschin avatar mekicha avatar merleliukun avatar nicoddemus avatar sezginacer avatar tomchristie avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.