1. 程式人生 > >python 裝飾器簡單筆記(附 *args **kw)

python 裝飾器簡單筆記(附 *args **kw)

1. 裝飾器

由於函式也是一個物件,而且函式物件可以被賦值給變數,所以,通過變數也能呼叫該函式。
現在,假設我們要增強函式的功能,比如,在函式呼叫前後自動列印日誌,但又不希望修改函式的定義,這種在程式碼執行期間動態增加功能的方式,稱之為“裝飾器”(Decorator)。

本質上,decorator就是一個返回函式的高階函式。

# 這裡定義一個能列印日誌的decorator,所以接受一個函式作為引數,並返回一個函式
def log1(func):
    def wrapper(*args, **kw): # (*args, **kw),因此,wrapper()函式可以接受任意引數的呼叫
print('call %s():' % func.__name__) return func(*args, **kw) return wrapper # @log相當於執行:now = log(now) @log1 # 呼叫now()函式,不僅會執行now()函式本身,還會在執行now()函式前列印一行日誌 def now1(): print('2018-3-25') f = now1 f() # __name__已經從原來的'now'變成了'wrapper' print now1.__name__ print f.__name__ print
'--------------------------------------------------------' # 如果decorator本身需要傳入引數 def log2(text): def decorator(func): def wrapper(*args, **kw): print('%s %s():' % (text, func.__name__)) return func(*args, **kw) return wrapper return decorator # 相當於執行:now = log('execute')(now)
@log2('execute') def now2(): print('2018-3-25') f = now2 f() print now2.__name__ print f.__name__ print '--------------------------------------------------------' import functools def log3(text): def decorator(func): # 把原始函式的__name__等屬性複製到wrapper()函式中,Python內建的functools.wraps @functools.wraps(func) def wrapper(*args, **kw): print('%s %s():' % (text, func.__name__)) return func(*args, **kw) return wrapper return decorator @log3('execute') def now3(): print('2018-3-25') f = now3 f() print now3.__name__ print f.__name__

執行結果:

call now1():
2018-3-25
wrapper
wrapper
--------------------------------------------------------
execute now2():
2018-3-25
wrapper
wrapper
--------------------------------------------------------
execute now3():
2018-3-25
now3
now3

2. 函式的引數

這裡最好使用python 3 版本的直譯器。

2.1 可變引數

這裡只給出簡單的例子:

def calc(numbers):
    sum = 0
    for n in numbers:
        sum = sum + n * n
    return sum

# 呼叫的時候需要先組裝出一個list或tuple
print calc([1, 2, 3])
print calc((1, 3, 5, 7))

# 把函式的引數改為可變引數
def calc(*numbers):
    # 在函式內部,引數numbers接收到的是一個tuple
    #print 'numbers:',numbers 
    sum = 0
    for n in numbers:
        sum = sum + n * n
    return sum

# 呼叫函式的方式可以簡化成這樣
print calc(1, 2, 3)
print calc(1, 3, 5, 7)

# 如果已經有一個list或者tuple,一種麻煩的方式
nums = [1, 2, 3]
print calc(nums[0], nums[1], nums[2])
# 用可變引數的方式:list的所有元素作為可變引數傳進去
print calc(*nums)

執行結果:

14
84
numbers: (1, 2, 3)
14
numbers: (1, 3, 5, 7)
84
numbers: (1, 2, 3)
14
numbers: (1, 2, 3)
14

2.2 關鍵字引數

可變引數允許你傳入0個或任意個引數,這些可變引數在函式呼叫時自動組裝為一個tuple。而關鍵字引數允許你傳入0個或任意個含引數名的引數,這些關鍵字引數在函式內部自動組裝為一個dict。

同樣只給出程式:

# 注意kw獲得的dict是extra的一份拷貝,對kw的改動不會影響到函式外的extra
def person(name, age, **kw):
    print('name:', name, 'age:', age, 'other:', kw)

person('Michael', 30)
person('Bob', 35, city='Beijing')
person('Adam', 45, gender='M', job='Engineer')

# 和可變引數類似,也可以先組裝出一個dict,然後,把該dict轉換為關鍵字引數傳進去
extra = {'city': 'Beijing', 'job': 'Engineer'}
person('Jack', 24, city=extra['city'], job=extra['job'])

# 簡化的呼叫
extra = {'city': 'Beijing', 'job': 'Engineer'}
person('Jack', 24, **extra)

執行結果:

('name:', 'Michael', 'age:', 30, 'other:', {})
('name:', 'Bob', 'age:', 35, 'other:', {'city': 'Beijing'})
('name:', 'Adam', 'age:', 45, 'other:', {'gender': 'M', 'job': 'Engineer'})
('name:', 'Jack', 'age:', 24, 'other:', {'city': 'Beijing', 'job': 'Engineer'})
('name:', 'Jack', 'age:', 24, 'other:', {'city': 'Beijing', 'job': 'Engineer'})

2.3 命名關鍵字引數

對於關鍵字引數,函式的呼叫者可以傳入任意不受限制的關鍵字引數。至於到底傳入了哪些,就需要在函式內部通過引數檢查。

使用命名關鍵字引數時,要特別注意,如果沒有可變引數,就必須加一個*作為特殊分隔符。如果缺少*,Python直譯器將無法識別位置引數和命名關鍵字引數。

下面是基於python 3.5 版本

def person1(name, age, **kw):
    if 'city' in kw:
        # 有city引數
        pass
    if 'job' in kw:
        # 有job引數
        pass
    print('name:', name, 'age:', age, 'other:', kw)

person1('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)


# 如果要限制關鍵字引數的名字,就可以用命名關鍵字引數,例如,只接收city和job作為關鍵字引數
def person2(name,age,*,city,job): # *是分割符
    print(name,age,city,job)

person2('Jack', 24, city='Beijing', job='Engineer')

# 命名關鍵字引數可以有預設值,從而簡化呼叫
def person3(name, age, *, city='Beijing', job):
    print(name, age, city, job)

person3('Jack', 24, job='Engineer')

# 如果函式定義中已經有了一個可變引數,後面跟著的命名關鍵字引數就不再需要一個特殊分隔符*了
def person4(name, age, *args, city, job):
    print(name, age, args, city, job)

# 命名關鍵字引數必須傳入引數名,這和位置引數不同
person4('Jack', 24, city='Beijing', job='Engineer')

執行結果:

name: Jack age: 24 other: {'addr': 'Chaoyang', 'city': 'Beijing', 'zipcode': 123456}
Jack 24 Beijing Engineer
Jack 24 Beijing Engineer
Jack 24 () Beijing Engineer

這裡要注意:如果是python 2.7 版本的話,會出現報錯

 def person2(name,age,*,city,job): 
                          ^
SyntaxError: invalid syntax

但python 3 的版本卻沒問題,看來python的對某些語法的更新還是挺大的。

2.4 引數組合

在Python中定義函式,可以用必選引數、預設引數、可變引數、關鍵字引數和命名關鍵字引數,這5種引數都可以組合使用。但是請注意,引數定義的順序必須是:必選引數、預設引數、可變引數、命名關鍵字引數和關鍵字引數。

# 必選引數、預設引數、可變引數、關鍵字引數
def f1(a, b, c=0, *args, **kw):
    print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw)

# 必選引數、預設引數、可變引數、關鍵字引數和命名關鍵字引數
def f2(a, b, c=0, *, d, **kw):
    print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw)

f1(1, 2)
f1(1, 2, c=3)
f1(1, 2, 3, 'a', 'b')
f1(1, 2, 3, 'a', 'b', x=99)
f2(1, 2, d=99, ext=None)

args = (1, 2, 3, 4)
kw = {'d': 99, 'x': '#'}
f1(*args, **kw)
args = (1, 2, 3)
kw = {'d': 88, 'x': '#'}
f2(*args, **kw)

執行結果:

a = 1 b = 2 c = 0 args = () kw = {}
a = 1 b = 2 c = 3 args = () kw = {}
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}
a = 1 b = 2 c = 0 d = 99 kw = {'ext': None}
a = 1 b = 2 c = 3 args = (4,) kw = {'x': '#', 'd': 99}
a = 1 b = 2 c = 3 d = 88 kw = {'x': '#'}