一、__str__
方法
__str__
方法用于定义对象的“用户友好”字符串表示形式。它通常在使用print()
函数或str()
函数时被调用,目的是为了让对象的输出更易读,更符合人类阅读习惯。
如果一个对象没有定义__str__
方法,而又尝试使用print()
函数打印该对象,Python会调用对象的__repr__
方法作为备选方案来提供字符串表示形式。
__str__
方法应该返回一个字符串类型的值,可以直接被打印输出。
二、__repr__
方法
__repr__
方法用于定义对象的“开发者友好”字符串表示形式。它通常在交互式环境下(如Python解释器)被调用,或者使用repr()
函数时也会被调用。
__repr__
方法的目的是为了给出对象的详细信息,方便开发者调试和了解对象的内部结构。
如果一个对象没有定义__repr__
方法,Python会使用默认的__repr__
实现,该实现会返回一个包含对象类型和内存地址的字符串。
三、区别与适用场景
__str__
适合用于提供用户友好的输出,通常应该返回一个易读的字符串,便于展示给最终用户。
__repr__
适合用于提供开发者友好的输出,通常应该返回一个详细的字符串,便于开发者理解对象的内部结构和状态。
如果两个方法都被定义,__str__
会覆盖__repr__
,并在使用print()
函数时优先调用。
如果只定义了__repr__
而没有定义__str__
,那么在使用print()
函数时会调用__repr__
。
下面是一个示例代码,演示了__str__
和__repr__
方法的区别:
class Point: def __init__(self, x, y): self.x = x self.y = y def __str__(self): return f'Point({self.x}, {self.y})' def __repr__(self): return f'Point(x={self.x}, y={self.y})'p = Point(1, 2)print(p) # 输出: Point(1, 2)print(str(p)) # 输出: Point(1, 2)print(repr(p)) # 输出: Point(x=1, y=2)
延伸阅读
Python中的格式化字符串
除了在__str__
和__repr__
方法中自定义对象的字符串表示形式,Python还提供了格式化字符串的功能,以更灵活地控制输出结果。格式化字符串使用花括号 {}
作为占位符,可以在其中插入变量、表达式或对象的属性。
在Python 3.6及以上版本中,引入了f-string(格式化字符串字面值)的特性,它允许在字符串前添加 f
或 F
,然后在字符串中使用花括号插入表达式。f-string非常方便,可以在字符串中直接引用变量,使得代码更简洁易读。
示例代码:
name = "Alice"age = 30print(f"My name is {name} and I am {age} years old.")
除了f-string,Python还支持str.format()
方法和旧式的%
格式化方法,它们提供了更多的灵活性和兼容性。格式化字符串的选择取决于个人偏好和项目要求,可以根据具体情况选择非常适合的方式来格式化字符串。