python 类方法之 __repr__() vs __str__()

本文深入解析Python中__repr__方法的作用及其实现机制,解释如何通过重写此方法使对象具备自我描述能力,提高代码可读性和调试效率。

Demo

class Vector(object):

    def __init__(self, x=0, y=0):
        self.x = x
        self.y = y

    def __repr__(self):
        return 'Vector(%r, %r)-repr' % (self.x, self.y)

    def __abs__(self):
        return 'Vector(%r, %r)-str' % (self.x, self.y)

Result

                  

Comment

  • __repr__()方法是object类提供的方法,而所有的Python类都是object类的子类,因此所有的Python对象都具有__repr__() 方法。所以如果需要将任何对象与字符串进行连接时,都可先调用__repr__()方法将对象转为字符串,再将字符串连接在一起。
  • __repr__()之所以特殊,是因为它是一个“自我描述”的方法,该方法通常实现场景是:当开发人员直接打印该对象时,系统将会输出该对象的“自我描述”信息,用来告诉外界该对象具有的状态信息
  • object类提供的__repr__()方法总是返回该对象实现类的“类名+object at + 内存地址”值,这个返回值并不能真正实现“自我描述”的功能,因此如果用户需要自定义类能实现“自我描述”的功能,就必须重写__repr__()方法。
  • 一般来说__str__()的可读性更强,而__repr__()的返回结果更具有准确性,更加的适合开发者。
  • 对于开发者而言,在实现类时,建议重写__repr__()函数
### 作用 在 Python 中,`__str__` 和 `__repr__` 都是用于定义对象的字符串表示的魔法方法,它们的目的和使用场景不同,但都用于将对象转换为字符串形式展示[^2]。 - **`__str__`**:用于生成用户友好的字符串表示,它应该返回一个易于理解的字符串,通常是在打印或显示对象时使用。当使用 `print()` 或 `str()` 函数时,Python 会调用 `__str__` 方法。如果没有定义 `__str__`,Python 会回退到 `__repr__` 方法[^2]。 - **`__repr__`**:用于生成开发者友好的字符串表示,它返回的字符串通常包含足够的信息,以便能够准确地重建对象。当在交互式环境中直接输入对象名,或者使用 `repr()` 函数时,Python 会调用 `__repr__` 方法。 ### 区别 - **面向对象不同**:`__str__` 旨在面向最终用户,返回的字符串应该简洁且易于理解;而 `__repr__` 主要面向开发者,提供对象的详细信息,方便调试和开发[^2]。 - **调用场景不同**:`__str__` 会在使用 `print()` 或 `str()` 函数时被调用;`__repr__` 会在交互式环境中直接输入对象名或使用 `repr()` 函数时被调用。 ### 使用方法 以下是一个示例,展示了 `__str__` 和 `__repr__` 的使用方法: ```python class Person: def __init__(self, name, age): self.name = name self.age = age def __str__(self): return f"Person(Name: {self.name}, Age: {self.age})" def __repr__(self): return f"Person(name='{self.name}', age={self.age})" p = Person("Alice", 30) # 调用 __str__ print(str(p)) # 调用 __repr__ print(repr(p)) ``` 在这个示例中,`__str__` 方法返回了一个简洁的、用户友好的字符串,而 `__repr__` 方法返回了一个更详细的、可以用于重建对象的字符串。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ReLuJie

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值