Python 正确使用 __str__ 和 __repr__答案

【问题标题】：Python proper use of __str__ and __repr__Python 正确使用 __str__ 和 __repr__
【发布时间】：2010-05-11 17:06:28
【问题描述】：

我当前的项目需要大量使用位域。我找到了一个简单、实用的recipe for bit a field class，但它缺少一些我需要的功能，所以我决定扩展它。我刚刚实施了__str__ 和__repr__，我想确保我遵守约定。

__str__ 应该是非正式的和简洁的，所以我让它返回位字段的十进制值（即str(bit field 11) 将是"3"。

__repr__ 应该是对象的官方表示，所以我让它返回实际的位字符串（即repr(bit field 11) 将是"11"）。

您认为此实现是否符合str 和repr 的约定？

另外，我使用了bin() 函数来获取存储在类中的值的位串。这与 Python

干杯，

皮特

【问题讨论】：

【解决方案1】：

__repr__ 最好是一个可用于重新创建对象的字符串，例如，如果您在其上使用eval - 请参阅文档here。这不是一门精确的科学，因为它可能取决于模块的用户如何导入它。

我会让__str__ 返回二进制字符串，__repr__ 返回Classname(binary_string)，或者任何可以用来重新创建对象的东西。

在bitstring 模块（我维护）中，__str__ 如果位串是 4 位长的倍数，则为十六进制，否则为二进制或两者的组合。此外，如果位串很长，则会被截断（您不想尝试在交互式会话中打印 100 MB 位串！）

如果我是你，我会完全避免使用 bin() 函数。原因是如果您的位串以零位开头，则无法使用它（请参阅我的问题here）。我建议改用bin 方法或属性。

【讨论】：

【解决方案2】：

我会考虑让__str__ 返回一个十六进制表示。这样，更容易观察实际位值是什么，因此更有用。但仍然相当简洁（实际上，比十进制表示的字符更少）。

【讨论】：

【解决方案3】：

__repr__ 需要返回一些内容，如果将其传递给您的构造函数，则会创建一个与原始对象完全相同的新对象。

Yours 返回 '11' 但如果将 '11' 传递给构造函数，您将不会得到相同的位域。所以这个__repr__不行。

【讨论】：