python - 记录抽象基类的属性？

Question

我有一个抽象基类，并且每个后代都应该具有某些属性(类型为 str、int 等)，因此在基类中记录这些属性是有意义的。在 Python 3.6+ 中记录这些属性的推荐格式是什么？

Answer 1

最好的来源可能是 PEP 257，特别是关于子类化的指南。

来自 PEP 257

The docstring for a class should summarize its behavior and list the public methods and instance variables. If the class is intended to be subclassed, and has an additional interface for subclasses, this interface should be listed separately (in the docstring). The class constructor should be documented in the docstring for its init method. Individual methods should be documented by their own docstring.