Repository navigation
Enhance http.HTTPStatus with is_* properties that indicate the HTTP status category #95149
Description
Feature or enhancement
Add five properties to http.HTTPStatus that indicate the category the status belongs to:
class HTTPStatus:
...
@property
def is_informational(self):
return 100 <= self < 200
@property
def is_success(self):
return 200 <= self < 300
@property
def is_redirection(self):
return 300 <= self < 400
@property
def is_client_error(self):
return 400 <= self < 500
@property
def is_server_error(self):
return 500 <= self < 600Pitch
Programs that deal with HTTP requests usually need to deal with the various status codes. Oftentimes, knowing the broad category is sufficient to make quick decisions. For example, a client needs to handle responses differently depending on the status code. Assuming status is an HTTPStatus, instead of writing:
if 200 <= status < 300:
handle_response(response)
elif 300 <= status < 400:
handle_redirect(response)
elif 400 <= status < 500:
raise ClientError(status)
elif 500 <= status < 600:
maybe_retry(response.request)One could more elegantly write:
if status.is_success:
handle_response(response)
elif status.is_redirection:
handle_redirect(response)
elif status.is_client_error:
raise ClientError(status)
elif status.is_server_error:
maybe_retry(response.request)Enums are safer, more readable and more expressive than magic numbers. I think these small additions would only strengthen HTTPStatus.
Let me know if this interests you, and I can open a PR.
Activity
itaispiegel commentedon Jul 23, 2022
I like this idea :)
corona10 commentedon Jul 28, 2022
@alexei
Would you like to submit the patch?
gh-95149: Enhance `http.HTTPStatus` with properties that indicate the…
alexei commentedon Sep 5, 2022
This is going to be available starting 3.12, see #95453