Python-装饰器

一、前言

python装饰器本质上就是一个函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外的功能,装饰器的返回值也是一个函数对象。
Python中一切皆可对象

二、函数带和不带()的区别

def test():
    print('test ist running')
test()
print(test)
test_two = test
test_two()
#输出
test ist running
<function test at 0x0000021ED072C268>
test ist running

如代码所示,test()和test输出是不同的,这是因为当你把一对小括号放在后面,这个函数就会执行;然而如果你不放括号在它后面,它是一个对象,那它可以被到处传递,并且可以赋值给别的变量而不去执行它

三、简单的装饰器

def use_logging(func):
    def wrapper():
        """wrapper()"""
        print('%s start running' % func.__name__)
        f = func()
        print('%s stop running' % func.__name__)
        return f
    return wrapper
@use_logging
def foo():
    """foo()"""
    print("i am foo")
foo()
#output
foo start running
i am foo
foo stop running

or(代码稍微不同,可以控制执行顺序吧)
2024-05-22改
上面的f = func()会执行函数,所以顺序变了

def use_logging(func):
    def wrapper():
        """wrapper()"""
        print('%s start running' % func.__name__)
        #f = func()
        print('%s stop running' % func.__name__)
        return func()
    return wrapper
@use_logging
def foo():
    """foo()"""
    print("i am foo")
foo()
#output
foo start running
foo stop running
i am foo

use_logging 就是一个装饰器,它是一个普通的函数,它把执行真正业务逻辑的函数 func 包裹在其中,看起来像 foo 被 use_logging 装饰了一样,use_logging 返回的也是一个函数,这个函数的名字叫 wrapper。

如果业务函数带有参数,且不确定有几个参数,这是就需要用*args**kwargs两兄弟了。

def use_logging(func):
    def wrapper(*args, **kwargs):
        """wrapper()"""
        print('%s start running' % func.__name__)
        #f = func(*args, **kwargs)
        print('%s stop running' % func.__name__)
        return func(*args, **kwargs)
    return wrapper

六、warps

__name__用于获取函数的名称,__doc__用于获取函数的docstring内容(函数的注释)

在上面章节的示例代码加入如下代码
print(foo.__name__)
print(foo.__doc__)
#output
wrapper
wrapper()

可以发现foo函数的名称和注释都被装饰器的wrapper函数覆盖了。
Python提供了一个简单函数解决了这个问题。

from functools import wraps
def use_logging(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        """wrapper()"""
        print('%s start running' % func.__name__)
        #f = func(*args, **kwargs)
        print('%s stop running' % func.__name__)
        return func(*args, **kwargs)
    return wrapper
@use_logging
def foo():
    """foo()"""
    print("i am foo")
print(foo.__name__)
print(foo.__doc__)
#output
foo
foo()

@wraps接受一个函数来进行装饰,并加入了复制函数名称、注释文档、参数列表等等的功能。这可以让我们在装饰器里面访问在装饰之前的函数的属性。

五、装饰器带参数

import logging
from functools import wraps
def use_logging(level=‘warn’):
    @wraps(func)
    def decorator(func):
        def wrapper(*args, **kwargs):
            if level == "warn":
                logging.warning("%s is running" % func.__name__)
            elif level == "info":
                logging.info("%s is running" % func.__name__)
            return func(*args)
        return wrapper

    return decorator

@use_logging(level="warn")
def foo(name='foo'):
    print("i am %s" % name)
foo()

上面的 use_logging是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装,并返回一个装饰器。我们可以将它理解为一个含有参数的闭包。当我 们使用@use_logging(level="warn")调用的时候,Python 能够发现这一层的封装,并把参数传递到装饰器的环境中。
@use_logging(level="warn") 等价于 @decorator

六、类装饰器

关于call方法,不得不先提到一个概念,就是可调用对象(callable),我们平时自定义的函数、内置函数和类都属于可调用对象,
但凡是可以把一对括号()应用到某个对象身上都可称之为可调用对象,判断对象是否为可调用对象可以用函数 callable。
如果在类中实现了call方法,那么实例对象也将成为一个可调用对象

import time
class runtime(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        start = time.time()
        f = self.func(*args, **kwargs)     # 原函数
        end = time.time()
        print("运行时长:%.4f 秒" % (end-start))
        return f

@runtime
def func_a(a):
    print("hello"+a)
    time.sleep(0.5)

@runtime
def func_b(b, c="xx"):
    print("world"+b+c)
    time.sleep(0.8)

if __name__ == '__main__':
    func_a("a")
    func_b("b", c="xxx")

类装饰器带参数

import time


class runtime(object):
    def __init__(self, slowly=1):
        self.slowly = slowly

    def __call__(self, func):
        def wrapper(*args, **kwargs):
            start = time.time()
            f = func(*args, **kwargs)     # 原函数
            end = time.time()
            t = end-start
            time.sleep((self.slowly-1)*t)  # 延迟效果
            new_end = time.time()
            print("运行时长:%.4f 秒" % (new_end-start))
            return f
        return wrapper


@runtime(1.5)
def func_a(a):
    print("hello"+a)
    time.sleep(0.5)


@runtime(1.5)
def func_b(b, c="xx"):
    print("world"+b+c)
    time.sleep(0.8)

if __name__ == '__main__':
    func_a("a")
    func_b("b", c="xxx")

参考:
菜鸟教程
上海-悠悠

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

推荐阅读更多精彩内容

  • 每个人都有的内裤主要功能是用来遮羞,但是到了冬天它没法为我们防风御寒,咋办?我们想到的一个办法就是把内裤改造一下,...
    chen_000阅读 1,359评论 0 3
  • 如果看完这一篇文章还不理解装饰器,这说明我写的还不够清晰、详细,那请鼓励鼓励我吧。 讲 Python 装饰器前,我...
    龙皓晨阅读 673评论 0 8
  • 谈装饰器前,还要先要明白一件事,Python 中的函数和 Java、C++不太一样,Python 中的函数可以像普...
    明日孤风寒阅读 292评论 0 0
  • 谈到装饰器,要先要明白一件事,Python 中的函数和 Java、C++不太一样,Python 中的函数可以像普通...
    Guang777阅读 414评论 0 2
  • 其实人和人,到最后的区别,就是这一个一个坎儿,你能不能熬过去,过去了你就不一样了。一生中总会遇到这样的时候,你的内...
    强强_62f8阅读 121评论 0 1