Python装饰器神器@wraps(func)

遇到问题:

因为本人之前是用的unittest框架写的自动化脚本,已经预先写好了log日志模块的装饰器。后需将unittest替换成pytest,用到了pytest中功能强大的fixture,但是读取coftest.py中的fixture后,pytest的测试用例中填写fixture的方法名,执行,却发现自己写log装饰器报missing 1 required positional argument

  • 同时使用fixture和装饰器代码:


    image.png
  • 报错:


    image.png

解决问题途径:

发现同样的情况下,加上@allure.step("")装饰器却不会报该错,查看allure的源码

解决问题:

allure源码中,发现装饰器中加了一个@wraps(func),解决上述问题

以下介绍wraps相关:

Python中被装饰后的函数,函数名等函数属性会发生改变(相当于另一个函数了),所以,Python的functools包中提供了一个叫wraps的装饰器来解决该问题。它能使其保留原有函数的结构。

  • 不加@wraps()的装饰器:
import time


class MyLog(object):

    def __call__(self, func):
        def my_log(*args, **kwargs):
            """这里是my_log的docstring"""
            start = time.time()
            res = func(*args, **kwargs)
            end = time.time()
            print('|运行时长:{:.4f}'.format(end - start))
            return res
        return my_log


@MyLog()
def is_test():
    """这里是is_test的docstring"""
    print("一个测试方法")


print("__name__: ", is_test.__name__)
print("__doc__:  ", is_test.__doc__)

运行结果:


image.png

看运行结果,会发现,被装饰器装饰后的函数,name和docstring都发生了变化

  • 加了@wraps()的装饰器:
import time
from functools import wraps


class MyLog(object):

    def __call__(self, func):
        @wraps(func)
        def my_log(*args, **kwargs):
            """这里是my_log的docstring"""
            start = time.time()
            res = func(*args, **kwargs)
            end = time.time()
            print('|运行时长:{:.4f}'.format(end - start))
            return res
        return my_log


@MyLog()
def is_test():
    """这里是is_test的docstring"""
    print("一个测试方法")


print("__name__: ", is_test.__name__)
print("__doc__:  ", is_test.__doc__)

运行结果:


image.png

看运行结果,会发现,装饰器加了@wraps后,被装饰器装饰后的函数,还是保持原有的状态

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

推荐阅读更多精彩内容