是否有一种标准方法可以在文档字符串中指定回调函数的类型?

csi*_*siz 8 python numpy

我有一个接受回调的函数。是否有标准方法来记录此参数的类型?

def example(callback):
    """Example function.

    Parameters
    ----------
    callback : type
       Description of `callback`.
    """
    print(callback(3, 14))
Run Code Online (Sandbox Code Playgroud)

csi*_*siz 9

在制定问题时找到了答案,但问题本身在 Google 上没有给出任何结果。

PEP-0484在 python 中引入了类型注释。例如,接受两个整数并返回字符串的回调函数的类型是:

from typing import Callable

Callable[[int, int], str]
Run Code Online (Sandbox Code Playgroud)

  • 来自 https://docs.python.org/3/library/typing.html#typing.Callable “没有语法来指示可选或关键字参数;此类函数类型很少用作回调类型。” 似乎没有标准方法来记录这些。也许更好的选择是将点击参数作为字典传递,在这种情况下它是一个固定参数。 (2认同)