224

__str__()当你应该实现vs时是否有 python 约定__unicode__()？我看到类覆盖__unicode__()的频率高于__str__()但它似乎并不一致。是否有具体的规则，什么时候实施一个比另一个更好？两者都有必要/良好的做法吗？

4

6 回答 6

268

__str__()是旧方法——它返回字节。__unicode__()是新的首选方法——它返回字符。这些名称有点令人困惑，但在 2.x 中，出于兼容性原因，我们坚持使用它们。通常，您应该将所有字符串格式放入 中__unicode__()，并创建一个存根__str__()方法：

def __str__(self):
    return unicode(self).encode('utf-8')

在 3.0 中，str包含字符，因此将相同的方法命名为__bytes__()和__str__()。这些行为符合预期。

于 2009-08-20T16:04:34.463 回答
24

如果我不特别关心给定类的微优化字符串化，我总是__unicode__只实现它，因为它更通用。当我确实关心这些微小的性能问题（这是例外，而不是规则）时，__str__只有（当我可以证明字符串化输出中永远不会有非 ASCII 字符时）或两者（当两者都可能时），可能帮助。

这些我认为是可靠的原则，但在实践中很常见的是知道除了 ASCII 字符之外什么都没有（例如，字符串化的形式只有数字、标点符号，也许还有一个简短的 ASCII 名称；-）其中在这种情况下，直接转向“公正__str__”的方法是很典型的（但如果我与之合作的一个编程团队提出了一个本地指南来避免这种情况，我会对该提议+1，因为在这些问题上很容易出错并且“过早的优化是编程中万恶之源”;-)。

于 2009-08-20T16:04:22.390 回答
15

随着世界变得越来越小，您遇到的任何字符串都有可能最终包含 Unicode。所以对于任何新的应用程序，你至少应该提供__unicode__(). 那么你是否也覆盖__str__()只是一个品味问题。

于 2009-08-20T16:00:08.137 回答
9

如果你在 Django 中同时使用 python2 和 python3，我推荐使用 python_2_unicode_compatible 装饰器：

Django 提供了一种简单的方法来定义适用于 Python 2 和 3 的str () 和 unicode () 方法：您必须定义一个返回文本的str () 方法并应用 python_2_unicode_compatible() 装饰器。

正如之前对另一个答案的评论中所指出的，future.utils 的某些版本也支持这个装饰器。在我的系统上，我需要为 python2 安装一个更新的 future 模块并为 python3 安装 future。之后，这是一个功能示例：

#! /usr/bin/env python

from future.utils import python_2_unicode_compatible
from sys import version_info

@python_2_unicode_compatible
class SomeClass():
    def __str__(self):
        return "Called __str__"


if __name__ == "__main__":
    some_inst = SomeClass()
    print(some_inst)
    if (version_info > (3,0)):
        print("Python 3 does not support unicode()")
    else:
        print(unicode(some_inst))

这是示例输出（其中 venv2/venv3 是 virtualenv 实例）：

~/tmp$ ./venv3/bin/python3 demo_python_2_unicode_compatible.py 
Called __str__
Python 3 does not support unicode()

~/tmp$ ./venv2/bin/python2 demo_python_2_unicode_compatible.py 
Called __str__
Called __str__
于 2017-06-18T21:19:25.680 回答
4

Python 2： 仅实现 __str__()，并返回一个 unicode。

当__unicode__()省略且有人调用unicode(o)oru"%s"%o时，Python 调用o.__str__()并使用系统编码转换为 unicode。（参见的文档__unicode__()。）

反之则不然。如果你实现__unicode__()但没有实现__str__()，那么当有人调用str(o)or时"%s"%o，Python 会返回repr(o).

基本原理

为什么返回unicodefrom会起作用__str__()？
如果__str__()返回 unicode，Python 会自动将其转换为str使用系统编码。

有什么好处？
① 让您不必担心系统编码是什么（即locale.getpreferredencoeding(…)）。就个人而言，这不仅是混乱的，而且我认为这是系统无论如何都应该处理的事情。② 如果你小心，你的代码可能会与 Python 3 交叉兼容，其中__str__()返回 unicode。

从名为 的函数返回 unicode 不是欺骗性的__str__()吗？
一点。但是，您可能已经在这样做了。如果您from __future__ import unicode_literals在文件的顶部有，那么您很有可能会在不知情的情况下返回 unicode。

Python 3 怎么样？
Python 3 不使用__unicode__(). 但是，如果您实现__str__()它在 Python 2 或 Python 3 下返回 unicode，那么您的这部分代码将是交叉兼容的。

如果我想unicode(o)与 有实质性不同str()怎么办？
实现__str__()（可能返回str）和__unicode__(). 我想这会很少见，但您可能想要实质上不同的输出（例如，特殊字符的 ASCII 版本，例如":)"for u"☺"）。

我知道有些人可能会觉得这有争议。

于 2019-06-26T15:36:40.700 回答
2

值得向那些不熟悉该__unicode__函数的人指出 Python 2.x 中围绕它的一些默认行为，尤其是与__str__.

class A :
    def __init__(self) :
        self.x = 123
        self.y = 23.3

    #def __str__(self) :
    #    return "STR      {}      {}".format( self.x , self.y)
    def __unicode__(self) :
        return u"UNICODE  {}      {}".format( self.x , self.y)

a1 = A()
a2 = A()

print( "__repr__ checks")
print( a1 )
print( a2 )

print( "\n__str__ vs __unicode__ checks")
print( str( a1 ))
print( unicode(a1))
print( "{}".format( a1 ))
print( u"{}".format( a1 ))

产生以下控制台输出...

__repr__ checks
<__main__.A instance at 0x103f063f8>
<__main__.A instance at 0x103f06440>

__str__ vs __unicode__ checks
<__main__.A instance at 0x103f063f8>
UNICODE 123      23.3
<__main__.A instance at 0x103f063f8>
UNICODE 123      23.3

现在，当我取消注释该__str__方法时

__repr__ checks
STR      123      23.3
STR      123      23.3

__str__ vs __unicode__ checks
STR      123      23.3
UNICODE  123      23.3
STR      123      23.3
UNICODE  123      23.3
于 2019-03-14T22:55:35.770 回答