classification
Title: typing support in wsgiref
Type: enhancement Stage:
Components: Library (Lib) Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: srittau
Priority: normal Keywords:

Created on 2020-10-12 10:17 by srittau, last changed 2020-10-12 10:17 by srittau.

Messages (1)
msg378484 - (view) Author: Sebastian Rittau (srittau) * Date: 2020-10-12 10:17
In typeshed (the repository for stdlib type annotations), we have defined a bunch of types to support annotating WSGI interfaces. See https://github.com/python/typeshed/blob/master/stdlib/2and3/_typeshed/wsgi.pyi for the current version. Unfortunately these types are only available at type check time, which means that users need to do some gymnastics to use them in their own code.

I think it would be worthwhile to add these types directly to wsgiref or to a new module (e.g. wsgiref.types). On the one hand users could use them at runtime easily, on the other hand they serve as additional documentation WSGI types. In my experience, WSGI applications and middleware often slightly misimplement the standard, which can make interoperability difficult. Both type checking and concrete documentation could help alleviate this problem.

If the maintainers think this would be a good idea, I could provide a PR for both the types and the Python documentation.
History
Date User Action Args
2020-10-12 10:17:09srittaucreate