python中__str__与__repr__

本文探讨了Python中如何使用__str__和__repr__方法来自定义类实例的显示方式,详细解释了两种方法的区别及应用场景,并提供了避免无限递归的注意事项。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

 

(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)')
View Code

 当类实例化对象被打印或者转化为字符时,如果定义了__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

<think>好的,我现在需要帮助用户了解Python中的__repr__方法。首先,我得回顾一下自己对这个方法的理解。__repr__是一个特殊方法,用于返回对象的字符串表示,通常用于调试和日志记录。它的目的是提供一个明确的、可执行的表达式,能够重新创建该对象。如果用户没有自定义__repr__,Python会使用默认的实现,比如显示类名和内存地址。 接下来,我要确认用户的需求。他们可能想知道如何正确使用__repr__,或者如何在自己的类中实现它。可能需要例子来说明,比如覆盖__repr__方法后的效果,以及__str__方法的区别。用户可能也想知道何时使用__repr__,何时使用__str__,或者为什么有时候打印对象并没有显示预期的字符串。 然后,我需要检查提供的引用内容,看看有没有相关的信息。引用3提到了字符串的startswith方法,这可能和字符串表示有关,但不太直接。引用4讨论了类方法、静态方法和实例方法的区别,可能方法的定义有关,但同样不直接关联。其他引用主要涉及生成器、计时器和重命名操作,似乎和__repr__关系不大。不过,引用5提到Python使用抽象工厂,这可能对象的创建有关,但不确定是否有联系。因此,主要还是要依靠自己的知识来回答。 接下来,我需要组织回答的结构。首先解释__repr__的作用,然后给出实现的示例代码,说明__str__的区别,最后强调最佳实践。同时,根据用户的要求,生成相关问题。需要注意的是,用户要求回答使用中文,并且数学表达式要符合格式,但这个问题可能不涉及数学内容,所以可能不需要处理这部分。 在实现示例时,要确保代码正确,比如在类中定义__repr__方法,并返回一个字符串。可能还需要展示当打印对象或直接在解释器中查看时的不同输出,以说明reprstr的区别。此外,要提到如果只定义__repr__而没有定义__str__,那么当调用str()或print()时,Python会回退到使用__repr__的结果,这样可以节省代码量。 最后,生成的相关问题应该围绕__repr__的扩展,比如__str__的区别、如何确保eval(repr(obj))可行、适用场景等。这些问题应该能帮助用户进一步理解该方法的用途和实现细节。</think>### Python中__repr__方法的用法实现 #### 1. __repr__方法的作用 `__repr__`是Python中定义对象“官方字符串表示”的特殊方法,主要用于调试和开发场景。其返回值应满足以下两个条件之一: - 可执行的Python表达式,能够通过`eval(repr(obj))`重建对象[^1] - 描述对象状态的清晰字符串(若无法满足表达式要求) #### 2. 基础实现示例 ```python class Point: def __init__(self, x, y): self.x = x self.y = y def __repr__(self): return f"Point({self.x}, {self.y})" # 满足eval重建条件 p = Point(3, 4) print(repr(p)) # 输出: Point(3, 4) ``` #### 3. __str__的区别 | 方法 | 触发场景 | 默认实现示例 | |-----------|--------------------------|-----------------| | `__repr__` | `repr(obj)`、交互式解释器显示 | `<Point at 0x...>` | | `__str__` | `str(obj)`、`print(obj)` | 同__repr__ | 当未定义`__str__`时,Python会回退使用`__repr__`[^4] #### 4. 最佳实践 - 优先实现`__repr__`,因其适用场景更广泛 - 包含关键属性信息 - 对集合类对象建议显示类型信息 ```python class Inventory: def __init__(self, items): self.items = list(items) def __repr__(self): return f"Inventory({self.items!r})" # !r表示调用元素的repr stock = Inventory(["apple", "banana"]) print(stock) # 输出: Inventory(['apple', 'banana']) ``` #### 5. 高级应用 通过`__repr__`实现动态信息显示: ```python class RealTimeData: def __init__(self): self.timestamp = time.time() def __repr__(self): return f"<RealTimeData updated at {time.ctime(self.timestamp)}>" ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值