如何在Python类中保持概述？如何推断数据类型？

Question

开始了一个Python项目，写了几百行代码，创建了一些类，得到了立即的满足，一切都很顺利

几个月后回到这个项目，我绝望地迷失了方向。比意大利面条还糟糕：在我看来，代码现在就像是一个混乱的100个类成员函数的集合。这些函数大多只有两到十行长；它们的工作原理和用途都非常清楚——只是我不知道函数参数、返回值和所涉及的类成员变量的数据类型。因此，我无法了解我的课程是如何相互关联的

在这种情况下如何处理？如何获得C++中H首标所提供的高级概述？如何将这些信息插入到源文件中，以便下次我不需要重做这项研究

Answer 1

在适当的地方使用docstrings会有很大的帮助

引用政治公众人物的例子：

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real   the real part (default 0.0)
    imag   the imaginary part (default 0.0)
    """
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

这些字符串作为__doc__特殊属性添加到函数/方法中，您可以从python访问该函数/方法。直接，或与pydoc模块。另外，可以使用^{}直接从python控制台获得此类文档。您还应该研究sphinx-doc，它是用于记录python本身的工具。它不在源代码中，但它是为记录python代码而定制的，总体来说非常方便

至于您关心的实际类型，通常您不会命名特定的类型。它们并不重要。重要的是您可以用它们做什么，因为python代码通常使用duck typing。也就是说：你不在乎你的论点是什么，只要你能调用它的foo方法并访问它的bar属性，它们的行为就如你所期望的那样