Python 装饰器原理和用法

装饰器可以在不修改原有代码的情况下,为函数增加新功能或者限制条件。装饰器是基于闭包环境存在的。

闭包(Closure)指的是一个函数及其执行环境(变量)的组合。闭包需要满足:

  • 内嵌函数
  • 内嵌函数中有外部嵌套函数的变量
  • 外部嵌套函数的返回值是内嵌函数名

装饰器函数可以使用装饰器语法糖 @,也可以采用原始方式进行调用。

被装饰函数的参数取决于装饰器函数的参数。
装饰器函数应该接收一个函数作为参数,并返回一个新的函数,新函数会替换原来的函数,从而实现对原有代码功能的动态修改。

一些装饰器用法的展示:

1. 日志打印

################ 闭包环境 ##############
def logger(func):
    def wrapper(*args, **kwargs):
        print(f"准备开始执行:{func.__name__} 函数:")
        result = func(*args, **kwargs)
        print("执行结束。")
        return result
    return wrapper
#######################################

@logger
def add(x, y):
    print(f"{x} + {y} = {x + y}")

add(200, 50)  

# 输出:
# 准备开始执行:add 函数:
# 200 + 50 = 250
# 执行结束。

2. 函数计时

import time
def timer(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        cost_time = end_time - start_time
        print(f"花费时间:{cost_time:.4f}秒")
        return result
    return wrapper

@timer
def sleep(seconds):
    time.sleep(seconds)

sleep(10)  

# 输出:
#  花费时间:10.0127秒

3. 带参数的函数装饰器

def say_hello(country):  # 嵌套了两层
    def decorator(func):
        def wrapper(*args, **kwargs):
            if country == "china":
                print("你好!")
            elif country == "america":
                print("hello.")
            else:
                return
            return func(*args, **kwargs)
        return wrapper
    return decorator

@say_hello("china")
def xiaoming():
    pass

@say_hello("america")
def jack():
    pass

xiaoming()  # 输出:你好!
jack()  # 输出:hello.

4. 不带参数的类装饰器

class Logger:
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print(f"[INFO]: 函数 {self.func.__name__}() 正在运行...")
        return self.func(*args, **kwargs)

@Logger
def say(something):
    print(f"say {something}!")

say("hello")  


# 输出:
# [INFO]: 函数 say() 正在运行... 
#  say hello!

5. 多个装饰器对同一个函数进行装饰

def set_function1(fun):
    print('---开始进行装饰1---')
    def call_function1(*args, **kwargs):
        print('---权限1验证---')
        print(args, kwargs)
        result = 100 + fun(*args, **kwargs)
        print(f"装饰1 返回值:{result}")
        return result
    return call_function1
def set_function2(fun):
    print('---开始进行装饰2---')
    def call_function2(*args, **kwargs):
        print('---权限2验证---')
        print(args, kwargs)
        result = 200 + fun(*args, **kwargs)
        print(f"装饰2 返回值:{result}")
        return result
    return call_function2
@set_function1
@set_function2
def test1(num, *args, **kwargs):
    print('---test1---')
    print(num, args, kwargs)
    return num
ret = test1(100)
print(ret)

# 输出结果:
# ---开始进行装饰2---
# ---开始进行装饰1---
# ---权限1验证---
# (100,) {}
# ---权限2验证---
# (100,) {}
# ---test1---
# 100 () {}
# 装饰2 返回值:300
# 装饰1 返回值:400
# 400

这里可以看出在执行到 @set_function1的时候就开始装饰了,而不是test1()运行的时候。
test1 函数会被 set_function2 装饰器装饰,然后再被 set_function1 装饰器装饰。所以先输出“开始进行装饰2”,再输出“开始进行装饰1”。

test1 函数的执行顺序是:set_function1 -> set_function2 -> test1
计算过程是 call_function1 接受到被 2 装饰的 test1,于是执行 call_function2,因此两个函数打印出来的参数相同。最后是调用被装饰的test1,打印输入值 100,返回输出值 100。装饰 2 执行了 +200 的操作,返回 300。接着装饰 1 执行 +100 的操作,返回 400。

最终返回值 400。

参考:

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351