python中__str__与__repr__

(1)背景

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

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

而通过__str__或者__repr__,可以定制化(costomise)显示,比如,下面代码中,在子类中定义了一个返回实例字符的__repr__方法。

 1 >>>class addrepr(adder):
 2     def __repr__(self):
 3         return ‘addrepr(%s)‘% self.data
 4 >>>x=addrepr(2)                               #运行__init__
 5 >>>x+1                                             #运行__add__
 6 >>>x                                                  #运行__repr__
 7 addrepr(3)
 8 >>>print(x)                                          #运行__repr__
 9 addrepr(3)
10 >>>str(x),repr(x)                                   #均运行__repr__
11 (‘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__被调用,一般地,它应该为开发者返回较为详细的显示。

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

 1 >>>class addstr(adder):
 2         def __str__(self):
 3             return ‘[value:%s]‘% self.data
 4 >>>x=addstr(3)
 5 >>>x                                                     #默认显示
 6 <__main__.addstr object at 0x....>
 7 >>>print(x)                                              #调用__str__
 8 [value:4]
 9 >>>str(x),repr(x)
10 (‘[value:4]‘,‘<__main__.addstr object at 0x...>

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

 1 >>>class addboth(adder):
 2     def __str__(self):
 3         return ‘[value:%s]‘%self.data
 4     def __repr__(self):
 5         return ‘addboth(%s)‘% self.dat
 6 >>>x=addboth(4)
 7 >>>x+1
 8 >>>x                          #调用__repr__
 9 addboth(5)
10 >>>print(x)                 #调用__str__
11 [value:5]
12 >>>str(x),repr(x)         #分别调用__str_,__repr__
13 (‘[value:5]‘,‘addboth(5)‘)

(3)使用的三点注意

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

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

 1 >>>class Printer:
 2     def __init__(self,value):
 3         self.value=value
 4     def __str__(self):
 5         return str(self.value)
 6 >>>objs=[Printer(2),Printer(3)]
 7 >>>for x in objs:print(x)
 8
 9 2
10 3
11 >>>print(objs)
12 [<__main__.Printer object at 0x....>]
13 >>>objs
14 [<__main__.Printer object at 0x....>]

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

 1 >>> class Printer:
 2     def __init__(self,value):
 3         self.val=value
 4     def __repr__(self):                   #如果没有__str__,调用__repr__
 5         return ‘%s‘% self.val
 6
 7
 8 >>> objs=[Printer(2),Printer(3)]
 9 >>> for x in objs:print(x)
10
11 2
12 3
13 >>> print(objs)                                 #调用__repr__
14 [2, 3]
15 >>> objs
16 [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

原文地址:https://www.cnblogs.com/johnyang/p/10354787.html

时间: 2024-08-27 15:38:20

python中__str__与__repr__的相关文章

python进阶五(定制类)【5-1 python中__str__和__repr__】

python中 __str__和__repr__ 如果要把一个类的实例变成 str,就需要实现特殊方法__str__(): 1 class Person(object): 2 def __init__(self, name, gender): 3 self.name = name 4 self.gender = gender 5 def __str__(self): 6 return '(Person: %s, %s)' % (self.name, self.gender) 现在,在交互式命令行

Python中__str__和__repr__的区别

Python有一个内置的函数叫repr,它能把一个对象用字符串的形式表达出来以便辨认,这就是"字符串表示形式".repr就是通过__repr__这个特殊方法来得到一个对象的字符串表示形式.如果没有实现__repr__,当我们再控制台里打印一个变量的实例时,得到的字符串可能会是<__main__.Object at 0x14af07dbe80>,这个表示的是打印的对象,以及对象的内存地址 现在让我们看看__str__和__repr__这两个方法有什么区别 首先定义一个类 cl

python中 __str__和__repr__

如果要把一个类的实例变成 str,就需要实现特殊方法__str__(): class Person(object): def __init__(self, name, gender): self.name = name self.gender = gender def __str__(self): return '(Person: %s, %s)' % (self.name, self.gender) 现在,在交互式命令行下用 print 试试: 但是,如果直接敲变量 p: 似乎__str__(

python中定制类

1.python中__str__和repr 如果要把一个类的实例变成 str,就需要实现特殊方法__str__(): class Person(object): def __init__(self, name, gender): self.name = name self.gender = gender def __str__(self): return '(Person: %s, %s)' % (self.name, self.gender) 现在,在交互式命令行下用 print 试试: >>

Python中的__str__()方法和__repr__()方法

有时候我们想让屏幕打印的结果不是对象的内存地址,而是它的值或者其他可以自定义的东西,以便更直观地显示对象内容,可以通过在该对象的类中创建或修改__str__()或__repr__()方法来实现(显示对应方法的返回值) 注意:__str__()方法和__repr__()方法的返回值只能是字符串! 关于调用两种方法的时机 使用print()时 使用%s.f'{}'拼接对象时 使用str(x)转换对象x时 在上述三种场景中,会优先调用对象的__str__()方法:若没有,就调用__repr__()方法

python中魔法方法__str__与__repr__的区别

提出问题 当我们自定义一个类时,打印这个类对象或者在交互模式下直接输入这个类对象按回车,默认显示出来的信息好像用处不大.如下所示 In [1]: class People: ...: def __init__(self, name, sex): ...: self.name = name ...: self.sex = sex ...: In [2]: p = People('xiaoming', 'male') In [3]: p Out[3]: <__main__.People at 0x7

python类中方法__str__()和__repr__()简单粗暴总结

在交互式模式下,类中同时实现__str__()和__repr__()方法: 直接输入实例名称显示repr返回的类容: 用print打印实例名称显示str返回的内容: >>> class Test: ... def __repr__(self): ... return 'Test -> return repr' ... def __str__(self): ... return 'Test -> return str' ... >>> t = Test() &

python 的特殊方法 __str__和__repr__

__str__和__repr__ 如果要把一个类的实例变成 str,就需要实现特殊方法__str__(): class Person(object): def __init__(self, name, gender): self.name = name self.gender = gender def __str__(self): return '(Person: %s, %s)' % (self.name, self.gender) 现在,在交互式命令行下用 print 试试: >>>

Python中关于类和函数的初体验之&quot;__init__&quot;和&quot;__str__&quot;不是&quot;_init_&quot;和&quot;_str_&quot;

刚刚接触Python,今天就是怎么也调试不过去了,上网上查直到晚上才查到一个有效信息,真是坑啊!原来Python中的这些“魔法”方法的命名里就有陷阱…… 上图中的那两个红圈圈,一定要记住哦,这些Python自带的方法,比如str和init前后都是两个"_",写一个"_"按F5运行肯定有问题! 拿我的同事猫脸屁做个类,因为他最烦人,所以我学习的时候也会带着他(二次元击打松尾芭蕉桑): 1 import time 2 def GetNowYear(): 3 return