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

Automated security testing using bandit and flake8.

flake8 plugin that integrates isort

MyPy types for WSGI applications

A Python Parser

Performant type-checking for python.

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

Type stubs for the lxml package

Custom Python linting through AST expressions

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

An enhanced version of the Python typing library.

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

mypy plugin for loguru

Flake8 plugin that checks import order against various Python Style Guides

Flake8 extension for enforcing trailing commas in python

flake8 plugin to run black for checking Python coding style

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

A static-analysis bot for Github

Flake8 plugin to validate annotations complexity

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

A static type analyzer for Python code