Python __str__方法：自定義對象字符串表示

一、背景

在Python中，我們經常需要打印出對象的表示形式，方便我們進行調試和理解。默認情況下，Python會調用對象的__repr__方法來得到一個對象的字符串表示形式。但是有些情況下，__repr__方法返回的字符串可能比較複雜，不太容易理解。這時我們可以通過自定義__str__方法來為對象提供一個更加簡潔明了的字符串表示。

二、__str__方法的定義和使用

__str__方法是對象的一個特殊方法，用來返回對象的字符串表示。它的定義格式如下：

def __str__(self):
    return "字符串表示"

在這個方法中，我們可以根據需要返回一個字符串來表示對象。比如一個自定義的Person類：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

如果不定義__str__方法，打印一個Person對象時會輸出它的內存地址：

person = Person("張三", 18)
print(person)
# 輸出：

此時我們可以通過定義__str__方法來讓輸出更加友好：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def __str__(self):
        return "姓名：%s，年齡：%d" % (self.name, self.age)

現在再打印這個Person對象：

person = Person("張三", 18)
print(person)
# 輸出：姓名：張三，年齡：18

可以看到，現在輸出的信息更加直觀，也更方便理解。

三、__str__和__repr__的區別

我們已經知道，Python默認用__repr__方法來打印對象的字符串表示形式。那麼__str__方法和__repr__方法有什麼不同呢？

__repr__方法返回的是一個Python表達式，可以用來表示該對象的精確信息。而__str__方法返回的是該對象的簡化或可讀性更強的字符串形式，用於展示給人看。

簡單來說，__repr__方法是為開發者而設計的，__str__方法是為用戶而設計的。__repr__方法的返回值通常能夠使用eval()函數轉換回原來的對象，而__str__方法的返回值通常是希望用戶看到的形式。

四、使用場景

__str__方法可以在各種場合下使用。比如：

– 在控制台打印出對象信息時
– 在日誌中輸出對象信息時
– 在Web應用中把對象信息展示給用戶時

需要注意的是，__str__方法的返回值應該盡量簡潔，同時包含對象的重要信息。如果需要展示詳細的信息，應該使用__repr__方法。

除了定義__str__方法，還可以定義__unicode__方法來指定對象的Unicode字符串表示。如果同時定義了這兩個方法，__str__方法的返回值會優先於__unicode__方法的返回值。

五、總結

__str__方法允許我們自定義對象的字符串表示形式，在控制台、日誌等應用中提供更加友好的輸出信息。與__repr__方法不同，__str__方法的返回值應該簡潔明了，便於用戶理解。同時，__str__方法也是Python面向對象編程中的一個重要知識點，理解清楚它的作用和用法對於編寫高質量的Python程序有重要幫助。