Skip to content

treqvstyphoeus

MIT/X 58 13 583
103.4 thousand (month) Dec 28 2012 23.11.0(5 months ago)
4,057 15 142 MIT
1.4.1(4 months ago) Oct 06 2009 946.7 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.

Typhoeus is a Ruby library that allows you to make parallel HTTP requests, which can greatly speed up the process of making multiple requests to different servers. It is built on top of the C library libcurl, which is known for its high performance and reliability.

One of the main features of Typhoeus is its ability to make parallel requests. This means that it can send multiple requests at the same time, and wait for all of them to finish before returning the results. This can greatly reduce the time it takes to make multiple requests, as it eliminates the need to wait for each request to complete before sending the next one.

In addition to its parallelism feature, Typhoeus also provides a convenient and easy-to-use Ruby interface for making HTTP requests. It supports all of the common HTTP methods (GET, POST, PUT, DELETE, etc.) and allows you to set various request options, such as headers, timeouts, and authentication. It also supports streaming responses, which allows you to process large responses piece by piece, rather than loading the entire response into memory at once.

Typhoeus is also supports HTTP/2 protocol which provides faster load times and reduced network usage. It also supports streaming which is an essential feature for large data transfer.

Typhoeus is well-documented, actively maintained, and has a large and active community of users. It is widely used in the Ruby ecosystem and is a popular choice for building high-performance web scraping and data-gathering applications.

Note that Typhoeus can also be used as an adapter in popular alternative package Faraday.

Highlights


uses-twistedno-http2
http2asyncuses-curl

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()))
</div>
<div class="lib-example" markdown>

```go
# GET request
Typhoeus.get("www.example.com")
# POST request
Typhoeus.post("www.example.com/posts", body: { title: "test post", content: "this is my test"})

# make parallel requests:
# hydra is a request queue manager
hydra = Typhoeus::Hydra.hydra
# create request object
first_request = Typhoeus::Request.new("http://example.com/posts/1")
# add complete callbacks
first_request.on_complete do |response|
  # callbacks can queue new requests
  third_url = response.body
  third_request = Typhoeus::Request.new(third_url)
  hydra.queue third_request
end
second_request = Typhoeus::Request.new("http://example.com/posts/2")
# queue requests:
hydra.queue first_request
hydra.queue second_request

hydra.run # this is a blocking call that returns once all requests are complete

Alternatives / Similar