__repr__() 函数的最佳输出类型和编码实践？

Question

最近，我在 __repr__()、format() 和编码方面遇到了很多麻烦。 __repr__() 的输出应该编码还是 unicode 字符串？ Python 中 __repr__() 的结果是否有最佳编码？我想要输出的内容确实有非 ASCII 字符。

我使用 Python 2.x，并且想要编写可以轻松适应 Python 3 的代码。因此，该程序使用

# -*- coding: utf-8 -*-
from __future__ import unicode_literals, print_function  # The 'Hello' literal represents a Unicode object

以下一些其他问题一直困扰着我，我正在寻找解决这些问题的解决方案：

1. 打印到 UTF-8 终端应该可以工作（我有 sys.stdout.encoding ） > 设置为 UTF-8，但如果其他情况也能工作那就最好了）。
2. 将输出通过管道传输到文件（以 UTF-8 编码）应该可以工作（在本例中，sys.stdout.encoding 为 None）。
3. 我的许多 __repr__() 函数的代码目前有许多 return ....encode('utf-8')，这很重。有没有什么东西又坚固又轻便？
4. 在某些情况下，我什至有像 return ('<{}>'.format(repr(x).decode('utf-8'))).encode('utf-8') 这样的丑陋野兽，即对象的表示被解码，放入格式化字符串中，然后重新编码。我想避免这种复杂的转变。

为了编写能够很好地解决这些编码问题的简单 __repr__() 函数，您建议做什么？

Answer 1

在Python2中，__repr__（和__str__）必须返回一个字符串对象，而不是一个
统一码对象。在Python3中，情况相反，__repr__和__str__
必须返回 unicode 对象，而不是字节（née string）对象：

class Foo(object):
    def __repr__(self):
        return u'\N{WHITE SMILING FACE}' 

class Bar(object):
    def __repr__(self):
        return u'\N{WHITE SMILING FACE}'.encode('utf8')

repr(Bar())
# ☺
repr(Foo())
# UnicodeEncodeError: 'ascii' codec can't encode character u'\u263a' in position 0: ordinal not in range(128)

在 Python2 中，你实际上没有选择。您必须选择一种编码
__repr__ 的返回值。

顺便问一下，您阅读过 PrintFails wiki 吗？可能不会直接回答
你的其他问题，但我确实发现它有助于阐明为什么某些
发生错误。

---

当使用 from __future__ import unicode_literals 时，

'<{}>'.format(repr(x).decode('utf-8'))).encode('utf-8')

可以更简单地编写为

str('<{}>').format(repr(x))

假设 str 在您的系统上编码为 utf-8 。

如果没有 from __future__ import unicode_literals，表达式可以写为：

'<{}>'.format(repr(x))

Answer 2

我认为装饰器可以以合理的方式管理 __repr__ 不兼容性。这是我使用的：

from __future__ import unicode_literals, print_function
import sys

def force_encoded_string_output(func):

    if sys.version_info.major < 3:

        def _func(*args, **kwargs):
            return func(*args, **kwargs).encode(sys.stdout.encoding or 'utf-8')

        return _func

    else:
        return func


class MyDummyClass(object):

    @force_encoded_string_output
    def __repr__(self):
        return 'My Dummy Class! \N{WHITE SMILING FACE}'

Answer 3

我使用如下函数：

def stdout_encode(u, default='UTF8'):
    if sys.stdout.encoding:
        return u.encode(sys.stdout.encoding)
    return u.encode(default)

然后我的 __repr__ 函数如下所示：

def __repr__(self):
    return stdout_encode(u'<MyClass {0} {1}>'.format(self.abcd, self.efgh))