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

❄️ A flake8 plugin to help you write better list/set/dict comprehensions.

Plugin for mypy to support zope.interface

Backport Python 3.8+ typing utils & add issubtype & more

flake8 plugin to run black for checking Python coding style

Silence mypy by adding or removing code comments

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

Unbearably fast O(1) runtime type-checking in pure Python.

Convert relative imports to absolute

Pyright extension for coc.nvim

MonkeyType as a pytest plugin.

Tool to automatically fix some issues reported by flake8 (forked from autoflake).

Tools for improving Python imports

An open-source, mini imitation of GitHub Copilot for Emacs.

open source tools to generate mypy stubs from protobufs

flake8 plugin to catch useless `assert` statements

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.

The strictest and most opinionated python linter ever!

Code audit tool for python.

Typed interface stubs for Pythonista iOS

A static-analysis bot for Github