记录抽象基类的属性？

Posted 2023-02-23

【中文标题】记录抽象基类的属性？

【英文标题】：Documenting attributes of abstract base classes?

【发布时间】：2019-02-01 12:02:49

【问题描述】：

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

【问题讨论】：

也许看看abc module 可能会给你一些想法。

Type hints?

【参考方案1】：

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

来自PEP 257

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