如何为具有预定义类型的函数（参数和返回类型）定义类型？

Question

我想根据预定义类型定义函数签名（参数和返回类型）。

假设我有这种类型：

safeSyntaxReadType = Callable[[tk.Tk, Notebook, str], Optional[dict]]

这意味着 safeSyntaxReadType 是一个接收 3 个参数（来自上面列出的类型）的函数，它可以返回 dict 或者可能不返回任何内容。

现在假设我使用了一个函数safeReadJsonFile，其签名是：

def safeReadJsonFile(root = None, notebook = None, path = ''):

我想将类型safeSyntaxReadType分配给签名中的函数safeReadJsonFile，可能是这样的：

def safeReadJsonFile:safeSyntaxReadType(root = None, notebook = None, path = ''):

但是这种语法不起作用。这种类型分配的正确语法是什么？

我可以这样做：

def safeReadJsonFile(root:tk.Tk = None, notebook:Notebook = None, path:str = '') -> Optional[dict]:

但我想避免这种情况。

读了很多（所有的typing docs，和一些PEP544）后，我发现没有这样的语法可以轻松地将类型分配给定义中的整个函数（最接近的是@typing.overload和这不是我们在这里所需要的）。

但作为一种可能的解决方法，我实现了一个装饰器函数，它可以帮助轻松分配类型：

def func_type(function_type):
    def decorator(function):
        def typed_function(*args, **kwargs):
            return function(*args, **kwargs)
        typed_function: function_type  # type assign
        return typed_function
    return decorator

用法是：

greet_person_type = Callable[[str, int], str]

def greet_person(name, age):
    return "Hello, " + name + " !\nYou're " + str(age) + " years old!"

greet_person = func_type(greet_person_type)(greet_person)
greet_person(10, 10) # WHALA! typeerror as expected in `name`: Expected type 'str', got 'int' instead

现在，我需要帮助：由于某种原因，类型检查器 (pycharm) 不会提示输入，如果使用应该是等效的修饰语法：

@func_type(greet_person_type)
def greet_person(name, age):
    return "Hello, " + name + " !\nYou're " + str(age) + " years old!"

greet_person(10, 10)  # no type error. why?

我认为装饰样式不起作用，因为装饰不会更改原始函数greet_person，因此返回的装饰函数的键入不会影响原始greet_person函数时的输入。

如何使修饰的解决方案发挥作用？

Answer 1

只需将函数分配给代表特定可调用类型的新名称。

Greetable = Callable[[str, int], str]

def any_greet_person(name, age):
    ...

typed_greet_person: Greetable = any_greet_person

reveal_type(any_greet_person)
reveal_type(typed_greet_person)

请记住，定义为any_greet_person的对象是特定类型的，创建后不能简单地删除它。

---

为了创建具有特定类型的可调用对象，可以从模板对象复制它（抽象类型Callable 和Protocol 不适用于Type[C]）。这可以通过装饰器来完成：

from typing import TypeVar, Callable

C = TypeVar('C', bound=Callable)  # parameterize over all callables

def copy_signature(template: C) -> Callable[[C], C]:
    """Decorator to copy the static signature between functions"""
    def apply_signature(target: C) -> C:
        # copy runtime inspectable metadata as well
        target.__annotations__ = template.__annotations__
        return target
    return apply_signature

这也编码了只有与复制的签名兼容的函数才是有效的目标。

# signature template
def greetable(name: str, age: int) -> str: ...

@copy_signature(greetable)
def any_greet_person(name, age): ...

@copy_signature(greetable)  # error: Argument 1 has incompatible type ...
def not_greet_person(age, bar): ...

print(any_greet_person.__annotations__)  # {'name': <class 'str'>, 'age': <class 'int'>, 'return': <class 'str'>}
if TYPE_CHECKING:
    reveal_type(any_greet_person) # note: Revealed type is 'def (name: builtins.str, age: builtins.int) -> builtins.str'