python基礎（補充）：python三大器之裝飾器
- 2021 年 4 月 17 日
- 筆記
- python基礎系列
函數作為返回值
高階函數除了可以接受函數作為參數外，還可以把函數作為結果值返回。
我們來實現一個可變參數的求和。通常情況下，求和的函數是這樣定義的：
def calc_sum(*args):
i = 0
for n in args:
i = i + n
return i
但是，如果不需要立刻求和，而是在後面的程式碼中，根據需要再計算怎麼辦？可以不返回求和的結果，而是返回求和的函數：
def lazy_sum(*args):
def sum():
i = 0
for n in args:
i = i + n
return i
return sum
當我們調用lazy_sum()時，返回的並不是求和結果，而是求和函數：
f = lazy_sum(1, 3, 5, 7, 9)
print(f)
# <function lazy_sum.<locals>.sum at 0x000002C5C32328C8>
調用函數f時，才真正計算求和的結果：
print(f())
# 25
在這個例子中，我們在函數lazy_sum中又定義了函數sum，並且，內部函數sum可以引用外部函數lazy_sum的參數和局部變數，當lazy_sum返回函數sum時，相關參數和變數都保存在返回的函數中，這種稱為「閉包（Closure）」的程式結構擁有極大的威力。
請再注意一點，當我們調用lazy_sum()時，每次調用都會返回一個新的函數，即使傳入相同的參數：
f1 = lazy_sum(1, 3, 5, 7, 9)
f2 = lazy_sum(1, 3, 5, 7, 9)
print(f1 == f2)
# False
f1()和f2()的調用結果是互不影響的。
閉包
返回的函數在其定義內部引用了局部變數args，所以，當一個函數返回了一個函數後，其內部的局部變數還被新函數引用，所以，閉包用起來簡單，實現起來可不容易。
另一個需要注意的問題是，返回的函數並沒有立刻執行，而是直到調用了f()才執行。我們來看一個例子：
def count():
fs = []
for i in range(1, 4):
def f():
return i*i
fs.append(f)
return fs
f1, f2, f3 = count()
在上面的例子中，每次循環，都創建了一個新的函數，然後，把創建的3個函數都返回了。
你可能認為調用f1()，f2()和f3()結果應該是1，4，9，但實際結果是：
print(f1())
# 9
print(f2())
# 9
print(f3())
# 9
全部都是9！原因就在於返回的函數引用了變數i，但它並非立刻執行。等到3個函數都返回時，它們所引用的變數i已經變成了3，因此最終結果為9。
返回閉包時牢記一點：返回函數不要引用任何循環變數，或者後續會發生變化的變數。
如果一定要引用循環變數怎麼辦？方法是再創建一個函數，用該函數的參數綁定循環變數當前的值，無論該循環變數後續如何更改，已綁定到函數參數的值不變：
def count():
def f(j):
def g():
return j*j
return g
fs = []
for i in range(1, 4):
fs.append(f(i)) # f(i)立刻被執行，因此i的當前值被傳入f()
return fs
f1, f2, f3 = count()
再看看結果：
print(f1())
# 1
print(f2())
# 4
print(f3())
# 9
缺點是程式碼較長，可利用lambda函數縮短程式碼。
由於函數也是一個對象，而且函數對象可以被賦值給變數，所以，通過變數也能調用該函數。
def now():
print('2021-04-17')
f = now
f()
__name__屬性
函數對象有一個__name__屬性，可以拿到函數的名字：
print(now.__name__) # now
print(f.__name__) # now
裝飾器
現在，假設我們要增強now()函數的功能，比如，在函數調用前後自動列印日誌，但又不希望修改now()函數的定義，這種在程式碼運行期間動態增加功能的方式，稱之為「裝飾器」（Decorator）。
decorator的本質就是閉包。所以，我們要定義一個能列印日誌的decorator，可以定義如下：
def log(func):
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
觀察上面的log，因為它是一個decorator，所以接受一個函數作為參數，並返回一個函數。我們要藉助Python的@語法，把decorator置於函數的定義處：
@log
def now():
print('2021-04-17')
調用now()函數，不僅會運行now()函數本身，還會在運行now()函數前列印一行日誌：
now()
# call now():
# 2021-04-17
把@log放到now()函數的定義處，相當於執行了語句：
now = log(now)
由於log()是一個decorator，返回一個函數，所以，原來的now()函數仍然存在，只是現在同名的now變數指向了新的函數，於是調用now()將執行新函數，即在log()函數中返回的wrapper()函數。
wrapper()函數的參數定義是(*args, **kw)，因此，wrapper()函數可以接受任意參數的調用。在wrapper()函數內，首先列印日誌，再緊接著調用原始函數。
如果decorator本身需要傳入參數，那就需要編寫一個返回decorator的高階函數，寫出來會更複雜。比如，要自定義log的文本：
def log(text):
def decorator(func):
def wrapper(*args, **kw):
print('%s %s():' % (text, func.__name__))
return func(*args, **kw)
return wrapper
return decorator
這個3層嵌套的decorator用法如下：
@log('execute')
def now():
print('2021-04-17')
執行結果如下：
now()
# execute now():
# 2021-04-17
和兩層嵌套的decorator相比，3層嵌套的效果是這樣的：
now = log('execute')(now)
我們來剖析上面的語句，首先執行log('execute')，返回的是decorator函數，再調用返回的函數，參數是now函數，返回值最終是wrapper函數。
以上兩種decorator的定義都沒有問題，但還差最後一步。因為函數也是對象，它有__name__等屬性，但你去看經過decorator裝飾之後的函數，它們的__name__已經從原來的'now'變成了'wrapper'：
print(now.__name__)
# wrapper
因為返回的那個wrapper()函數名字就是'wrapper'，所以，需要把原始函數的__name__等屬性複製到wrapper()函數中，否則，有些依賴函數簽名的程式碼執行就會出錯。
不需要編寫wrapper.__name__ = func.__name__這樣的程式碼，Python內置的functools.wraps就是干這個事的，所以，一個完整的decorator的寫法如下：
import functools
def log(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('call %s():' % func.__name__)
return func(*args, **kw)
return wrapper
或者針對帶參數的decorator：
import functools
def log(text):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kw):
print('%s %s():' % (text, func.__name__))
return func(*args, **kw)
return wrapper
return decorator
import functools是導入functools模組。模組的概念稍候講解。現在，只需記住在定義wrapper()的前面加上@functools.wraps(func)即可。
