feat (status_codes): update HTTP status constants wrt RFC 9110

README.rst

@@ -573,7 +573,7 @@ Note that this example assumes that the
                 msg = ('The size of the request is too large. The body must not '
                        'exceed ' + str(limit) + ' bytes in length.')
 
-                raise falcon.HTTPPayloadTooLarge(
+                raise falcon.HTTPContentTooLarge(
                     title='Request body is too large', description=msg)
 
         return hook
@@ -830,7 +830,7 @@ Here's the ASGI version of the app from above. Note that it uses the
                 msg = ('The size of the request is too large. The body must not '
                        'exceed ' + str(limit) + ' bytes in length.')
 
-                raise falcon.HTTPPayloadTooLarge(
+                raise falcon.HTTPContentTooLarge(
                     title='Request body is too large', description=msg)
 
         return hook

docs/_newsfragments/2330.newandimproved.rst

@@ -0,0 +1 @@
+refactor: Replaced :class:`~falcon.HTTPPayloadTooLarge` with :class:`~falcon.HTTPContentTooLarge` to align with the updated class name.

docs/api/errors.rst

@@ -150,7 +150,7 @@ Predefined Errors
 .. autoclass:: falcon.HTTPPreconditionFailed
     :members:
 
-.. autoclass:: falcon.HTTPPayloadTooLarge
+.. autoclass:: falcon.HTTPContentTooLarge
     :members:
 
 .. autoclass:: falcon.HTTPUriTooLong

docs/api/status.rst

@@ -168,7 +168,7 @@ HTTPStatus
     HTTP_410 = '410 Gone'
     HTTP_411 = '411 Length Required'
     HTTP_412 = '412 Precondition Failed'
-    HTTP_413 = '413 Payload Too Large'
+    HTTP_413 = '413 Content Too Large'
     HTTP_414 = '414 URI Too Long'
     HTTP_415 = '415 Unsupported Media Type'
     HTTP_416 = '416 Range Not Satisfiable'

docs/changes/2.0.0.rst

@@ -364,7 +364,7 @@ Fixed
 - The :meth:`~falcon.testing.TestClient.simulate_request` method now forces
   header values to `str` on Python 2 as required by PEP-3333.
 - The ``HTTPRequestEntityTooLarge`` class was renamed to
-  :class:`~falcon.HTTPPayloadTooLarge` and the reason phrase was updated
+  :class:`~falcon.HTTPContentTooLarge` and the reason phrase was updated
   per RFC 7231.
 - The  :class:`falcon.CaseInsensitiveDict` class now inherits from
   :class:`collections.abc.MutableMapping` under Python 3, instead of

examples/things_advanced.py

@@ -141,7 +141,7 @@ def hook(req, resp, resource, params):
                 'exceed ' + str(limit) + ' bytes in length.'
             )
 
-            raise falcon.HTTPPayloadTooLarge(
+            raise falcon.HTTPContentTooLarge(
                 title='Request body is too large', description=msg
             )
 

examples/things_advanced_asgi.py

@@ -143,7 +143,7 @@ async def hook(req, resp, resource, params):
                 'exceed ' + str(limit) + ' bytes in length.'
             )
 
-            raise falcon.HTTPPayloadTooLarge(
+            raise falcon.HTTPContentTooLarge(
                 title='Request body is too large', description=msg
             )
 

falcon/__init__.py

@@ -124,7 +124,7 @@
     'HTTPNotAcceptable',
     'HTTPNotFound',
     'HTTPNotImplemented',
-    'HTTPPayloadTooLarge',
+    'HTTPContentTooLarge',
     'HTTPPreconditionFailed',
     'HTTPPreconditionRequired',
     'HTTPRangeNotSatisfiable',
@@ -355,6 +355,7 @@
 from falcon.errors import HTTPBadGateway
 from falcon.errors import HTTPBadRequest
 from falcon.errors import HTTPConflict
+from falcon.errors import HTTPContentTooLarge
 from falcon.errors import HTTPFailedDependency
 from falcon.errors import HTTPForbidden
 from falcon.errors import HTTPGatewayTimeout
@@ -373,7 +374,6 @@
 from falcon.errors import HTTPNotAcceptable
 from falcon.errors import HTTPNotFound
 from falcon.errors import HTTPNotImplemented
-from falcon.errors import HTTPPayloadTooLarge
 from falcon.errors import HTTPPreconditionFailed
 from falcon.errors import HTTPPreconditionRequired
 from falcon.errors import HTTPRangeNotSatisfiable
@@ -530,6 +530,7 @@
 from falcon.status_codes import HTTP_BAD_GATEWAY
 from falcon.status_codes import HTTP_BAD_REQUEST
 from falcon.status_codes import HTTP_CONFLICT
+from falcon.status_codes import HTTP_CONTENT_TOO_LARGE
 from falcon.status_codes import HTTP_CONTINUE
 from falcon.status_codes import HTTP_CREATED
 from falcon.status_codes import HTTP_EARLY_HINTS
@@ -568,7 +569,6 @@
 from falcon.status_codes import HTTP_PRECONDITION_REQUIRED
 from falcon.status_codes import HTTP_PROCESSING
 from falcon.status_codes import HTTP_PROXY_AUTHENTICATION_REQUIRED
-from falcon.status_codes import HTTP_REQUEST_ENTITY_TOO_LARGE
 from falcon.status_codes import HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE
 from falcon.status_codes import HTTP_REQUEST_TIMEOUT
 from falcon.status_codes import HTTP_REQUEST_URI_TOO_LONG

falcon/errors.py

@@ -74,7 +74,7 @@ def on_get(self, req, resp):
     'HTTPNotAcceptable',
     'HTTPNotFound',
     'HTTPNotImplemented',
-    'HTTPPayloadTooLarge',
+    'HTTPContentTooLarge',
     'HTTPPreconditionFailed',
     'HTTPPreconditionRequired',
     'HTTPRangeNotSatisfiable',
@@ -952,8 +952,8 @@ def __init__(
         )
 
 
-class HTTPPayloadTooLarge(HTTPError):
-    """413 Payload Too Large.
+class HTTPContentTooLarge(HTTPError):
+    """413 Content Too Large.
 
     The server is refusing to process a request because the request
     payload is larger than the server is willing or able to process.

falcon/status_codes.py

@@ -93,7 +93,8 @@
 HTTP_LENGTH_REQUIRED: Final[str] = HTTP_411
 HTTP_412: Final[str] = '412 Precondition Failed'
 HTTP_PRECONDITION_FAILED: Final[str] = HTTP_412
-HTTP_413: Final[str] = '413 Payload Too Large'
+HTTP_413: Final[str] = '413 Content Too Large'
+HTTP_CONTENT_TOO_LARGE: Final[str] = HTTP_413
 HTTP_REQUEST_ENTITY_TOO_LARGE: Final[str] = HTTP_413
 HTTP_414: Final[str] = '414 URI Too Long'
 HTTP_REQUEST_URI_TOO_LONG: Final[str] = HTTP_414
@@ -330,6 +331,7 @@
     'HTTP_BAD_GATEWAY',
     'HTTP_BAD_REQUEST',
     'HTTP_CONFLICT',
+    'HTTP_CONTENT_TOO_LARGE',
     'HTTP_CONTINUE',
     'HTTP_CREATED',
     'HTTP_EARLY_HINTS',
@@ -369,7 +371,6 @@
     'HTTP_PROCESSING',
     'HTTP_PROXY_AUTHENTICATION_REQUIRED',
     'HTTP_REQUESTED_RANGE_NOT_SATISFIABLE',
-    'HTTP_REQUEST_ENTITY_TOO_LARGE',
     'HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE',
     'HTTP_REQUEST_TIMEOUT',
     'HTTP_REQUEST_URI_TOO_LONG',

tests/test_error.py

@@ -19,7 +19,7 @@
         (falcon.HTTPGone, status.HTTP_410),
         (falcon.HTTPLengthRequired, status.HTTP_411),
         (falcon.HTTPPreconditionFailed, status.HTTP_412),
-        (falcon.HTTPPayloadTooLarge, status.HTTP_413),
+        (falcon.HTTPContentTooLarge, status.HTTP_413),
         (falcon.HTTPUriTooLong, status.HTTP_414),
         (falcon.HTTPUnsupportedMediaType, status.HTTP_415),
         (falcon.HTTPUnprocessableEntity, status.HTTP_422),
@@ -82,7 +82,7 @@ def test_with_default_title_and_desc_args(err, title, args):
         falcon.HTTPGone,
         falcon.HTTPLengthRequired,
         falcon.HTTPPreconditionFailed,
-        falcon.HTTPPayloadTooLarge,
+        falcon.HTTPContentTooLarge,
         falcon.HTTPUriTooLong,
         falcon.HTTPUnsupportedMediaType,
         falcon.HTTPUnprocessableEntity,
@@ -129,7 +129,7 @@ def test_with_title_desc_and_headers(err):
         falcon.HTTPGone,
         falcon.HTTPLengthRequired,
         falcon.HTTPPreconditionFailed,
-        falcon.HTTPPayloadTooLarge,
+        falcon.HTTPContentTooLarge,
         falcon.HTTPUriTooLong,
         falcon.HTTPUnsupportedMediaType,
         falcon.HTTPUnprocessableEntity,
@@ -202,7 +202,7 @@ def test_args_kw_only(err, args):
     [
         falcon.HTTPServiceUnavailable,
         falcon.HTTPTooManyRequests,
-        falcon.HTTPPayloadTooLarge,
+        falcon.HTTPContentTooLarge,
     ],
 )
 def test_with_retry_after(err):
@@ -217,7 +217,7 @@ def test_with_retry_after(err):
     [
         falcon.HTTPServiceUnavailable,
         falcon.HTTPTooManyRequests,
-        falcon.HTTPPayloadTooLarge,
+        falcon.HTTPContentTooLarge,
     ],
 )
 def test_with_retry_after_and_headers(err):
@@ -290,7 +290,7 @@ def test_custom_400(err, args, title, desc):
             'a, b',
             True,
         ),
-        (falcon.HTTPPayloadTooLarge, 'Retry-After', 'retry_after', 123, '123', False),
+        (falcon.HTTPContentTooLarge, 'Retry-After', 'retry_after', 123, '123', False),
         (
             falcon.HTTPRangeNotSatisfiable,
             'Content-Range',

tests/test_httperror.py

@@ -172,7 +172,7 @@ def on_get(self, req, resp):
 
 class RequestEntityTooLongResource:
     def on_get(self, req, resp):
-        raise falcon.HTTPPayloadTooLarge(
+        raise falcon.HTTPContentTooLarge(
             title='Request Rejected', description='Request Body Too Large'
         )
 
@@ -182,7 +182,7 @@ def __init__(self, retry_after):
         self.retry_after = retry_after
 
     def on_get(self, req, resp):
-        raise falcon.HTTPPayloadTooLarge(
+        raise falcon.HTTPContentTooLarge(
             title='Request Rejected',
             description='Request Body Too Large',
             retry_after=self.retry_after,