Skip to content
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.

Sign up for GitHub

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

gh-127522: wsgiref: indicate that start_response objects should follow a specific protocol #127525

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −4
Open

gh-127522: wsgiref: indicate that start_response objects should follow a specific protocol #127525

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e55acbb
wsgiref: indicate that `start_response` objects should follow a speci…
picnixz Dec 2, 2024
6024412
Update wsgiref.rst
picnixz Dec 2, 2024
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
14 changes: 10 additions & 4 deletions Doc/library/wsgiref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,8 @@ in type annotations.
applications to set up dummy environments. It should NOT be used by actual WSGI
servers or applications, since the data is fake!

Example usage::
Example usage, where the *start_response* callable should follow the
:class:`.StartResponse` protocol::

from wsgiref.util import setup_testing_defaults
from wsgiref.simple_server import make_server
Expand Down Expand Up @@ -312,6 +313,8 @@ request. (E.g., using the :func:`shift_path_info` function from
as :mod:`wsgiref.simple_server`) is able to run a simple WSGI application
correctly.

The *start_response* callable should follow the :class:`.StartResponse` protocol.


.. class:: WSGIServer(server_address, RequestHandlerClass)

Expand Down Expand Up @@ -679,7 +682,9 @@ input, output, and error streams.

This method can access the current error using ``sys.exception()``,
and should pass that information to *start_response* when calling it (as
described in the "Error Handling" section of :pep:`3333`).
described in the "Error Handling" section of :pep:`3333`). In particular,
the *start_response* callable should follow the :class:`.StartResponse`
protocol.

The default implementation just uses the :attr:`error_status`,
:attr:`error_headers`, and :attr:`error_body` attributes to generate an output
Expand Down Expand Up @@ -781,7 +786,7 @@ in :pep:`3333`.
.. versionadded:: 3.11


.. class:: StartResponse()
.. class:: StartResponse

A :class:`typing.Protocol` describing :pep:`start_response()
<3333#the-start-response-callable>`
Expand Down Expand Up @@ -816,7 +821,8 @@ in :pep:`3333`.
Examples
--------

This is a working "Hello World" WSGI application::
This is a working "Hello World" WSGI application, where the *start_response*
callable should follow the :class:`.StartResponse` protocol::

"""
Every WSGI application must have an application object - a callable
Expand Down
Loading