python - 如何为具有预定义类型的函数(参数和返回类型)定义类型？

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'