python - Flask View 的类型注释是什么？

Question

我想向返回对redirect的调用的 View 函数添加类型注释。 redirect 返回什么，以及如何将其注释添加到我的 View 函数中？

我认为这可能是 str 或 redirect 函数，但我不确定。

def setalarm() -> redirect:
    # Retrieves the information to create new alarms.
    return redirect("/")

Answer 1

最简单的答案是用您要返回的内容来注释您的 View 。在您的具体示例中，redirect 返回 werkzeug.wrappers.Response 的实例。

from werkzeug.wrappers import Response

def set_alarm() -> Response:
    return redirect()

<小时/>

与弄清楚任何给定函数返回什么来注释您的 View 相比，提出一个代表 Flask View 允许返回的任何内容的 Union 注释似乎更容易。然而，Flask 不提供类型信息，其动态特性使得表示可能性变得困难。

默认情况下，Flask View 可以返回:

• str 或 bytes。
• werkzeug.wrappers.BaseResponse 的子类。
• 采用以下形式之一的元组，其中 data 是 Fl​​ask View 可以返回的任何其他类型:
  • (数据，)
  • (data, status)，其中 status 可以是 int 或 str 或 字节。
  • (data, headers)，其中 headers 是一个字典、可迭代的 (key, value) 元组，或者一个 werkzeug.datastructs.Headers 对象。
  • (数据、状态、 header )
• 要转换为 JSON 的 dict。这些值应该是 app.json_encoder 支持的类型。
• 可调用的 WSGI。

Flask 可以通过重写 Flask.make_response 方法来支持更多或不同的返回类型。它可以序列化为 JSON 的数据可以通过重写 Flask.json_encoder 来扩展。如果您自定义了 Flask 的行为，您还需要自定义类型信息。

这里有一个view_return_type，它表示 Flask View 中可能的返回类型，ignoring JSON typing 。一旦定义了类型，您就可以用它来注释任何 View 。

import typing as t
from werkzeug.datastructures import Headers
from werkzeug.wrappers import BaseResponse

_str_bytes = t.Union[str, bytes]
_data_type = t.Union[
    _str_bytes,
    BaseResponse,
    t.Dict[str, t.Any],
    t.Callable[
        [t.Dict[str, t.Any], t.Callable[[str, t.List[t.Tuple[str, str]]], None]], t.Iterable[bytes]
    ],
]
_status_type = t.Union[int, _str_bytes]
_headers_type = t.Union[
    Headers, t.Dict[_str_bytes, _str_bytes], t.Iterable[t.Tuple[_str_bytes, _str_bytes]],
]

view_return_type = t.Union[
    _data_type,
    t.Tuple[_data_type],
    t.Tuple[_data_type, _status_type],
    t.Tuple[_data_type, _headers_type],
    t.Tuple[_data_type, _status_type, _headers_type],
]

@app.route("/users/<int:id>/")
def user_detail(id: int) -> view_return_type:
    ...