草庐IT

python 装饰器

轻松学Python 2023-03-28 原文

一、我们在python语言中

 常用@classmethod、@staticmethod这个装饰器,装饰器的作用简单来讲就是我们在很多地方可能都会用到一下相同的功能,这时我们会有两种想法。

1. 将这部分相同的功能封装成函数,然后在使用这个功能的时候程序中调用这个函数。
2.  将这部分相同的功能封装成装饰器,然后在使用这个功能的时候在需要处理的方法前加上对应的装饰器。

 

这两种方式各有好处,我认为
1中的方式更适合新加功能,通过单独新加函数实现功能,然后在需要的位置使用。
2中的方式更适合固定且经常使用的功能,比如说日志记录,执行时间计算等,只需要在需要用到该功能的时候直接在该方法前加装饰器即可。

二、装饰器

下面我们先看个例子:

import time
# Python学习交流群 815624229
def origin_fun(a, b):
    start_time = time.time()
    s = a + b
    exec_time = time.time() - start_time
    print('执行时间: {}'.format(exec_time))
    return s

 

以上是原函数,我们要得到传入两个参数的加和操作的时间消耗,我们如果需要对很多操作进行时间记录,有两个方法

1、拆出函数实现

def func(a, b):
    return a+b

def get_begin_date():
    return time.time()

def final_func(a, b):
    start_time = get_begin_date()
    s = func(a, b)
    exec_time = get_begin_date() - start_time
    print('执行时间: {}'.format(exec_time))
    return s

 

可以发现我们这样是可以实现的, 但是这样再使用的时候还是有点繁琐,接下来我们用装饰器实现

2、装饰器实现

(1)我们先来介绍一下装饰器的一个结构:

简单理解就是将添加了装饰器的函数(func)传入装饰器函数(decorator)中,在装饰器函数中创建内置函数(wrapper),内置函数实现通用的功能并真正执行传入的函数(func)之后将返执行的函数结果在内置函数(wrapper)中返回,在装饰器函数(decorator)中将装饰器的内置函数(wrapper)作为返回对象返回

def decorator(func):
    def wrapper(*args, **kwargs):
        """
        define args and kwargs
        """
        # 通用的功能,这里我们认为输出传入的函数名称就是通用功能
        print(func.__name__)
        # 执行传入的方法
        return func(*args, **kwargs)
    # 返回当前方法的内置函数
    return wrapper

@decorator
def func(a, b):
    return a + b

 

这么一看的话大家应该就会觉得装饰器也很好理解了。

(2)下面我们就将上述的例子通过装饰器实现

a. 无参装饰器

def time_local(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        f = func(*args, **kwargs)
        exec_time = time.time() - start_time
        print('执行时间: {}'.format(exec_time))
        return f
    return wrapper
@time_local
def func1(a, b):
    return a+b
    
@time_local
def func2(a, b):
    return a*b

 

上述代码块就是我们的装饰器实现,可以发现我们在计算其他操作的消耗的时间的时候只需要在函数前添加装饰器就可以了,这样就代码的改动就会尽可能少的改动,这就是简单的装饰器的实现方式和应用方式。

b. 有参装饰器
高级一点的我们可能需要对装饰器进行传参,这样的装饰器就是在无参装饰器外再包一层函数,如下

def time_local_args(level):
    def time_local(func):
        def wrapper(*args, **kwargs):
            if level:
                start_time = time.time()
                f = func(*args, **kwargs)
                exec_time = time.time() - start_time
                print('执行时间: {}'.format(exec_time))
            else:
                f = func(*args, **kwargs)
            return f
        return wrapper
    return time_local

@time_local_args(level=True)
def func(a, b):
    return a+b

 

这样一看的话就很清晰了吧,装饰器就是一个函数内嵌套一个内置函数,在内置函数中实现通用功能以及执行被装饰的函数,嵌套函数的返回值为被装饰的函数,装饰器函数返回内置函数对象。

c. 再优雅一些的写法, 传参并封装成类且有参数的装饰器

class TimeLocal:
    def __init__(self, level):
        self._level = level

    def __call__(self, func, *args, **kwargs):
        def wrapper(*args, **kwargs):
            if self._level:
                start_time = time.time()
                f = func(*args, **kwargs)
                exec_time = time.time() - start_time
                print('执行时间: {}'.format(exec_time))
            else:
                f = func(*args, **kwargs)
            return f
        return wrapper
        
@TimeLocal(level=True)
def func4(a, b):
    return b / a

 

d.偏函数与类结合构建装饰器

事实上,Python 对某个对象是否能通过装饰器( @decorator)形式使用只有一个要求:decorator 必须是一个“可被调用(callable)的对象。

对于这个 callable 对象,我们最熟悉的就是函数了。

除函数之外,类也可以是 callable 对象,只要实现了call 函数(上面几个例子已经接触过了)。

还有容易被人忽略的偏函数其实也是 callable 对象。

接下来就来说说,如何使用 类和偏函数结合实现一个与众不同的装饰器。

如下所示,DelayFunc 是一个实现了 call 的类,delay 返回一个偏函数,在这里 delay 就可以做为一个装饰器。(以下代码摘自 Python工匠:使用装饰器的小技巧)

import time
import functools

class DelayFunc:
    def __init__(self,  duration, func):
        self.duration = duration
        self.func = func

    def __call__(self, *args, **kwargs):
        print(f'Wait for {self.duration} seconds...')
        time.sleep(self.duration)
        return self.func(*args, **kwargs)

    def eager_call(self, *args, **kwargs):
        print('Call without delay')
        return self.func(*args, **kwargs)

def delay(duration):
    """
    装饰器:推迟某个函数的执行。
    同时提供 .eager_call 方法立即执行
    """
    # 此处为了避免定义额外函数,
    # 直接使用 functools.partial 帮助构造 DelayFunc 实例
    return functools.partial(DelayFunc, duration)
   
@delay(duration=2)
def add(a, b):
    return a+b

 

以上就是我们装饰器的理解以及几张实现的方式,最后我们看一下用在类上的装饰器的代码

instances = {}

def singleton(cls):
    def get_instance(*args, **kw):
        cls_name = cls.__name__
        print('===== 1 ====')
        if not cls_name in instances:
            print('===== 2 ====')
            instance = cls(*args, **kw)
            instances[cls_name] = instance
        return instances[cls_name]
    return get_instance

@singleton
class User:
    _instance = None

    def __init__(self, name):
        print('===== 3 ====')
        self.name = name
print(User('sdma'))

>>> ===== 1 ====
>>> ===== 2 ====
>>> ===== 3 ====
>>> <__main__.User object at 0x000001EAC67AEC48>

 

有关python 装饰器的更多相关文章

  1. python - 如何使用 Ruby 或 Python 创建一系列高音调和低音调的蜂鸣声? - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我想在固定时间创建一系列低音和高音调的哔哔声。例如:在150毫秒时发出高音调的蜂鸣声在151毫秒时发出低音调的蜂鸣声200毫秒时发出低音调的蜂鸣声250毫秒的高音调蜂鸣声有没有办法在Ruby或Python中做到这一点?我真的不在乎输出编码是什么(.wav、.mp3、.ogg等等),但我确实想创建一个输出文件。

  2. Python 相当于 Perl/Ruby ||= - 2

    这个问题在这里已经有了答案:关闭10年前。PossibleDuplicate:Pythonconditionalassignmentoperator对于这样一个简单的问题表示歉意,但是谷歌搜索||=并不是很有帮助;)Python中是否有与Ruby和Perl中的||=语句等效的语句?例如:foo="hey"foo||="what"#assignfooifit'sundefined#fooisstill"hey"bar||="yeah"#baris"yeah"另外,类似这样的东西的通用术语是什么?条件分配是我的第一个猜测,但Wikipediapage跟我想的不太一样。

  3. java - 什么相当于 ruby​​ 的 rack 或 python 的 Java wsgi? - 2

    什么是ruby​​的rack或python的Java的wsgi?还有一个路由库。 最佳答案 来自Python标准PEP333:Bycontrast,althoughJavahasjustasmanywebapplicationframeworksavailable,Java's"servlet"APImakesitpossibleforapplicationswrittenwithanyJavawebapplicationframeworktoruninanywebserverthatsupportstheservletAPI.ht

  4. 华为OD机试用Python实现 -【明明的随机数】 2023Q1A - 2

    华为OD机试题本篇题目:明明的随机数题目输入描述输出描述:示例1输入输出说明代码编写思路最近更新的博客华为od2023|什么是华为od,od薪资待遇,od机试题清单华为OD机试真题大全,用Python解华为机试题|机试宝典【华为OD机试】全流程解析+经验分享,题型分享,防作弊指南华为o

  5. python - 如何读取 MIDI 文件、更改其乐器并将其写回? - 2

    我想解析一个已经存在的.mid文件,改变它的乐器,例如从“acousticgrandpiano”到“violin”,然后将它保存回去或作为另一个.mid文件。根据我在文档中看到的内容,该乐器通过program_change或patch_change指令进行了更改,但我找不到任何在已经存在的MIDI文件中执行此操作的库.他们似乎都只支持从头开始创建的MIDI文件。 最佳答案 MIDIpackage会为您完成此操作,但具体方法取决于midi文件的原始内容。一个MIDI文件由一个或多个音轨组成,每个音轨是十六个channel中任何一个上的

  6. 「Python|Selenium|场景案例」如何定位iframe中的元素? - 2

    本文主要介绍在使用Selenium进行自动化测试或者任务时,对于使用了iframe的页面,如何定位iframe中的元素文章目录场景描述解决方案具体代码场景描述当我们在使用Selenium进行自动化测试的时候,可能会遇到一些界面或者窗体是使用HTML的iframe标签进行承载的。对于iframe中的标签,如果直接查找是无法找到的,会抛出没有找到元素的异常。比如近在咫尺的例子就是,CSDN的登录窗体就是使用的iframe,大家可以尝试通过F12开发者模式查看到的tag_name,class_name,id或者xpath来定位中的页面元素,会抛出NoSuchElementException异常。解决

  7. python ffmpeg 使用 pyav 转换 一组图像 到 视频 - 2

    2022/8/4更新支持加入水印水印必须包含透明图像,并且水印图像大小要等于原图像的大小pythonconvert_image_to_video.py-f30-mwatermark.pngim_dirout.mkv2022/6/21更新让命令行参数更加易用新的命令行使用方法pythonconvert_image_to_video.py-f30im_dirout.mkvFFMPEG命令行转换一组JPG图像到视频时,是将这组图像视为MJPG流。我需要转换一组PNG图像到视频,FFMPEG就不认了。pyav内置了ffmpeg库,不需要系统带有ffmpeg工具因此我使用ffmpeg的python包装p

  8. Python 刷Leetcode题库,顺带学英语单词(31) - 2

    ValidPalindromeGivenastring,determineifitisapalindrome,consideringonlyalphanumericcharactersandignoringcases. [#125]Example:"Aman,aplan,acanal:Panama"isapalindrome."raceacar"isnotapalindrome.Haveyouconsiderthatthestringmightbeempty?Thisisagoodquestiontoaskduringaninterview.Forthepurposeofthisproblem

  9. python - 是否可以使用 Ruby 或 Python 禁用 anchor /引用来发出有效的 YAML? - 2

    是否可以在PyYAML或Ruby的Psych引擎中禁用创建anchor和引用(并有效地显式列出冗余数据)?也许我在网上搜索时遗漏了一些东西,但在Psych中似乎没有太多可用的选项,而且我也无法确定PyYAML是否允许这样做.基本原理是我必须序列化一些数据并将其以可读的形式传递给一个不是真正的技术同事进行手动验证。有些数据是多余的,但我需要以最明确的方式列出它们以提高可读性(anchor和引用是提高效率的好概念,但不是人类可读性)。Ruby和Python是我选择的工具,但如果有其他一些相当简单的方法来“展开”YAML文档,它可能就可以了。 最佳答案

  10. .net - .NET 将如何影响 Python 和 Ruby 应用程序? - 2

    我很好奇.NET将如何影响Python和Ruby应用程序。用IronPython/IronRuby编写的应用程序是否会非常特定于.NET环境,以至于它们实际上将变得特定于平台?如果他们不使用任何.NET功能,那么IronPython/IronRuby相对于非.NET同类产品的优势是什么? 最佳答案 我不能说任何关于IronRuby的东西,但是大多数Python实现(如IronPython、Jython和PyPy)都试图尽可能忠实于CPython实现。不过,IronPython正在迅速成为这方面的佼佼者之一,并且在PlanetPyth

随机推荐