使 Pyright/PyCharm 识别装饰器设置的参数

Question

我有以下装饰器函数（来自 的 serialize_request 的简化版本api-client-pydantic），应该用于采用任意数量的 pydantic 模型作为参数的函数。它使用传递给它的参数初始化这些模型，然后使用这些模型作为参数调用包装函数。

def serialize(extra_kwargs: Dict[str, Any] = None) -> Callable:
    extra_kw = extra_kwargs or {"by_alias": True, "exclude_none": True}

    def decorator(func: Callable) -> Callable:
        map_schemas = {}
        map_params = {}
        parameters = []

        for arg_name, arg_type in get_type_hints(func).items():
            if arg_name == "return":
                continue
            map_schemas[arg_name] = arg_type
            if inspect.isclass(arg_type) and issubclass(arg_type, BaseModel):
                # the model's signature contains only aliases
                arg_fields = list(arg_type.__fields__.keys())
                arg_params = inspect.signature(arg_type).parameters
                map_params[arg_name] = set(list(arg_params.keys()) + arg_fields)
                parameters.extend(list(arg_params.values()))

        @wraps(func)
        def wrap(*args, **kwargs):
            if map_schemas:
                data, origin_kwargs = {}, {}
                for arg_name, arg_type in map_schemas.items():
                    if inspect.isclass(arg_type) and issubclass(arg_type, BaseModel):
                        arg_kwargs = {
                            k: v for k, v in kwargs.items() if k in map_params[arg_name]
                        }
                        data[arg_name] = parse_obj_as(arg_type, arg_kwargs).dict(
                            **extra_kw
                        )
                    else:
                        val = kwargs.get(arg_name)
                        if val is not None:
                            origin_kwargs[arg_name] = val
                new_kwargs = {**origin_kwargs, **data} or kwargs
                return func(*args, **new_kwargs)
            return func(*args, **kwargs)

        # Override signature
        if parameters:
            sig = inspect.signature(func)
            _self_param = sig.parameters.get("self")
            self_param = [_self_param] if _self_param else []
            sig = sig.replace(parameters=tuple(self_param + parameters))
            wrap.__signature__ = sig  # type: ignore

        return wrap

    return decorator

通过覆盖签名，ipython 等工具可以识别新参数并在弹出的帮助中显示它们。例如，使用以下模型和函数：

class ModelA(BaseModel):
    a: str
    b: int


class ModelB(BaseModel):
    one: float
    two: Optional[str] = None


@serialize()
def foo(model_a: ModelA, model_b: ModelB):
    print(model_a)
    print(model_b)

在 PyCharm 中：

在纯 ipython 中：

但是pyright无法识别它们并显示错误：

我不知道 PyCharm 内部使用什么，但它也无法识别新参数。但它不会显示错误，它只接受任何内容作为有效参数，也根本不接受任何内容：

现在，我的问题是是否有某种方法可以使 Pyright/PyCharm 和类似工具识别这些“新的”由装饰器设置的参数并使它们的行为就像直接在函数上设置参数一样。

Answer 1

不，Python 当前的类型系统没有这样的方法来做到这一点。

这些是您需要使用的成分：

• https://mypy.readthedocs .io/en/stable/cheat_sheet_py3.html#decorators
• https://peps.python.org/pep-0612/#parameter-specification-变量

但是你所描述的远远超出了他们的能力范围。