python中__str__与__repr__

时间:2021-12-12 15:12:25

(1)背景

python中,对于类(自定义类)的实例对象的默认显示既没有太大用处,也不美观。比如:

 class adder:
def __init__(self,value=0):
self.data=value #初始化数据
def __add__(self,other):
self.data+=other
6>>> x=adder()
>>>print(x)
   <__main__.adder. object at 0x.....>
>>>x
    <__main__.adder object at 0x......>

而通过__str__或者__repr__,可以定制化(costomise)显示,比如,下面代码中,在子类中定义了一个返回实例字符的__repr__方法。注意,在python3中所有对象都继承了object的__str__,也就是实例对象的默认显示。

 >>>class addrepr(adder):
def __repr__(self):
return 'addrepr(%s)'% self.data
>>>x=addrepr(2) #运行__init__
>>>x+1 #运行__add__
>>>x #运行__repr__
addrepr(3)
>>>print(x) #运行__repr__
addrepr(3)
>>>str(x),repr(x) #均运行__repr__
('addrepr(3)','addrepr(3)')

当类实例化对象被打印或者转化为字符时,如果定义了__repr__(或者__str__),那么该__repr__(或者__str__)将被自动调用,这里__repr__用了最基本的字符格式来将self.data转化为友好的字符显示。

(2)为什么要用两种显示方法

虽然__str__与__rer__的作用都是为了获得更友好的字符显示,但对于代码的设计有一些细微的区别。

(a)对于print和str内建函数,程序会首先尝试__str__函数,如果没有__str__函数,则尝试__repr__函数,如果没有__repr__函数,则选用默认显示;

(b)在其他情况下,比如交互式回应(interactive echoes),repr函数,和嵌套中,__repr__被调用,一般地,它应该为开发者返回较为详细的显示。

下面通过代码说明两种方法的不同:

 >>>class addstr(adder):
def __str__(self):
return '[value:%s]'% self.data
>>>x=addstr(3)
>>>x #默认显示
<__main__.addstr object at 0x....>
>>>print(x) #调用__str__
[value:4]
>>>str(x),repr(x)
('[value:4]','<__main__.addstr object at 0x...>

(c)如果同时定义了两种方法,那么可以在不同情况下,支持不同的显示。如下面代码:

 >>>class addboth(adder):
def __str__(self):
return '[value:%s]'%self.data
def __repr__(self):
return 'addboth(%s)'% self.dat
>>>x=addboth(4)
>>>x+1
>>>x #调用__repr__
addboth(5)
>>>print(x) #调用__str__
[value:5]
>>>str(x),repr(x) #分别调用__str_,__repr__
('[value:5]','addboth(5)')

总结下来以上几点就是:只有在print(),str()时,才会调用__str__()(如果没有__str__则调用__repr__),其他情况均调用__repr__,如交互式情况下单独显示,repr()等。

(3)使用的三点注意

(a)首先是__str__和__repr__必须均返回字符,返回其他类型,将会报错,所以必要的话必须确保它们进行字符转换(比如str,%s)。

(b)根据容器(container)的字符转换,仅有当对象出现在print的顶层时,才会调用__str__;嵌套在大的对象里的对象显示,将仍调用__repr__,下面代码说明了这一点:

 >>>class Printer:
def __init__(self,value):
self.value=value
def __str__(self):
return str(self.value)
>>>objs=[Printer(2),Printer(3)]
>>>for x in objs:print(x) 2
3
>>>print(objs)
[<__main__.Printer object at 0x....>]
>>>objs
[<__main__.Printer object at 0x....>,<__main__.Printer object at 0x....>]

为确保不论有无容器,在所有情况下显示设定的显示模式,用__repr__,不用__str__,用如下代码进行说明:

 >>> class Printer:
def __init__(self,value):
self.val=value
def __repr__(self): #如果没有__str__,调用__repr__
return '%s'% self.val >>> objs=[Printer(2),Printer(3)]
>>> for x in objs:print(x) 2
3
>>> print(objs) #调用__repr__
[2, 3]
>>> objs
[2, 3]

(c)第三,也是最为微妙的,显示方法在极少情况下有时又也有可能触发无限迭代循环(infinite recursion loops),因为一些对象的显示包括了其他对象的的显示,而一个显示触发了正在被显示的对象的显示,因而进入无限循环中。如下代码:

"""
this scripts is intended to illustrate the infinite recursion loops
caused by __repr__ overloading methods. displaying the value of a method,line10 in this script, can trigger the __repr__
of the class method, then the __repr__ method is called again, and the infinite recursion loops happen.
"""
class Base:
def __init__(self):
self.data=1
def print0(self):
pass
def print1(self):
a=str(getattr(self,'print0')) #Caution! getattr(object,attrname),attrname shall be string.
return a
class Normal(Base):
def __str__(self):
return '%s'% self.print1()
class Recursion(Base):
def __repr__(self):
return '%s'% self.print1()
if __name__=='__main__':
a=Normal()
b=Recursion()
print(a)
try:
print(b)
except RecursionError:
print('A recusion error happens')

运行结果为:

<bound method Base.print0 of <__main__.Normal object at 0x02E68450>>
A recusion error happens