Refactor WSGIEnvironment to use TypedDict#148708
Refactor WSGIEnvironment to use TypedDict#148708bangseongbeom wants to merge 1 commit intopython:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Refactors wsgiref.types.WSGIEnvironment from a plain dict[str, Any] alias into a TypedDict that enumerates key CGI/WSGI environ variables (per PEP 3333), while still permitting arbitrary extra keys via extra_items.
Changes:
- Replace
WSGIEnvironment: TypeAlias = dict[str, Any]with aTypedDictdefinition listing common WSGI/CGI keys. - Add typing imports needed for the new
TypedDictshape (TypedDict,NotRequired,Literal). - Allow additional environment keys by setting
extra_items=Any.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
picnixz
left a comment
picnixz
left a comment
There was a problem hiding this comment.
I am not fond of adding typing in the stdlib. This should be done in typeshed.
|
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 |
|
Oh my bad they are actually added in types.py. Ok this seems fine to me. However please use the issue that was used to add those types and please create a NEWS entry. |
As mentioned in #32335 (comment), this PR makes WSGIEnvironment use TypedDict. It has items for the CGI variables and WSGI variables specified in PEP 3333.
wsgi.multithread,wsgi.multiprocess, andwsgi.run_onceare typed asAnybecause they are only specified as being evaluable as true or false, not explicitly asbool. In addition, since according to the PEPenvironis valid with arbitrary extra items, soextra_items=Anyis set.According to PEP 3333, a server or gateway should provide as many CGI variables as possible. This includes variables beginning with
HTTP_*, other variables specified in RFC 3875, and mod_ssl variables. If these were to be included in WSGIEnvironment, they would all need to beNotRequired[str], as described in the PEP. Including them could provide some help with IDE/editor autocompletion and inferring types, but there are too many of them, and it is unclear how much to include, so I have not added them for now.