类与对象-1-改变对象实例的字符串显示

问题描述

如果我们想改变对象实例的打印或显示输出,让它们更具可读性,应该怎么做呢?

解决方案

想要改变一个对象实例的字符串显示,可重新定义它的 __str__()__repr__() 方法。

代码演示:

1
2
3
4
5
6
7
8
9
10
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__() 方法返回一个实例的代码表示形式,通常用来重新构造这个实例。 内置的 repr() 函数返回这个字符串,跟我们使用交互式解释器显示的值是一样的

__str__() 方法将实例转换为一个字符串,使用 str()print() 函数会输出这个字符串。

简而言之:

如果要把一个实例通过 print 显示成字符串,就要实现 __str__(),如果要在交互命令行下直接通过调用实例显示,就要实现 __repr__()

代码示例:

1
2
3
4
5
6
>>> p = Pair(3, 4)
>>> p
Pair(3, 4) # 输出的是 __repr__()
>>> print(p)
(3, 4) # 输出的是 __str__()
>>>

扩展讨论

为何要自定义 __repr__()__str__()

自定义 __repr__()__str__() 通常是很好的习惯,因为它能简化调试和实例输出

例如,对于某个对象的实例,如果我们仅仅只是打印输出或日志输出,那么我们就会看到更加详细与有用的实例信息。

简而言之:

__repr__() 是给程序员看的。

__str__() 是给用户看的。

几种格式化方法

上面的例子中我们还演示了在格式化的时候怎样使用不同的字符串表现形式。

!r 格式化代码

!r 格式化代码指明输出使用 __repr__() 来代替默认的 __str__()

用前面的类来测试一下:

1
2
3
4
5
6
>>> p = Pair(3, 4)
>>> print('p is {0!r}'.format(p))
p is Pair(3, 4) # 使用 !r 格式化后输出的是 __repr__()
>>> print('p is {0}'.format(p))
p is (3, 4) # 没有格式化的默认输出是 __str__()
>>>

{0.x} 格式化代码

上面的 format() 方法的使用看上去很有趣,格式化代码 {0.x} 对应的是第 1 个参数的 x 属性

因此,在下面的方法中,0 实际上指的就是 self 本身。

示例代码:

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

% 格式化代码

作为上面这种实现的一个替代,我们也可以使用 % 操作符。

示例代码:

1
2
def __repr__(self):
return 'Pair(%r, %r)' % (self.x, self.y)
毕小烦 wechat
「请扫一扫上面的二维码,关注老毕的微信公众号」
「您的赞赏是老毕持续创作的动力」