Flask 路由装饰器类型提示

Question

我有一个简单的 Flask 应用程序，我在其中添加了一个装饰器，以确保每个请求都存在特定的标头。

import functools
from http import HTTPStatus

import flask
from flask.typing import ResponseReturnType

app = flask.Flask(__name__)


# What type hints should be added to this?
def requires_header(func):
    @functools.wraps(func)
    def check_headers(*args, **kwargs):
        if not flask.request.headers.get("X-Foo"):
            flask.abort(HTTPStatus.NOT_FOUND)

        return func(*args, **kwargs)

    return check_headers


@app.route("/", methods=["GET"])
@requires_header
def root() -> ResponseReturnType:
    return flask.jsonify(success=True)


if __name__ == "__main__":
    flask.run(host=0.0.0.0, port=3000)

我应该向requires_header 装饰器添加什么类型提示？

Answer 1

你的装饰器接受一个可调用的参数（任何类型），并返回一个完全相同类型的可调用参数。因此：

from typing import Any, Callable, TypeVar

_C = TypeVar("_C", bound=Callable[..., Any])

def requires_header(func: _C) -> _C:
    ...

请注意，这与执行以下操作不同：

def requires_header(func: Callable) -> Callable:
    ...

因为这不能保证修饰函数与原始函数具有相同的类型（它实际上变成了两个不同 Callable[..., Any] 类型，这破坏了对调用该函数的任何内容的类型检查）。使用TypeVar 允许原始类型通过装饰器不变。

Answer 2

如果您正在使用--strict 设置运行 Mypy，那么目前以下是最好的输入方式。这与@Samwise's answer 非常相似，但请注意TypeVar 绑定到Callable[..., Any] 而不是裸Callable（Mypy --strict 不允许任何未参数化的泛型，即使作为TypeVar 的参数） .当涉及到 requires_header 的返回类型时，我们还必须帮助 Mypy ——它无法验证我们实际上返回了我们说我们应该应该的类型回来了，所以我们用a call to typing.cast帮助Mypy。

import functools
from http import HTTPS
from typing import Callable, TypeVar, cast, Any 

import flask

C = TypeVar('C', bound=Callable[..., Any])

def requires_header(func: C) -> C:
    @functools.wraps(func)
    def check_headers(*args: Any, **kwargs: Any) -> Any:
        if not flask.request.headers.get("X-Foo"):
            flask.abort(HTTPStatus.NOT_FOUND)

        return func(*args, **kwargs)

    return cast(C, check_headers)

上述方案显然有其缺陷，但主要是我们不得不使用Any的次数，一般应该尽量少用。 Python 3.10 有 introduced a new feature 专门用于帮助键入装饰器，ParamSpec。不幸的是，Mypy 还不支持这个功能，但是当它支持时，我们将能够像这样输入你的装饰器：

import functools
from http import HTTPS
from typing import Callable, TypeVar, cast, ParamSpec 

import flask

P = ParamSpec('P')
R = TypeVar('R')

def requires_header(func: Callable[P, R]) -> Callable[P, R]:
    @functools.wraps(func)
    def check_headers(*args: P.args, **kwargs: P.kwargs) -> R:
        if not flask.request.headers.get("X-Foo"):
            flask.abort(HTTPStatus.NOT_FOUND)

        return func(*args, **kwargs)

    return cast(Callable[P, R], check_headers)

可能使用ParamSpec 也会消除装饰器最后一行中对cast 的需求——但很难说，因为Mypy 还不支持该功能，所以很遗憾还没用！