requests

Dispatch provides a built-in integration with requests, offering proper error handling out of the box. It’s enabled by default and it takes no extra code to set it up.

import dispatch
import requests


@dispatch.function
def fetch_cat_fact():
    response = requests.get("https://cat-facts.dispatch.run")

    # Raise `requests.HTTPError` exception when request is not successful
    response.raise_for_status()

    return response.text


def main():
    fetch_cat_fact.dispatch()


dispatch.run(main)

Exception handling

HTTPError

Depending on the status_code attribute, a different Dispatch behavior is applied.

HTTP status code	Description	Dispatch status
1xx	Informational	Status.PERMANENT_ERROR
2xx	Successful	Status.OK
3xx	Redirection	Status.PERMANENT_ERROR
3xx	Redirection	Status.PERMANENT_ERROR
4xx	Client error	Status.PERMANENT_ERROR
400	Bad request	Status.INVALID_ARGUMENT
401	Unauthorized	Status.UNAUTHENTICATED
403	Forbidden	Status.PERMISSION_DENIED
404	Not found	Status.NOT_FOUND
408	Request timeout	Status.TIMEOUT
429	Too many requests	Status.THROTTLED
5xx	Server error	Status.TEMPORARY_ERROR
501	Not implemented	Status.PERMANENT_ERROR

Timeout

Returns STATUS.TIMEOUT.

RequestException

Returns Status.TEMPORARY_ERROR, unless exception is HTTPError or Timeout, since RequestException is a parent class of these. Learn more in requests documentation.

Response handling

If a function returns requests.Response instance, Dispatch looks at the status_code attribute and determines behavior the same way as HTTPError exception.

import dispatch


@dispatch.function
def fetch_cat_fact():
    response = httpx.get("https://cat-facts.dispatch.run")
    return response