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

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

Reference implementation of sentinels for the Python stdlib

A framework for detecting, highlighting and correcting grammatical errors on natural language text.

Stubs with type annotations for ordered-set Python library

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

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

Mypy plugin and stubs for SQLAlchemy

Custom Python linting through AST expressions

Pylint plugin to enforce some secure coding standards for Python.

Flake8 plugin that checks import order against various Python Style Guides

An enhanced version of the Python typing library.

Run isort, pyupgrade, mypy, pylint, flake8, and more on Jupyter Notebooks

Flake8 plugin for managing type-checking imports & forward references

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

❄️ A flake8 plugin to help you write better list/set/dict comprehensions.

Tools for improving Python imports

coala provides a unified command-line interface for linting and fixing all your code, regardless of the programming languages you use.

flake8 plugin to run black for checking Python coding style

Easy saving and switching between multiple KDE configurations.

Flake8 extension for checking quotes in python