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

MonkeyType as a pytest plugin.

Convert relative imports to absolute

Rust like Option and Result types in Python

Type stubs for the lxml package

Naming Convention checker for Python

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

Design by contract for Python. Write bug-free code. Add a few decorators, get static analysis and tests for free.

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

A static-analysis bot for Github

Performant type-checking for python.

flake8 plugin which checks that typing imports are properly guarded

Utilities for refactoring imports in python-like syntax.

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

Flake8 plugin to validate annotations complexity

A Pylint plugin to analyze Flask applications.

:sparkles: Surface lint errors during code review

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

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

flake8 plugin that integrates isort

Flashcards - A flash card application with 2 optional command line arguments