当前位置：首页 > news >正文

魔法方法：str( )

news 来源：原创 2025/5/14 15:25:19

在Python中，__str__() 是一个特殊的方法（也称为魔术方法或魔法方法），用于定义对象的字符串表示形式。当使用内置函数 str() 或者通过 print() 打印对象时，Python会调用对象的 __str__() 方法来获取其字符串表示。

作用

__str__() 方法的主要目的是为对象提供一个易于阅读的字符串表示，通常用于调试和日志记录。它返回字符串的应该是对用户友好的，便于理解对象的内容。

示例

以下是一个简单的类，展示了如何定义和使用 __str__() 方法：

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})"

# 创建对象
person = Person("Alice", 30)

# 使用 str() 或 print() 调用 __str__()
print(person)  # 输出: Person(name=Alice, age=30)
print(str(person))  # 输出: Person(name=Alice, age=30)

`str()` 与 `repr()`

__str__() 和 __repr__() 都用于定义对象的字符串表示，但它们的用途和行为有所不同：

__str__()：
- 用于生成对象的非正式字符串表示，通常更易于阅读，适合用户输出。
- 如果没有定义 __str__()，Python会默认调用 __repr__()。
__repr__()：
- 用于生成对象的正式字符串表示，通常更详细，适合调试和开发。
- 目标是返回一个可以用来重新创建对象的字符串（例如，通过 eval()）。
- 如果没有定义 __repr__()，Python会返回一个默认的字符串表示，通常是 <__main__.ClassName object at 0x...>。

示例：`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})"

# 创建对象
person = Person("Alice", 30)

# 使用 str() 和 repr()
print(person)  # 调用 __str__()，输出: Person(name=Alice, age=30)
print(repr(person))  # 调用 __repr__()，输出: Person(name='Alice', age=30)