记录numpydoc中的鸭子类型参数

Question

根据numpy/枕文件指南中的惯例，应以下列方式记录函数参数：

def foo(x):
    """" This function does nothing

    Parameters
    ----------
    x : type
       Description of parameter `x`.
    """"
    pass

如果类型是独立的类型(如int或str )，则这很简单。

现在，我希望参数是BaseClass的实例或任何公开相同接口的对象(例如从BaseClass派生的类)。是否有一种惯例，即如何简明地记录参数x应该公开某个接口(通过派生或鸭子类型)？

Answer 1

您所描述的方法基本上是标准的。

另一种方法是使用抽象基类来定义必须实现的特定方法，然后将其指定为对相关问题的回答上建议的类型。