python中的__str__

__str__ 是 Python 中的一个特殊方法，用于定义对象的字符串表示形式。这个方法允许你控制当你尝试打印或以字符串形式表示一个对象时，应该显示什么内容。简单来说，__str__ 方法定义了对象的“可读性”或“友好表示”。

1. 作用

• 当你打印一个对象（例如 print(obj)），或在交互式 Python 环境中输入对象的名字时，Python 会自动调用该对象的 __str__ 方法，来获取该对象的字符串表示形式。

• 这是非常有用的，特别是当你需要给对象提供一种清晰、易读的输出时。

2. 例子

假设你有一个 Question 类，表示问题的模型（例如 Django 中的模型类），你可能会这样定义 __str__ 方法：

class Question(models.Model):
    question_text = models.CharField(max_length=200)
    pub_date = models.DateTimeField("date published")

    def __str__(self):
        return self.question_text

在这个例子中，__str__ 方法返回了问题文本（question_text）。所以，当你打印一个 Question 对象时，它会显示问题的文本，而不是默认的对象内存地址或其他信息。

例子输出：

>>> q = Question(question_text="What's your name?", pub_date="2024-11-24")
>>> print(q)
What's your name?

这样，你在调试或打印对象时，就能看到更有意义的信息，而不仅仅是一个默认的内存地址表示。

3. 默认行为

• 如果你没有定义 __str__ 方法，Python 会使用默认的字符串表示，通常是对象的内存地址（例如：<__main__.Question object at 0x7f1b2d1fcd30>）。

• 通过定义 __str__，你可以避免这种默认输出，并使你的对象在输出时更具可读性。

4. 在 Django 中的应用

• 在 Django 中，__str__ 方法经常用于模型类。当你在 Django Admin 或者查询集视图中显示模型实例时，__str__ 方法会决定该实例如何显示。

• 比如，若你有一个 Question 模型，定义了 __str__ 方法返回 question_text，那么在 Django Admin 中查看 Question 对象时，会显示问题的文本，而不是模型的默认标识符。

  class Question(models.Model):
      question_text = models.CharField(max_length=200)
      pub_date = models.DateTimeField("date published")
  
      def __str__(self):
          return self.question_text
  

  这样，Django 在展示 Question 对象时，显示的将是 question_text 字段的值，而不是对象的内存地址。

5. 总结

• __str__ 方法提供了一个自定义的对象字符串表示，方便调试和展示。

• 它在 Python 和 Django 中被广泛应用，特别是在数据模型中，用来提高对象的可读性。

• 定义 __str__ 时，返回值应当是一个描述该对象的简洁且有意义的字符串。