记录抽象基类的属性?

Question

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

Answer 1

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

从 PEP 257

类的文档字符串应总结其行为并列出公共方法和实例变量。如果该类旨在被子类化，并且具有用于子类的附加接口，则应单独列出此接口(在文档字符串中(。类构造函数应记录在其init方法的文档字符串中。各个方法应由其自己的文档字符串记录。