python 如何使用预定义类型为 function（参数和返回类型）定义类型？

Question

我想根据预定义的类型定义一个 function 签名（参数和返回类型）。

假设我有这种类型：

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

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

现在假设我使用了一个 function safeReadJsonFile ，它的签名是：

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

我想将类型safeSyntaxReadType分配给签名中的 function safeReadJsonFile ，可能类似于：

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

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

我可以这样做：

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

但我想避免这种情况。

编辑：

可能的解决方法

所以在阅读了很多（所有的打字文档和一些PEP544 ）之后，没有这样的语法可以在定义处轻松地将类型分配给整个 function （最接近的是@typing.overload，这并不是我们在这里需要的）。

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

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?

我认为装饰风格不起作用，因为装饰不会改变原来的 function greet_person所以从返回的装饰 function 打字时输入原来的greet_person ZC1C425268E68385D1AB145074 时不会影响。

有什么建议可以使装饰的解决方案起作用吗？

Answer 1

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

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的 object属于特定类型，您不能在创建后简单地删除它。

---

为了创建具有特定类型的可调用对象，可以从模板 object 复制它（抽象类型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 inspected metadata
        setattr(target, "__annotations__", getattr(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'