Skip to content

httpx

12,154 12 53 BSD
0.27.0 (21 Feb 2024) Jul 26 2019 55.4 million (month)

httpx is a fully featured HTTP client for Python 3, which provides sync and async APIs, and support for both HTTP/1.1 and HTTP/2. It is designed to be a replacement for the popular requests package, with the added benefit of being fully compatible with Python 3's async features.

One of the main features of httpx is its support for asynchronous programming. This means that it can send multiple requests at the same time, without blocking the execution of your program. This can lead to significant performance improvements, especially when working with many small requests, or when dealing with slow or unreliable network connections.

httpx also supports sending HTTP/2 requests, which allows for more efficient use of network resources and can result in faster page loads.

One of the strengths of httpx is the possibility of working on streaming mode for the response data. This means you can process the response as it comes in, instead of waiting for the entire response to be received. This is useful when working with large files, or when you need to process the data in real-time.

Additionally, httpx provides a number of other features that are common in modern HTTP clients, such as support for sending and receiving cookies, handling redirects, and working with multipart file uploads. It also include support for several well-known authentication modules like BasicAuth, DigestAuth, and BearerAuth.

Highlights


asynciotriosynchttp2

Example Use


import httpx

# Just like requests httpx can be used directly
response = httpx.get("http://webscraping.fyi/")
response.status_code
200
response.text
"text"
response.content
b"bytes"

# HTTP2 needs to be enabled explicitly and is recommended for web scraping:
response = httpx.get("http://webscraping.fyi/", http2=True)

# httpx can automatically convert json responses to Python dictionaries:
response = httpx.get("http://httpbin.org/json")
print(response.json())
{'slideshow': {'author': 'Yours Truly', 'date': 'date of publication', 'slides': [{'title': 'Wake up to WonderWidgets!', 'type': 'all'}, {'items': ['Why <em>WonderWidgets</em> are great', 'Who <em>buys</em> WonderWidgets'], 'title': 'Overview', 'type': 'all'}], 'title': 'Sample Slide Show'}}

# for POST request it can ingest Python's dictionaries as JSON:
response = requests.post("http://httpbin.org/post", json={"query": "hello world"})
# or form data:
response = requests.post("http://httpbin.org/post", data={"query": "hello world"})

# persistent client can be established using Client object
# this allows to set default values and automatically track cookies
from httpx import Client

c = Client(headers={"User-Agent": "webscraping.fyi"}, http2=True)
c.get('http://httpbin.org/cookies/set/foo/bar')
print(c.cookies['foo'])
'bar'
print(c.get('http://httpbin.org/cookies').json())
{'cookies': {'foo': 'bar'}}

# for asynchronous requests AsyncClient must be used:
import asyncio
from httpx import AsyncClient 

async def example_use():
    async with AsyncClient(headers={"User-Agent": "webscraping.fyi"}) as client:
        response = await client.get("http://httpbing.org/get")
        # to schedule multiple requests concurrently use asyncio gather or as_completed
        three_concurrent_responses = await asyncio.gather(
            client.get("http://httpbing.org/get"),
            client.get("http://httpbing.org/get"),
            client.get("http://httpbing.org/get"),
        )

asyncio.run(example_use())

Alternatives / Similar


51,138 2.31.0 (10 months ago) Feb 14 2011 compare
14,508 3.9.3 (2 months ago) Jul 26 2019 compare
1,041 7.45.3 (a month ago) Feb 25 2003 compare
583 23.11.0 (5 months ago) Dec 28 2012 compare

Other Languages

8,631 3.3.2 (4 months ago) Dec 28 2012 compare
103,590 1.6.7 (a month ago) Aug 29 2014 compare
got
13,904 14.2.1 (30 days ago) Mar 27 2014 compare
16,536 8.1.2 (7 months ago) Aug 22 2011 compare
1,611 3.3.1 (3 months ago) Dec 11 2011 compare
5,646 2.9.0 (2 months ago) Dec 19 2009 compare
697 2.8.3 (7 years ago) Jul 25 2009 compare
1,152 0.110.0 (24 days ago) Oct 31 2009 compare
5,745 0.21.0 (1 year, 3 months ago) Jul 25 2009 compare
4,057 1.4.1 (4 months ago) Oct 06 2009 compare
979 1.4.7 (10 months ago) May 06 2012 compare
1,455 1.0.4 (1 year, 7 months ago) Nov 22 2014 compare
22,795 7.8.0 (7 months ago) Nov 14 2011 compare
1,218 1.1.7 (3 years ago) Oct 25 2009 compare
383 18.1.0 (2 months ago) Aug 06 2011 compare
1,869 v7.0.6 (4 days ago) Apr 28 2019 compare
876 0.11.0 (3 years ago) Sep 25 2013 compare
101 1.4.0 (1 year, 7 months ago) Nov 09 2016 compare
9,116 v2.11.0 (3 months ago) Aug 25 2018 compare
req
3,977 v3.43.1 (25 days ago) Jun 08 2023 compare
506 1.1.4 (4 years ago) Apr 20 2010 compare
3,555 v2.0.11 (11 days ago) Oct 06 2013 compare
1,918 1.2.1 (2 years ago) Nov 11 2011 compare
1,732 0.3.2 (4 years ago) Apr 14 2012 compare
153 2.2.4 (3 years ago) Dec 22 2019 compare
2,983 0.12.0 (6 years ago) Mar 20 2015 compare