Skip to content

restyvstreq

MIT 8 1 10,249
58.1 thousand (month) Oct 10 2019 v3.0.0-alpha.2(8 days ago)
587 14 58 NOASSERTION
Dec 28 2012 155.0 thousand (month) 23.11.0(1 year, 1 month ago)

Resty is an HTTP and REST client library for Go. It is designed to be simple and easy to use, while still providing a lot of powerful features. One of the main benefits of using Resty is that it allows you to make HTTP requests with minimal boilerplate code, while still providing a lot of flexibility and control over the requests.

One of the key features of Resty is its use of chaining. This allows you to chain together multiple methods to build up a request, making the code more readable and easy to understand. For example, you can chain together the R().SetHeader("Accept", "application/json") method to set the Accept header and R().SetQueryParam("param1", "value1") to add a query parameter to the request.

Resty also provides a lot of convenience functions for making common types of requests, such as Get, Post, Put, and Delete. This can be useful if you need to make a simple request quickly and don't want to spend a lot of time configuring the request. Additionally, Resty also provides a way to set a timeout for the request, in case the server takes too long to respond.

Resty also supports HTTP/2 and advanced features like multipart file upload, request and response middlewares, request hooks, and many others.

Overall, Resty is a good choice if you're looking for a simple and easy-to-use HTTP client library for Go. It's a good fit for projects that don't require a lot of customization and need a quick way to make HTTP requests.

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


package main

// establish session client
client := resty.New()
// set proxy for the session
client.SetProxy("http://proxyserver:8888")
// set retries
client.
    // Set retry count to non zero to enable retries
    SetRetryCount(3).
    // You can override initial retry wait time.
    // Default is 100 milliseconds.
    SetRetryWaitTime(5 * time.Second).
    // MaxWaitTime can be overridden as well.
    // Default is 2 seconds.
    SetRetryMaxWaitTime(20 * time.Second).
    // SetRetryAfter sets callback to calculate wait time between retries.
    // Default (nil) implies exponential backoff with jitter
    SetRetryAfter(func(client *resty.Client, resp *resty.Response) (time.Duration, error) {
        return 0, errors.New("quota exceeded")
    })

// Make GET request
resp, err := client.R().
    // we can set query
    SetQueryParams(map[string]string{
        "query": "foo",
    }).
    // and headers
    SetHeader("Accept", "application/json").
    Get("https://httpbin.org/get")

// Make Post request
resp, err := client.R().
    // JSON data
    SetHeader("Content-Type", "application/json").
    SetBody(`{"username":"testuser", "password":"testpass"}`).
    // or Form Data
    SetFormData(map[string]string{
      "username": "jeeva",
      "password": "mypass",
    }).
    Post("https://httpbin.org/post")

// resty also support request and response middlewares
// which allow easy modification of outgoing requests and incoming responses
client.OnBeforeRequest(func(c *resty.Client, req *resty.Request) error {
    // Now you have access to Client and current Request object
    // manipulate it as per your need

    return nil  // if its success otherwise return error
  })

// Registering Response Middleware
client.OnAfterResponse(func(c *resty.Client, resp *resty.Response) error {
    // Now you have access to Client and current Response object
    // manipulate it as per your need

    return nil  // if its success otherwise return error
  })
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


Was this page helpful?