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

Pyright extension for coc.nvim

mypy plugin to type check Kubernetes resources

Flake8 plugin to find commented out or dead code

Check for python builtins being used as variables or parameters

:sparkles: Surface lint errors during code review

Tool for automatically reordering python imports. Similar to isort but uses static analysis more.

Rust like Option and Result types in Python

Flake8 extension to provide force-check option

Typed interface stubs for Pythonista iOS

Convert relative imports to absolute

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

Stubs with type annotations for ordered-set Python library

Silence mypy by adding or removing code comments

A simple plugin that allows running mypy from PyCharm and navigate between errors

Backport Python 3.8+ typing utils & add issubtype & more

Simple Python style checker in one Python file

Pylint plugin to enforce some secure coding standards for Python.

A plugin for Flake8 finding likely bugs and design problems in your program. Contains warnings that don't belong in pyflakes and pycodestyle.

It's not just a linter that annoys you!

A Python Parser