Skip to content

gh-95149: Enhance http.HTTPStatus with properties that indicate the HTTP status category #95453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions Doc/library/http.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,31 @@ equal to the constant name (i.e. ``http.HTTPStatus.OK`` is also available as
.. versionadded:: 3.9
Added ``103 EARLY_HINTS``, ``418 IM_A_TEAPOT`` and ``425 TOO_EARLY`` status codes.

HTTP status category
--------------------

.. versionadded:: 3.11

The enum values have several properties to indicate the HTTP status category:

==================== ======================== ===============================
Property Indicates that Details
==================== ======================== ===============================
``is_informational`` ``100 <= status <= 199`` HTTP/1.1 :rfc:`7231`, Section 6
``is_success`` ``200 <= status <= 299`` HTTP/1.1 :rfc:`7231`, Section 6
``is_redirection`` ``300 <= status <= 399`` HTTP/1.1 :rfc:`7231`, Section 6
``is_client_error`` ``400 <= status <= 499`` HTTP/1.1 :rfc:`7231`, Section 6
``is_server_error`` ``500 <= status <= 599`` HTTP/1.1 :rfc:`7231`, Section 6
==================== ======================== ===============================

Usage::

>>> from http import HTTPStatus
>>> HTTPStatus.OK.is_success
True
>>> HTTPStatus.OK.is_client_error
False

.. class:: HTTPMethod

.. versionadded:: 3.11
Expand Down
2 changes: 1 addition & 1 deletion Lib/enum.py
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ def _test_simple_enum(checked_enum, simple_enum):
else:
checked_value = checked_dict[key]
simple_value = simple_dict[key]
if callable(checked_value):
if callable(checked_value) or isinstance(checked_value, bltns.property):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

continue
if key == '__doc__':
# remove all spaces/tabs
Expand Down
20 changes: 20 additions & 0 deletions Lib/http/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,26 @@ def __new__(cls, value, phrase, description=''):
obj.description = description
return obj

@property
def is_informational(self):
return 100 <= self <= 199

@property
def is_success(self):
return 200 <= self <= 299

@property
def is_redirection(self):
return 300 <= self <= 399

@property
def is_client_error(self):
return 400 <= self <= 499

@property
def is_server_error(self):
return 500 <= self <= 599

# informational
CONTINUE = 100, 'Continue', 'Request received, please continue'
SWITCHING_PROTOCOLS = (101, 'Switching Protocols',
Expand Down
45 changes: 45 additions & 0 deletions Lib/test/test_httplib.py
Original file line number Diff line number Diff line change
Expand Up @@ -553,6 +553,27 @@ def __new__(cls, value, phrase, description=''):
obj.phrase = phrase
obj.description = description
return obj

@property
def is_informational(self):
return 100 <= self <= 199

@property
def is_success(self):
return 200 <= self <= 299

@property
def is_redirection(self):
return 300 <= self <= 399

@property
def is_client_error(self):
return 400 <= self <= 499

@property
def is_server_error(self):
return 500 <= self <= 599

# informational
CONTINUE = 100, 'Continue', 'Request received, please continue'
SWITCHING_PROTOCOLS = (101, 'Switching Protocols',
Expand Down Expand Up @@ -669,6 +690,30 @@ def __new__(cls, value, phrase, description=''):
'The client needs to authenticate to gain network access')
enum._test_simple_enum(CheckedHTTPStatus, HTTPStatus)

def test_httpstatus_range(self):
"""Checks that the statuses are in the 100-599 range"""

for member in HTTPStatus.__members__.values():
self.assertGreaterEqual(member, 100)
self.assertLessEqual(member, 599)

def test_httpstatus_category(self):
"""Checks that the statuses belong to the standard categories"""

categories = (
((100, 199), "is_informational"),
((200, 299), "is_success"),
((300, 399), "is_redirection"),
((400, 499), "is_client_error"),
((500, 599), "is_server_error"),
)
for member in HTTPStatus.__members__.values():
for (lower, upper), category in categories:
category_indicator = getattr(member, category)
if lower <= member <= upper:
self.assertTrue(category_indicator)
else:
self.assertFalse(category_indicator)

def test_status_lines(self):
# Test HTTP status lines
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
The :class:`HTTPStatus <http.HTTPStatus>` enum offers a couple of properties
to indicate the HTTP status category e.g. ``HTTPStatus.OK.is_success``.
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy