Skip to content

treq

583 13 58 MIT/X
23.11.0 (4 Nov 2023) Dec 28 2012 103.4 thousand (month)

treq is a Python library for making HTTP requests that provides a simple, convenient API for interacting with web services. It is inspired byt the popular requests library, but powered by Twisted asynchronous engine which allows promise based concurrency.

treq provides a simple, high-level API for making HTTP requests, including methods for GET, POST, PUT, DELETE, etc. It also allows for easy handling of JSON data, automatic decompression of gzipped responses, and connection pooling.

treq is a lightweight library and it's easy to use, it's a good choice for small to medium-sized projects where ease of use is more important than performance.

In web scraping treq isn't commonly used as it doesn't support HTTP2 but it's the only Twisted based HTTP client. treq is also based on callback/errback promises (like Scrapy) which can be easier to understand and maintain compared to asyncio's corountines.

Highlights


uses-twistedno-http2

Example Use


from twisted.internet import reactor
from twisted.internet.task import react
from twisted.internet.defer import ensureDeferred
import treq

# treq can be used with twisted's reactor with callbacks
response_deferred = treq.get(
    "http://httpbin.org/get"
)
# or POST
response_deferred = treq.post(
    "http://httpbin.org/post",
    json={"key": "value"},  # JSON
    data={"key": "value"},  # Form Data
)

# add callback or errback
def handle_response(response):
    print(response.code)
    response.text().addCallback(lambda body: print(body))
def handle_error(failure):
    print(failure)
# this callback will be called when request completes:
response_deferred.addCallback(handle_response)
# this errback will be called if request fails
response_deferred.addErrback(handle_error)
# this will be called if request completes or fails:
response_deferred.addBoth(lambda _: reactor.stop())  # close twisted once finished

if __name__ == '__main__':
    reactor.run()

#Note that treq can also be used with async/await:
async def main():
    # content reads response data and get sends a get request:
    print(await treq.content(await treq.get("https://example.com/")))

if __name__ == '__main__':
    react(lambda reactor: ensureDeferred(main()))
```

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
12,154 0.27.0 (a month ago) Jul 26 2019 compare
1,041 7.45.3 (a month ago) Feb 25 2003 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