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

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

flake8 plugin which checks that typing imports are properly guarded

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

Static type checker for Python

Custom Python linting through AST expressions

mypy plugin to type check Kubernetes resources

Pylint plugin for improving code analysis for when using Django

A static type analyzer for Python code

open source tools to generate mypy stubs from protobufs

Utilities for pycharm code formatting (flake8 and black)

A Python Parser

Backport Python 3.8+ typing utils & add issubtype & more

Mypy stubs, i.e., type information, for numpy, pandas and matplotlib

flake8 plugin to run black for checking Python coding style

A simple program which checks Python source files for errors

Collection of awesome Python types, stubs, plugins, and tools to work with them.

🦆 Better duck-typing with mypy-compatible extensions to Protocol

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

Tool for pinpointing circular imports in Python. Find cyclic imports in any project

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