超棒!推薦八個炫酷的 Python 裝飾器!
前言
Python 編程語言的一大優點是它把所有功能都打包到一個小包中,這些功能非常有用。
許多特性可以完全改變 Python 代碼的功能,這使得該語言更加靈活。如果使用得當,其中一些功能可以有效縮短編寫程序所需的時間。
實現這些目標的一個很好的例子是 Python 的裝飾器。
裝飾器
裝飾器(decorators)是一個可以用于改變一個 Python 函數對象行為的函數。它們可以應用于類和函數,可以做很多非常有趣的事情!
裝飾器可以用來縮短代碼、加速代碼并徹底改變代碼在 Python 中的行為方式。
不用說,這當然可以派上用場!今天我想炫耀一些我認為值得一試的裝飾器。
有很多裝飾器,但我選擇了一些我認為具有最酷功能的裝飾器。
1. @lru_cache
此列表中的第一個裝飾器來自 functools 模塊。
該模塊包含在標準庫中,非常易于使用。它還包含比這個裝飾器更酷的功能,但這個裝飾器肯定是我最喜歡的。
此裝飾器可用于使用緩存加速函數的連續運行。當然,這應該在使用時記住一些關于緩存的注意事項,但在通用使用情況下,大多數時候這個裝飾器是值得使用的。
能夠用一個簡單的裝飾器來加速代碼是非常棒的。
可以從這樣的裝飾器中受益的函數的一個很好的例子是遞歸函數,例如計算階乘的函數:
def factorial(n):
return n * factorial(n-1) if n else 1
遞歸在計算時間上可能非常困難,但添加此裝飾器有助于顯著加快此函數的連續運行速度。
def factorial(n):
return n * factorial(n-1) if n else 1
現在每當我們運行這個函數時,前幾個階乘計算將被保存到緩存中。
因此,下次我們調用該函數時,我們只需要計算我們之前使用的階乘之后的階乘。
當然,并不是所有的階乘計算都會被保存,但是很容易理解為什么這個裝飾器的一個很好的應用程序來加速一些自然很慢的代碼。
2. @jit
JIT 是即時編譯(Just In Time)的縮寫。通常每當我們在 Python 中運行一些代碼時,發生的第一件事就是編譯。
這種編譯會產生一些開銷,因為類型被分配了內存,并存儲為未分配但已命名的別名。使用即時編譯,我們在執行時才進行編譯。
在很多方面,我們可以將其視為類似于并行計算的東西,其中 Python 解釋器同時處理兩件事以節省一些時間。
Numba JIT 編譯器因將這一概念提供到 Python 中而聞名。與@lru_cache 類似,可以非常輕松地調用此裝飾器,并立即提高代碼的性能。Numba 包提供了 jit 裝飾器,它使運行更密集的軟件變得更加容易,而不必進入 C。
以下案例使用@jit 裝飾器加速蒙特卡洛方法計算。
from numba import jit
import random
(nopython=True)
def monte_carlo_pi(nsamples):
acc = 0
for i in range(nsamples):
x = random.random()
y = random.random()
if (x ** 2 + y ** 2) < 1.0:
acc += 1
return 4.0 * acc / nsamples
3. @do_twice
do_twice 裝飾器的功能與它的名字差不多。此裝飾器可用于通過一次調用運行兩次函數。這當然有一些用途,我發現它對調試特別有用。
它可以用于測量兩個不同迭代的性能。以 Functools 為例,我們可以讓一個函數運行兩次,以檢查是否有改進。該函數由 Python 中的裝飾器模塊提供,該模塊位于標準庫中。
from decorators import do_twice
def timerfunc():
%timeit factorial(15)
4. @count_calls
count_calls 裝飾器可用于提供有關函數在軟件中使用多少次的信息。
像 do_twice 一樣,這當然可以在調試時派上用場。
當添加到給定的函數時,我們將收到一個輸出,告訴我們該函數每次運行時已經運行了多少次。這個裝飾器也在標準庫的裝飾器模塊中。
from decorators import count_calls
def function_example():
print("Hello World!")
function_example()
function_example()
function_example()
5. @dataclass
為了節省編寫類的時間,我一直使用的最好的裝飾器之一是@dataclass 裝飾器。
這個裝飾器可用于快速編寫類中常見的標準方法,這些方法通常會在我們編寫的類中找到。
這個裝飾器來自 dataclass 模塊。這個模塊也在標準庫中,所以不需要 PIP 來嘗試這個例子!
from dataclasses import dataclass
class Food:
name: str
unit_price: float
stock: int = 0
def stock_value(self) -> float:
return(self.stock * self.unit_price)
這段代碼將自動創建一個初始化函數 init(),其中包含填充類中數據所需的位置參數。
它們也將自動提供給 self,因此無需編寫一個很長的函數來將一些數據參數放入類中。
6. @singleton
為了理解單例裝飾器的用途,我們首先需要了解單例(singleton)是什么。從某種意義上說,單例是全局變量類型的一個版本。
這意味著類型被定義為只存在一次。盡管這些在 C++ 等語言中很常見,但在 Python 中卻很少見到。使用單例,我們可以創建一個只使用一次的類并改變類,而不是通過初始化來構造新的類型。
通常,單例裝飾器是由用戶自己編寫的,實際上并不是導入的。
這是因為單例仍然是對我們單例裝飾器中提供的模板的引用。我們可以命名一個單例函數并編寫一個包裝器,以便在我們的類上使用這個裝飾器:
def singleton(cls):
instances = {}
def wrapper(*args, \*\*kwargs):
if cls not in instances:
instances[cls] = cls(*args, \*\*kwargs)
return instances[cls]
return wrapper
class cls:
def func(self):
另一種方法是使用元類!
7. @use_unit
在科學計算中經常派上用場的一種裝飾器是 @use_unit 裝飾器。
此裝飾器可用于更改返回結果的表示單位。這對于那些不想在數據中添加度量單位但仍希望人們知道這些單位是什么的人很有用。
這個裝飾器也不是在任何模塊中真正可用,但它是非常常見的,對科學應用程序非常有用。
def use_unit(unit):
"""Have a function return a Quantity with given unit"""
use_unit.ureg = pint.UnitRegistry()
def decorator_use_unit(func):
.wraps(func)
def wrapper_use_unit(*args, \*\*kwargs):
value = func(*args, \*_kwargs)
return value _ use_unit.ureg(unit)
return wrapper_use_unit
return decorator_use_unit
("meters per second")
def average_speed(distance, duration):
return distance / duration
8. @singledispatch
Functools 憑借非常有用的@singledispatch 裝飾器再次在此列表中脫穎而出。
單調度是一種編程技術,在許多編程語言中都很常見,因為它是一種非常棒的編程方式。雖然我更喜歡多調度,但我認為單調度可以在很多方面扮演相同的角色。
這個裝飾器使得在 Python 中使用多類型數據變得更加容易, 尤其當我們希望通過同一方法傳遞多種類型數據時,情況更是如此。
def fun(arg, verbose=False):
if verbose:
print("Let me just say,", end=" ")
print(arg)
.register
def \_(arg: int, verbose=False):
if verbose:
print("Strength in numbers, eh?", end=" ")
print(arg)
.register
def \_(arg: list, verbose=False):
if verbose:
print("Enumerate this:")
for i, elem in enumerate(arg):
print(i, elem)