Requests — how to tell if you're getting a success message?

Question

My question is closely related to this one.

I'm using the Requests library to hit an HTTP endpoint. I want to check if the response is a success.

I am currently doing this:

r = requests.get(url)
if 200 <= response.status_code <= 299:
    # Do something here!

Instead of doing that ugly check for values between 200 and 299, is there a shorthand I can use?

score 86 · Answer 1 · edited Sep 24 '22 at 01:18

86

The response has an ok property. Use that:

if response.ok:
    ...

The implementation is just a try/except around Response.raise_for_status, which is itself checks the status code.

@property
def ok(self):
    """Returns True if :attr:`status_code` is less than 400, False if not.

    This attribute checks if the status code of the response is between
    400 and 600 to see if there was a client error or a server error. If
    the status code is between 200 and 400, this will return True. This
    is **not** a check to see if the response code is ``200 OK``.
    """
    try:
        self.raise_for_status()
    except HTTPError:
        return False
    return True

edited Sep 24 '22 at 01:18

metadaddy

4,234
1
22
46

answered Nov 06 '17 at 19:51

wim

338,267
99
616
750

Note that this counts the 3xx redirection range as okay, unlike the code in the question. – user2357112 Nov 06 '17 at 19:54
4

I don't think you'll usually see a 300-range status anyway, since `requests` is going to follow the redirect. You'll get the status of the URL you were redirected to. – kindall Nov 06 '17 at 20:07
2

It won't follow redirects if you pass `allow_redirects=False` – bcb Jan 22 '20 at 05:59
1

I think also the problem with this might be 1xx responses, which won't raise for status and aren't in the range of code in the question either. – tikej Aug 18 '20 at 10:01

score 15 · Answer 2 · answered Apr 25 '19 at 15:05

15

I am a Python newbie but I think the easiest way is:

if response.ok:
    # whatever

answered Apr 25 '19 at 15:05

aruizca

1,891
1
19
13

score 12 · Answer 3 · answered Oct 19 '19 at 17:26

The pythonic way to check for requests success would be to optionally raise an exception with

try:
    resp = requests.get(url)
    resp.raise_for_status()
except requests.exceptions.HTTPError as err:
    print(err)

EAFP: It’s Easier to Ask for Forgiveness than Permission: You should just do what you expect to work and if an exception might be thrown from the operation then catch it and deal with that fact.

score -2 · Answer 4 · answered Mar 13 '23 at 10:45

-2

You could also do:

r = requests.get(url)
if response.status_code // 100 == 2:
    # Do something here!

answered Mar 13 '23 at 10:45

Margarida Paixao

1

Requests — how to tell if you're getting a success message?

4 Answers4

Linked