Python中魔术方法的文档

Question

我一直在阅读python的各种风格指南（PEP 8等），并没有找到一个相当简单的问题的明确答案。

重新定义Python的众多魔术方法之一，例如__str__(self)，__le__(self, other)和其他方法，是否应记录重新定义的方法？或者是否足以假设开发人员将在python.org上查找现有文档？

这与其他代码不同，主要是因为许多魔术方法都是不可见的。例如，如果我定义__eq__(self, other)，最终用户在通过==

调用它时从不会看到内部文档字符串

Answer 1

如果您的意思是记录它的作用，那么只有在操作"astonish"时才需要这样做。如果你的意思是记录它是如何工作的，那么你应该总是这样做。