正确记录作为参数传递的构造函数

时间:2017-10-25 14:02:59

标签: python documentation docstring

我正在试图弄清楚什么是正确的方法来记录接收类构造函数作为参数的函数。我使用的是Google风格的文档字符串。

示例:

class MyClass:
    def __init__(self):
        ...

def my_func(param1, class_constructor):
"""Example function.

Args:
    param1 (int): ...
    class_constructor (???): My class constructor.
"""
    class_instance = class_constructor()
    ...

my_func(12, MyClass)

1 个答案:

答案 0 :(得分:0)

如果我理解正确,你想知道要替换什么???在你的例子中。正如原始问题的评论中所指出的,您的class_constructor参数实际上应该是一个类,因此适当的类型将是type(忽略旧样式类)。