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

PEP-484 typing stubs for SQLAlchemy 1.4 and SQLAlchemy 2.0

Flake8 plugin for managing type-checking imports & forward references

A static-analysis bot for Github

Flake8 plugin for managing type-checking imports & forward references

The official GitHub mirror of https://gitlab.com/pycqa/flake8

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

An extension for flake8 that forbids some imports statements in some modules.

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

Custom Python linting through AST expressions

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

flake8 plugin that integrates isort

Optional static typing for Python 3 and 2 (PEP 484)

Pylint plugin for improving code analysis for when using Django

mypy plugin to type check Kubernetes resources

flake8 plugin which checks that typing imports are properly guarded

Tool to check the completeness of MANIFEST.in for Python packages

Plugin for mypy to support zope.interface

Mypy plugin and stubs for SQLAlchemy

Utilities for refactoring imports in python-like syntax.

Typed interface stubs for Pythonista iOS