8.1 改變對(duì)象的字符串顯示

問(wèn)題

你想改變對(duì)象實(shí)例的打印或顯示輸出，讓它們更具可讀性。

解決方案

要改變一個(gè)實(shí)例的字符串表示，可重新定義它的 __str__() 和 __repr__() 方法。例如：

class Pair:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return 'Pair({0.x!r}, {0.y!r})'.format(self)

    def __str__(self):
        return '({0.x!s}, {0.y!s})'.format(self)

__repr__() 方法返回一個(gè)實(shí)例的代碼表示形式，通常用來(lái)重新構(gòu)造這個(gè)實(shí)例。內(nèi)置的 repr() 函數(shù)返回這個(gè)字符串，跟我們使用交互式解釋器顯示的值是一樣的。__str__() 方法將實(shí)例轉(zhuǎn)換為一個(gè)字符串，使用 str() 或 print() 函數(shù)會(huì)輸出這個(gè)字符串。比如：

>>> p = Pair(3, 4)
>>> p
Pair(3, 4) # __repr__() output
>>> print(p)
(3, 4) # __str__() output
>>>

我們?cè)谶@里還演示了在格式化的時(shí)候怎樣使用不同的字符串表現(xiàn)形式。特別來(lái)講，!r 格式化代碼指明輸出使用 __repr__() 來(lái)代替默認(rèn)的 __str__() 。你可以用前面的類來(lái)試著測(cè)試下：

>>> p = Pair(3, 4)
>>> print('p is {0!r}'.format(p))
p is Pair(3, 4)
>>> print('p is {0}'.format(p))
p is (3, 4)
>>>

討論

自定義 __repr__() 和 __str__() 通常是很好的習(xí)慣，因?yàn)樗芎?jiǎn)化調(diào)試和實(shí)例輸出。例如，如果僅僅只是打印輸出或日志輸出某個(gè)實(shí)例，那么程序員會(huì)看到實(shí)例更加詳細(xì)與有用的信息。

__repr__() 生成的文本字符串標(biāo)準(zhǔn)做法是需要讓 eval(repr(x)) == x 為真。如果實(shí)在不能這樣子做，應(yīng)該創(chuàng)建一個(gè)有用的文本表示，并使用 < 和 > 括起來(lái)。比如：

>>> f = open('file.dat')
>>> f
<_io.TextIOWrapper name='file.dat' mode='r' encoding='UTF-8'>
>>>

如果 __str__() 沒(méi)有被定義，那么就會(huì)使用 __repr__() 來(lái)代替輸出。

上面的 format() 方法的使用看上去很有趣，格式化代碼 {0.x} 對(duì)應(yīng)的是第1個(gè)參數(shù)的x屬性。因此，在下面的函數(shù)中，0實(shí)際上指的就是 self 本身：

def __repr__(self):
    return 'Pair({0.x!r}, {0.y!r})'.format(self)

作為這種實(shí)現(xiàn)的一個(gè)替代，你也可以使用 % 操作符，就像下面這樣：

def __repr__(self):
    return 'Pair(%r, %r)' % (self.x, self.y)