讓程式碼更簡潔、更有效率的基本 Python 裝飾器模式

身為暢銷書作家，我邀請您在亞馬遜上探索我的書。不要忘記在 Medium 上關注我並表示您的支持。謝謝你！您的支持意味著全世界！

Python 裝飾器是一個強大的功能，它允許我們修改或增強函數和類，而不改變它們的核心邏輯。作為一名開發人員，我發現掌握裝飾器模式可以顯著提高程式碼品質、可重複使用性和可維護性。讓我們探索七種基本的裝飾器模式，我發現它們在我的專案中特別有用。

類裝飾器

類別裝飾器提供了一種修改或增強類別行為和屬性的方法。它們是使用類別定義上方的 @decorator 語法應用的。我經常使用類別裝飾器來新增方法、修改現有方法或更改類別屬性。

這是一個向類別添加新方法的類別裝飾器範例：

def add_greeting(cls):
    def say_hello(self):
        return f"Hello, I'm {self.name}"
    cls.say_hello = say_hello
    return cls

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

person = Person("Alice")
print(person.say_hello())  # Output: Hello, I'm Alice

在此範例中，add_greeting 裝飾器為 Person 類別新增了 say_hello 方法。當您想要跨多個類別擴充功能而不修改其原始程式碼時，此模式特別有用。

帶參數的函數裝飾器

接受參數的函數裝飾器提供了更大的靈活性。它們允許我們自訂裝飾器本身的行為。我發現這種模式在創建可重複使用的裝飾器時非常有用，可以針對不同的用例進行微調。

這是一個可以重複函數呼叫指定次數的裝飾器範例：

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(times=3)
def greet(name):
    print(f"Hello, {name}!")

greet("Bob")
# Output:
# Hello, Bob!
# Hello, Bob!
# Hello, Bob!

在此範例中，repeat 裝飾器接受一個參數 times 來決定應呼叫裝飾函數的次數。這種模式為我們如何將裝飾器應用到我們的函數提供了極大的靈活性。

保留函數元資料

使用裝飾器時，保留原始函數的元資料很重要。這包括函數的名稱、文件字串和其他屬性。 Python 標準函式庫中的 functools.wraps 裝飾器幫助我們實現了這一點。

這是一個例子：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """This is the wrapper function"""
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
    return wrapper

@my_decorator
def say_hello(name):
    """This function greets someone"""
    print(f"Hello, {name}!")

say_hello("Charlie")
print(say_hello.__name__)  # Output: say_hello
print(say_hello.__doc__)   # Output: This function greets someone

透過使用@wraps(func)，我們確保包裝函數採用原始函數的元資料。這對於調試和內省至關重要。

堆疊多個裝飾器

裝飾器可以堆疊，允許將多個裝飾器應用於單一函數。裝飾的順序很重要，裝飾器是從下到上應用的。

這是一個例子：

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def greet(name):
    print(f"Hello, {name}!")

greet("David")
# Output:
# Decorator 1
# Decorator 2
# Hello, David!

在此範例中，先套用decorator2，然後套用decorator1。使用多個裝飾器時，理解執行順序至關重要。

記憶裝飾器

記憶化是一種最佳化技術，它儲存昂貴的函數呼叫的結果，並在相同的輸入再次出現時傳回快取的結果。我發現記憶裝飾器對於提高遞歸函數或具有昂貴計算量的函數的表現非常有用。

這是記憶化裝飾器的範例：

def add_greeting(cls):
    def say_hello(self):
        return f"Hello, I'm {self.name}"
    cls.say_hello = say_hello
    return cls

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

person = Person("Alice")
print(person.say_hello())  # Output: Hello, I'm Alice

這個記憶裝飾器緩存斐波那契函數的結果，大大提高了大輸入的表現。

計時與錄音裝飾器

用於計時函數執行和記錄函數呼叫的裝飾器對於效能分析和偵錯非常有用。我在開發過程中經常使用這些。

這是組合計時和日誌記錄裝飾器的範例：

def repeat(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@repeat(times=3)
def greet(name):
    print(f"Hello, {name}!")

greet("Bob")
# Output:
# Hello, Bob!
# Hello, Bob!
# Hello, Bob!

這個裝飾器記錄函數何時被呼叫以及執行需要多長時間。我發現這種模式對於識別程式碼中的效能瓶頸非常有價值。

上下文管理器裝飾器

上下文管理器通常與 with 語句一起使用，以進行資源管理和錯誤處理。我們可以創建將函數轉變為上下文管理器的裝飾器，從而允許優雅的設定和拆卸操作。

這是一個例子：

from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """This is the wrapper function"""
        print("Something is happening before the function is called.")
        result = func(*args, **kwargs)
        print("Something is happening after the function is called.")
        return result
    return wrapper

@my_decorator
def say_hello(name):
    """This function greets someone"""
    print(f"Hello, {name}!")

say_hello("Charlie")
print(say_hello.__name__)  # Output: say_hello
print(say_hello.__doc__)   # Output: This function greets someone

在此範例中，file_manager 裝飾器可確保檔案在操作後正確關閉，即使發生異常也是如此。

創建和使用裝飾器的最佳實踐

在與裝飾者合作時，我學到了一些對我很有幫助的最佳實踐：

1. 使用 functools.wraps 儲存函數元資料。
2. 保持裝飾器簡單並專注於單一職責。
3. 當您需要將參數傳遞給裝飾器時，請使用裝飾器工廠。
4. 注意裝飾器對效能的影響，特別是對於頻繁呼叫的函數。
5. 清楚地記錄你的裝飾器，解釋它們的作用以及它們可能產生的任何副作用。
6. 調試時，請記住裝飾器添加了一個間接層。 Python 偵錯器中的 @ 語法等工具可以幫助您進入修飾函數。

測試修飾程式碼有時可能很棘手。我經常使用的一種方法是將裝飾器與裝飾函數分開測試。這允許更精細的測試和更輕鬆的調試。

以下是如何測試裝飾器的範例：

def decorator1(func):
    def wrapper(*args, **kwargs):
        print("Decorator 1")
        return func(*args, **kwargs)
    return wrapper

def decorator2(func):
    def wrapper(*args, **kwargs):
        print("Decorator 2")
        return func(*args, **kwargs)
    return wrapper

@decorator1
@decorator2
def greet(name):
    print(f"Hello, {name}!")

greet("David")
# Output:
# Decorator 1
# Decorator 2
# Hello, David!

在此測試中，我們使用模擬函數來驗證我們的裝飾器是否正確呼叫原始函數並傳回其結果。

裝飾器是 Python 中的強大工具，掌握這些模式可以顯著增強您的編碼能力。它們允許乾淨地分離關注點，促進程式碼重用，並且可以使您的程式碼更具可讀性和可維護性。

我發現有效使用裝飾器的關鍵是從簡單開始，然後根據需要逐漸增加複雜性。從基本的函數裝飾器開始，然後轉向類別裝飾器和更高級的模式，例如裝飾器工廠。

請記住，雖然裝飾器可以極大地改進您的程式碼，但應謹慎使用它們。過度使用裝飾器可能會導致程式碼難以理解和調試。始終考慮裝飾器是否是適合您的特定用例的最佳解決方案。

當您繼續與裝飾器合作時，您可能會發現新的模式和用例。 Python 社群不斷創新，新的裝飾器技術定期出現。保持好奇心，嘗試不同的方法，並毫不猶豫地創建自己的裝飾器模式來解決專案中的獨特問題。

裝飾器只是 Python 中眾多強大功能之一，可以幫助您編寫更乾淨、更有效率的程式碼。隨著您對裝飾器越來越熟悉，您會發現它們與其他 Python 功能（例如生成器、上下文管理器和元類）很好地集成，為優雅而強大的程式碼設計開闢了更多可能性。

---

101 本書

101 Books是一家由人工智慧驅動的出版公司，由作家Aarav Joshi共同創立。透過利用先進的人工智慧技術，我們將出版成本保持在極低的水平——一些書籍的價格低至 4 美元——讓每個人都能獲得高品質的知識。

查看我們的書Golang Clean Code，亞馬​​遜上有售。

請繼續關注更新和令人興奮的消息。購買書籍時，搜尋 Aarav Joshi 以尋找更多我們的書籍。使用提供的連結即可享受特別折扣！

我們的創作

一定要看看我們的創作：

投資者中心 | 投資者中央西班牙語 | 投資者中德意志 | 智能生活 | 時代與迴響 | 令人費解的謎團 | 印度教 | 菁英發展 | JS學校

---

我們在媒體上

科技無尾熊洞察 | 時代與迴響世界 | 投資人中央媒體 | 令人費解的謎團 | | 令人費解的謎團 | >科學與時代媒介 |

現代印度教

以上是讓程式碼更簡潔、更有效率的基本 Python 裝飾器模式的詳細內容。更多資訊請關注PHP中文網其他相關文章！