python - 如何将 python 类型注释添加到烧瓶全局上下文 g？

Question

我有一个装饰器，它将用户添加到烧瓶全局上下文 g 中：

class User:
    def __init__(self, user_data) -> None:
        self.username: str = user_data["username"]
        self.email: str = user_data["email"]

def login_required(f):
    @wraps(f)
    def wrap(*args, **kwargs):
        user_data = get_user_data()
        user = User(user_data)
        g.user = User(user_data)

        return f(*args, **kwargs)

    return wrap

当我在控制器中访问 g.user 时，我希望知道 g.user 的类型（用户）。我怎样才能做到这一点？（我正在使用 pyright）

Answer 1

我在类型检查动态添加的属性中描述了一个类似的问题。一种解决方案是使用以下方法添加自定义类型提示typing.TYPE_CHECKING：

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from flask.ctx import _AppCtxGlobals

    class MyGlobals(_AppCtxGlobals):
        user: 'User'

    g = MyGlobals()
else:
    from flask import g

现在例如

reveal_type(g.user)

会发出

note: Revealed type is 'myapp.User'

如果应该在多个模块中重用自定义类型，您可以为flask. 存根的位置取决于类型检查器，例如从环境变量中mypy读取自定义存根，在项目根目录中查找目录等。部分存根的示例：MYPY_PATHpyrighttypings

# _typeshed/flask/__init__.pyi

from typing import Any
from flask.ctx import _AppCtxGlobals
from models import User


def __getattr__(name: str) -> Any: ...  # incomplete


class MyGlobals(_AppCtxGlobals):
    user: User
    def __getattr__(self, name: str) -> Any: ...  # incomplete


g: MyGlobals

Answer 2

这是一个有意见的解决方案： flask.g很神奇，并且与服务器实现紧密相关。IMO，它的使用应该被控制和最小化。

我创建了一个文件来管理 g，它允许我输入它

    # request_context.py
    from flask import g
    from somewhere import User
    
    def set_user(user: User) -> None:
       g.user = user
    
    def get_user() -> User:
       # you could validate here that the user exists
       return g.user

然后在您的代码中：

    # yourcode.py
    import request_context
    
    class User:
        ...
    
    def login_required(f):
        @wraps(f)
        def wrap(*args, **kwargs):
            user_data = get_user_data()
            user = User(user_data)
            request_context.set_user(User(user_data))
    
            return f(*args, **kwargs)
    
        return wrap

Answer 3

您可以代理该g对象。考虑以下实现：

import flask


class User:
    ...


class _g:

    user: User
    # Add type hints for other attributes
    # ...

    def __getattr__(self, key):
        return getattr(flask.g, key)


g = _g()

Answer 4

您可以在类上注释属性，即使该类不是您的，只需在其后加一个冒号即可。例如：

g.user: User

而已。由于它可能在任何地方都有效，因此我会将其放在代码的顶部：

from functools import wraps

from flask import Flask, g

app = Flask(__name__)


class User:
    def __init__(self, user_data) -> None:
        self.username: str = user_data["username"]
        self.email: str = user_data["email"]


# Annotate the g.user attribute
g.user: User


def login_required(f):
    @wraps(f)
    def wrap(*args, **kwargs):
        g.user = User({'username': 'wile-e-coyote',
                       'email': 'coyote@localhost'})

        return f(*args, **kwargs)

    return wrap


@app.route('/')
@login_required
def hello_world():
    return f'Hello, {g.user.email}'


if __name__ == '__main__':
    app.run()

而已。