WSGI Types for Python

This is an attempt to bring some type safety to WSGI applications using Python's new typing features (TypedDicts, Protocols). It seems to work OK but may still be full of gaps, holes, bugs, missteps, etc. It helped bring a lot of extra safety to a couple of places that really needed it though, and seemed to remain quite stable for a couple of months.

This is implemented as a Python module, rather than MyPy stubs, as it represents a protocol things can satisfy rather than a set of types for something concrete.

This package came together during an exploration documented here: https://github.com/python/mypy/issues/7654

Define a callable application as a class:

import wsgitypes

class MyApplication(wsgitypes.Application):
    def __call__(
        self,
        environ: wsgitypes.Environ,
        start_response: wsgitypes.StartResponse,
    ) -> wsgitypes.Response:
        my_header = environ.get("REQUEST_METHOD", "")
        return []

Environ should be type-safe:

class MyApplication(wsgitypes.Application):
    def __call__(
        self,
        environ: wsgitypes.Environ,
        start_response: wsgitypes.StartResponse,
    ) -> wsgitypes.Response:
        environ["wsgi.input"] # Good
        environ["wsgi.unpot"] # BORK! MyPy will catch this.
        return []

You can define your own extensions to Environ using TypedDict inheritance, like so:

class MyEnviron(wsgitypes.Environ):
    HTTP_X_MY_HEADER: t.Optional[str]

class MyApplication(wsgitypes.Application):
    def __call__(
        self,
        environ: MyEnviron,
        start_response: wsgitypes.StartResponse,
    ) -> wsgitypes.Response:
        environ = typing.cast(MyEnviron, environ)
        environ.get("HTTP_X_MY_HEADER") # Good
        return []

Note that you need to use typing.cast to convert the incoming Environ to your derived version. An attempt was made to use a type param for Environ, but it wasn't viable (even with GVR helping!): https://github.com/python/mypy/issues/7654

MyPy types for WSGI applications

Related tags

Overview

WSGI Types for Python

Owner

Blake Williams

Flake8 plugin for managing type-checking imports & forward references

Custom Python linting through AST expressions

Rust like Option and Result types in Python

Flake8 Type Annotation Checking

Plugin for mypy to support zope.interface

docstring style checker

Pyright extension for coc.nvim

Static type checker for Python

Flake8 extension for enforcing trailing commas in python

Mylint - My really simple rendition of how a linter works.

The mypy playground. Try mypy with your web browser.

Typed interface stubs for Pythonista iOS

A python documentation linter which checks that the docstring description matches the definition.

Automated security testing using bandit and flake8.

PEP-484 typing stubs for SQLAlchemy 1.4 and SQLAlchemy 2.0

A plugin for Flake8 that provides specializations for type hinting stub files

mypy plugin for loguru

Static Typing for Python

Stubs with type annotations for ordered-set Python library

flake8 plugin to catch useless `assert` statements