kennethreitz/requests
1
0
Fork 0
mirror of https://github.com/kennethreitz/requests.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docstrings for Response.__{bool,nonzero}__

Browse Source 
Like the docstring added to Response.ok these were misleading and
vaguely incorrect. Better to be explicit than implicit.
This commit is contained in:
Ian Cordasco
2017-02-16 07:21:15 -06:00
parent 7a281e74ec
commit 8e049bd9eb
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
requests/models.py
+14 -2
View File
@@ -659,11 +659,23 @@ class Response(object):
return '<Response [%s]>' % (self.status_code)
def __bool__(self):
"""Returns true if :attr:`status_code` is 'OK'."""
"""Returns True if :attr:`status_code` is less than 400.
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``.
"""
return self.ok
def __nonzero__(self):
"""Returns true if :attr:`status_code` is 'OK'."""
"""Returns True if :attr:`status_code` is less than 400.
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``.
"""
return self.ok
def __iter__(self):