Python中的__str__方法及其應用

一、什麼是__str__方法

在Python中，每個類都包含一些特殊方法，其中__str__便是其中一個。當我們調用print方法時，通常會輸出該對象的一些信息。但是如果沒有定義__str__方法，輸出的信息不一定是我們需要的，這時就需要使用__str__特殊方法來自定義輸出的格式。

__str__方法定義了如何輸出該對象的字符串表示形式。在應用中，我們常常使用__str__方法來告訴程序如何「print」當前的實例。

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("John", 25)
print(person)
# 輸出: Person: name='John', age=25
 

二、__str__與__repr__的區別

在Python中，除了__str__方法，還有一種特殊方法__repr__。__str__和__repr__方法的不同主要在於調用方式。當你使用repr()時，或在進入交互式環境時，它會打印一些特殊信息（格式通常類似於Python表達式）以供調試使用。另一方面，當你使用str()時，它就會傾向於輸出更可讀性更好的信息，這樣就更適合用於顯示給終端用戶。

通常情況下，我們都需要實現__repr__方法。這樣做是因為在打印實例時，如果沒有定義__str__方法，Python就會調用__repr__方法作為替代品。

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

    def __repr__(self):
        return f"Person(name='{self.name}', age={self.age})"

person = Person("John", 25)
print(repr(person))
# 輸出: Person(name='John', age=25)
 

三、__str__方法的應用場景

__str__方法可以應用在各種場景中，我們可以通過__str__方法來改變類的實例在不同場景下的輸出效果。

比如，我們可以在使用類實現日誌記錄器時，通過__str__方法來輸出指定格式的字符串。

import logging

class Logger:
    def __init__(self, name):
        self.name = name
        self.logger = logging.getLogger(name)
    
    def __str__(self):
        return f""

logger = Logger("MyLogger")
print(logger)  # 輸出: 
 

又如，我們可以在使用類來生成網頁時，通過__str__方法來指定HTML標籤的輸出。

class HTMLTag:
    def __init__(self, tag, content=""):
        self.tag = tag
        self.content = content

    def __str__(self):
        return f"<{self.tag}>{self.content}</{self.tag}>"

h1 = HTMLTag("h1", "Python中的__str__方法及其應用")
print(h1)  # 輸出: <h1>Python中的__str__方法及其應用</h1>
 

四、__str__方法與繼承

在Python的面向對象中，類可以繼承其他類的屬性和方法。當我們在子類中定義__str__方法時，它會覆蓋從父類中繼承的__str__方法。

class Animal:
    def __init__(self, species):
        self.species = species
    
    def __str__(self):
        return f"{self.species}"

class Dog(Animal):
    def __init__(self, name):
        super().__init__("Dog")
        self.name = name

    def __str__(self):
        return f"{self.species}: {self.name}"

dog = Dog("Buddy")
print(dog)  # 輸出: Dog: Buddy
 

在這個例子中，Dog類繼承了Animal類，並繼承了Animal類的__str__方法。但是由於Dog類中定義了自己的__str__方法，因此它會覆蓋從Animal類繼承的__str__方法。

五、總結

在Python中，__str__方法是一個非常強大的特殊方法，能夠幫助我們以自己設定的方式來打印類的實例。

主要內容如下：

1. __str__方法定義了如何輸出該對象的字符串表示形式，可以用於告訴程序如何「print」當前的實例。

2. __str__和__repr__方法的不同主要在於調用方式，後者多用於調試使用。

3. __str__方法可以應用在各種場景中，例如類實現日誌記錄器、生成網頁等。

4. 當我們在子類中定義__str__方法時，它會覆蓋從父類中繼承的__str__方法。