gh-102247: Update HTTP status codes in http package to match rfc9110 #102570

yeojin-dev · 2023-03-10T01:36:53Z

References

308 Permanent Redirect
- https://www.rfc-editor.org/rfc/rfc9110.html#name-changes-from-rfc-7231
413 Content Too Large
- https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large
421 Misdirected Request
- https://www.rfc-editor.org/rfc/rfc9110.html#name-changes-from-rfc-7231
422 Unprocessable Content
- https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content

Issue: Update HTTP status codes in http package to match rfc9110 #102247

corona10

You have to notify the change to the whatsnews
Please refer to the similar commit.
corona10@a8e9348

corona10 · 2023-03-10T01:55:12Z

Doc/library/http.rst

-``421`` ``MISDIRECTED_REQUEST``             HTTP/2 :rfc:`7540`, Section 9.1.2
-``422`` ``UNPROCESSABLE_ENTITY``            WebDAV :rfc:`4918`, Section 11.2
+``421`` ``MISDIRECTED_REQUEST``             HTTP Semantics :rfc:`9110`, Section 15.5.20
+``422`` ``UNPROCESSABLE_CONTENT``           HTTP Semantics :rfc:`9110`, Section 15.5.21


You have to notify the change with the versionchanged tag.

bedevere-bot · 2023-03-10T01:57:00Z

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

corona10 · 2023-03-10T01:57:45Z

@serhiy-storchaka
Can you please take a look?
I am not sure that we can accept the change of existence HTTP status code.

corona10 · 2023-03-10T02:02:03Z

Lib/http/__init__.py

@@ -130,7 +131,7 @@ def is_server_error(self):
        'Server refuses to brew coffee because it is a teapot.')
    MISDIRECTED_REQUEST = (421, 'Misdirected Request',
        'Server is not able to produce a response')
-    UNPROCESSABLE_ENTITY = 422, 'Unprocessable Entity'
+    UNPROCESSABLE_CONTENT = 422, 'Unprocessable Content'


One of the problems of removing this constant is that it will break end-user code.

This is one example
https://github.com/aiven/karapace/blob/88bee3ab15115fca80b8f74020ebb30a3b562ffe/karapace/karapace.py#L41-L46

Even if we decide to accept this change, we may need to add deprecation period rather than direct removing.

I think we have to keep the old names as aliases for the new ones. I would continue to support them indefinitely, even -- deprecations and breaking things has a cost, and supporting a few extra constant names indefinitely is essentially free, so it's not worth spending our limited breakage budget on it.

corona10 · 2023-03-10T10:10:24Z

Lib/test/test_httplib.py

@@ -1688,14 +1688,14 @@ def test_client_constants(self):
            'GONE',
            'LENGTH_REQUIRED',
            'PRECONDITION_FAILED',
-            'REQUEST_ENTITY_TOO_LARGE',


Please maintain old constants

corona10 · 2023-03-10T10:10:33Z

Lib/test/test_httplib.py

            'REQUEST_URI_TOO_LONG',
            'UNSUPPORTED_MEDIA_TYPE',
            'REQUESTED_RANGE_NOT_SATISFIABLE',
            'EXPECTATION_FAILED',
            'IM_A_TEAPOT',
            'MISDIRECTED_REQUEST',
-            'UNPROCESSABLE_ENTITY',


corona10 · 2023-03-10T14:23:42Z

Lib/test/test_httplib.py

@@ -525,7 +525,8 @@ def test_dir_with_added_behavior_on_status(self):
        self.assertTrue({'description', 'name', 'phrase', 'value'} <= set(dir(HTTPStatus(404))))

    def test_simple_httpstatus(self):
-        class CheckedHTTPStatus(enum.IntEnum):
+        @enum._simple_enum(enum.IntEnum)


I don't think that this change is the proper approach to fixing the test suite issue.
see

cpython/Lib/enum.py

Lines 1896 to 1913 in 53dceb5

def _test_simple_enum(checked_enum, simple_enum):

"""

A function that can be used to test an enum created with :func:`_simple_enum`

against the version created by subclassing :class:`Enum`::

>>> from enum import Enum, _simple_enum, _test_simple_enum

>>> @_simple_enum(Enum)

... class Color:

... RED = auto()

... GREEN = auto()

... BLUE = auto()

>>> class CheckedColor(Enum):

... RED = auto()

... GREEN = auto()

... BLUE = auto()

>>> _test_simple_enum(CheckedColor, Color)

If differences are found, a :exc:`TypeError` is raised.

I was wondering about the different use of enum in HTTPStatus and CheckedHTTPStatus, so I'm going to change it back.

corona10 · 2023-03-10T14:44:48Z

@ethanfurman

It looks like _test_simple_enum doesn't support alias cases.
Do you have any recommended way or do we have to fix _test_simple_enum to support the alias case?

cpython/Lib/enum.py

Lines 1896 to 1913 in 53dceb5

    
           def _test_simple_enum(checked_enum, simple_enum): 
        
               """ 
        
               A function that can be used to test an enum created with :func:`_simple_enum` 
        
               against the version created by subclassing :class:`Enum`:: 
        
                   >>> from enum import Enum, _simple_enum, _test_simple_enum 
        
                   >>> @_simple_enum(Enum) 
        
                   ... class Color: 
        
                   ...     RED = auto() 
        
                   ...     GREEN = auto() 
        
                   ...     BLUE = auto() 
        
                   >>> class CheckedColor(Enum): 
        
                   ...     RED = auto() 
        
                   ...     GREEN = auto() 
        
                   ...     BLUE = auto() 
        
                   >>> _test_simple_enum(CheckedColor, Color) 
        
               If differences are found, a :exc:`TypeError` is raised.

corona10

Please revert #102570 (comment)
and wait @ethanfurman 's advice.

This reverts commit 90bf421.

yeojin-dev added 3 commits March 10, 2023 10:20

Update HTTP status codes in httplib package to match rfc9110

944e2de

Update docstring

e4bdf25

Fix typo

14bc8ea

bedevere-bot mentioned this pull request Mar 10, 2023

Update HTTP status codes in http package to match rfc9110 #102247

Closed

bedevere-bot added the awaiting review label Mar 10, 2023

corona10 requested a review from serhiy-storchaka March 10, 2023 01:54

corona10 requested changes Mar 10, 2023

View reviewed changes

bedevere-bot removed the awaiting review label Mar 10, 2023

bedevere-bot added the awaiting changes label Mar 10, 2023

corona10 changed the title ~~gh-102247 Update HTTP status codes in http package to match rfc9110~~ gh-102247: Update HTTP status codes in http package to match rfc9110 Mar 10, 2023

corona10 reviewed Mar 10, 2023

View reviewed changes

yeojin-dev added 2 commits March 10, 2023 18:11

Add legacy constants

999e811

Add docs

7757698

corona10 requested changes Mar 10, 2023

View reviewed changes

yeojin-dev added 2 commits March 10, 2023 19:59

Restore for backward compatibility

0273b0d

Use _simple_enum to equal HTTPStatus

90bf421

corona10 reviewed Mar 10, 2023

View reviewed changes

corona10 requested a review from ethanfurman March 10, 2023 14:43

corona10 requested changes Mar 10, 2023

View reviewed changes

Revert "Use _simple_enum to equal HTTPStatus"

8d70181

This reverts commit 90bf421.

yeojin-dev closed this Apr 5, 2023

yeojin-dev deleted the gh-102247 branch April 5, 2023 12:07

mbeijen mentioned this pull request Apr 7, 2024

gh-102247: http: support rfc9110 status codes #117611

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-102247: Update HTTP status codes in http package to match rfc9110 #102570

gh-102247: Update HTTP status codes in http package to match rfc9110 #102570

yeojin-dev commented Mar 10, 2023 •

edited by bedevere-bot

Loading

corona10 left a comment

corona10 Mar 10, 2023

bedevere-bot commented Mar 10, 2023

corona10 commented Mar 10, 2023

corona10 Mar 10, 2023

corona10 Mar 10, 2023 •

edited

Loading

njsmith Mar 10, 2023

corona10 Mar 10, 2023

corona10 Mar 10, 2023

corona10 Mar 10, 2023 •

edited

Loading

yeojin-dev Mar 10, 2023

corona10 commented Mar 10, 2023

corona10 left a comment

	def _test_simple_enum(checked_enum, simple_enum):
	"""
	A function that can be used to test an enum created with :func:`_simple_enum`
	against the version created by subclassing :class:`Enum`::

	>>> from enum import Enum, _simple_enum, _test_simple_enum
	>>> @_simple_enum(Enum)
	... class Color:
	... RED = auto()
	... GREEN = auto()
	... BLUE = auto()
	>>> class CheckedColor(Enum):
	... RED = auto()
	... GREEN = auto()
	... BLUE = auto()
	>>> _test_simple_enum(CheckedColor, Color)

	If differences are found, a :exc:`TypeError` is raised.

gh-102247: Update HTTP status codes in http package to match rfc9110 #102570

gh-102247: Update HTTP status codes in http package to match rfc9110 #102570

Conversation

yeojin-dev commented Mar 10, 2023 • edited by bedevere-bot Loading

corona10 left a comment

Choose a reason for hiding this comment

corona10 Mar 10, 2023

Choose a reason for hiding this comment

bedevere-bot commented Mar 10, 2023

corona10 commented Mar 10, 2023

corona10 Mar 10, 2023

Choose a reason for hiding this comment

corona10 Mar 10, 2023 • edited Loading

Choose a reason for hiding this comment

njsmith Mar 10, 2023

Choose a reason for hiding this comment

corona10 Mar 10, 2023

Choose a reason for hiding this comment

corona10 Mar 10, 2023

Choose a reason for hiding this comment

corona10 Mar 10, 2023 • edited Loading

Choose a reason for hiding this comment

yeojin-dev Mar 10, 2023

Choose a reason for hiding this comment

corona10 commented Mar 10, 2023

corona10 left a comment

Choose a reason for hiding this comment

yeojin-dev commented Mar 10, 2023 •

edited by bedevere-bot

Loading

corona10 Mar 10, 2023 •

edited

Loading

corona10 Mar 10, 2023 •

edited

Loading