numpydoc：记录一个duck-typed参数

Question

根据guide to numpy/scipy documentation中的惯例，函数参数应按以下方式记录：

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

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

如果type是一个不同的类型，例如 int 或 str ，这很简单。

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

Answer 1

您描述的方法几乎是标准方法。

另一种方法是使用抽象基类定义必须实现的特定方法，然后按照an answer to a related question的建议将其指定为类型。