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 Pylint plugin to analyze Flask applications.

Flake8 wrapper to make it nice, legacy-friendly, configurable.

A plugin for flake8 integrating Mypy.

Rust like Option and Result types in Python

Flake8 plugin to find commented out or dead code

Backport Python 3.8+ typing utils & add issubtype & more

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

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

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

Code audit tool for python.

OpenStack Hacking Style Checks. Mirror of code maintained at opendev.org.

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

flake8 plugin which checks that typing imports are properly guarded

Flake8 plugin that checks import order against various Python Style Guides

Static type checker for Python

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

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

Naming Convention checker for Python

Reference implementation of sentinels for the Python stdlib

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