Python:关于装饰器的创建以及案例示范——一步一步来

简介: Python:关于装饰器的创建以及案例示范——一步一步来

前提知识:

掌握位置形参、关键字实参之可变长参数,名称空间以及作用域,函数的嵌套使用,最后是对前面的综合运用————闭包函数的掌握


1、基础知识:

装饰器的功能:简而言之,就是为了给函数(大多数是,当然也可以是类class)增加新功能(注意,不是修改函数原来就有的功能)

但是要求是:

1、不改变原来函数的代码。2、不改变原来函数的调用方式。

为何需要使用装饰器:开放封闭原则

1、开放:对函数的拓展功能(增加新功能)是开放的。

2、封闭:对修改源代码是封闭的。

使用装饰器的好处:

1、源代码不会改变,保证安全性和可维护性

2、调用方式不会改变,这样子避免了对函数调用的代码的大量修改


2、准备工作

譬如:如下为原始函数

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
hello('a', 18)  # 假使这里对函数调用了上万遍

需求是,计算该函数执行完需要多久?——————这是新功能


3、提示:这里为了能更好的理解装饰器,会给出几种不符合要求的方案然后一步一步优化修改


4、方案一:修改函数内部代码

按照常规想法,自然而然地会想到需要给函数增加计时地新功能,那当然是修改函数内部代码。

所以很容易可以修改成下方地代码:

import time
def hello(name, age):
    start = time.time()  # 记录代码开始时间
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
    stop = time.time()  # 记录代码结束时间
    print(stop - start)  # 相减即为代码运行时间
hello('a', 18)  # 假使这里对函数调用了上万遍

缺陷:虽然不需要修改函数的调用方式,但是修改了函数的源代码,不符合要求。


5、方案二:函数调用前后增加代码

很高兴你能想到这种方式,下面是修改的代码:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
start = time.time()
hello('a', 18)  # 假使这里对函数调用了上万遍
stop = time.time()
print(stop - start)

缺陷:虽然这种修改方式既没有修改函数的源代码,也没有修改函数的调用方式。但是,假使这是一个巨大的项目,由于对于原函数的调用不是一次两次,而是上万次,那么这样子修改势必会浪费巨大的时间和精力。


6、方案三:使用闭包函数实现装饰器对函数的修改

首先我们要肯定方案二的正确性(没有修改源代码,也没有修改函数的调用方式),然后在它的基础上做出修改。

原来的函数定义是这个样子的:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
hello('a', 18)  # 假使这里对函数调用了上万遍

那么 ,我们可以一个函数调用前后增加计时功能,如下:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
start = time.time()
hello('HZH', 18)
stop = time.time()
print(stop - start)

但是这样子还是不行,因为我们需要对每一个函数调用都得这么写,太累了!

所以应该修改成函数的形式,如下:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def new_hello():
    start = time.time()
    hello('HZH', 18)
    stop = time.time()
    print(stop - start)

但是这个样子还是不行,因为这个函数只能写hello(’HZH‘, 18),换言之,我们把hello函数写死了,所以需要将修改成变量name,age。所以new_hello函数需要传入两个参数进来。

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def new_hello(name, age):
    start = time.time()
    hello(name, age)
    stop = time.time()
    print(stop - start)

但是这个样子还是不行,如果我需要给原来的函数hello修改源代码,譬如增加参数,那么new_hello函数形参需要修改,里面的hello()传入的实参也要修改,所以修改如下:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def new_hello(*args, **kwargs):
    start = time.time()
    hello(*args, **kwargs)
    stop = time.time()
    print(stop - start)

但是这个样子还是不行,装饰器是可以为任何函数增加同样的功能,现在只能给hello函数增加计时功能,当然,函数的调用问题也还没有解决,先解决现在把hello函数写死了的问题:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
func = hello
def new_hello(*args, **kwargs):
    start = time.time()
    func(*args, **kwargs)
    stop = time.time()
    print(stop - start)

现在只要我想要调用具有新功能的函数hello,我只需要func = hello(这里不在new_hello里面增加参数func,是因为args和kwargs什么都可以接收,无法实现)————将hello函数的内存地址传给func函数,接着只要调用new_hello函数就可以实现计时功能(当然,现在还没有解决调用方式需要修改的问题)

但是,这样子写还不是最好的,因为我们还没有将它封装一下也就是把这整个def成函数。

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def outer(func):
    # func = hello 这里如这样子写,那么就只能传入hello的内存地址了,所以应该放在上面传参
    def new_hello(*args, **kwargs):
        start = time.time()
        hello(*args, **kwargs)
        stop = time.time()
        print(stop - start)
    # 同时原来new_hello在全局空间就能访问现在只能在局部空间访问,所以需要返回其内存地址到全局空间
    return new_hello

这样子只剩下一个问题没有解决——函数的调用,假使我们调用函数,那么调用的new_hello('HZH', 18)

而原函数的调用方式是hello('HZH', 18)

所以,看下方代码:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def outer(func):
    # func = hello 这里如这样子写,那么就只能传入hello的内存地址了,所以应该放在上面传参
    def new_hello(*args, **kwargs):
        start = time.time()
        func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
    # 同时原来new_hello在全局空间就能访问现在只能在局部空间访问,所以需要返回其内存地址到全局空间
    return new_hello
​# 假使我们下面这个样子
hello = outer(f1)
"""那么我们经历了如下过程,首先函数hello的内存地址传给了func(即func保存着原始函数f1的内存地址,当然func现在是在outer函数的局部空间里),接着执行def new_hello()(这里给函数new_hello赋了内存地址,即使还没有为其内部开辟内存空间),接着return new_hello的内存地址给了hello,那么原来的函数hello的内存地址被现在new_hello的内存地址覆盖了,而且由于现在的函数hello还引用着函数new_hello的内存地址,所以函数outer的空间不会被销毁"""
# 如果现在调用hello('HZH', 18),那么实际上hello早已不是原来的那个函数hello,现在的hello指
# 向new_hello的内存地址,执行hello('HZH', 18),实际就是可以理解为调用函数new_hello
# 而new_hello里面的func由于在其内部没有定义,所以按照内嵌函数的定义,func会往外层函数寻找
# 结果在函数outer里面找到了存储着原来函数hello内存地址的func


7、稍微完善一下

对于前面方案三的问题,大部分已经解决了,譬如,

1、函数的调用方式没有变化,

2、函数的源代码没有变化,

3、对函数增加新功能没有冗余代码——一个装饰器就解决了。


但是,前面还有几个小的问题还没有解决。

1、假使我们原函数有返回值(当然现在原函数hello没有返回值,那么return是None,但是以后有呢?或者其它函数有呢?),那么由于增加了新功能的new_hello函数并没有返回值,所以需要在其内部用变量接收存储着原函数hello内存地址的func函数调用后的返回值,如下:

import time
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
def outer(func):
    # func = hello 这里如这样子写,那么就只能传入hello的内存地址了,所以应该放在上面传参
    def new_hello(*args, **kwargs):
        start = time.time()
        res = func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
        return res
    # 同时原来new_hello在全局空间就能访问现在只能在局部空间访问,所以需要返回其内存地址到全局空间
    return new_hello
​# 假使我们下面这个样子
hello = outer(f1)
"""那么我们经历了如下过程,首先函数hello的内存地址传给了func(即func保存着原始函数f1的内存地址,当然func现在是在outer函数的局部空间里),接着执行def new_hello()(这里给函数new_hello赋了内存地址,即使还没有为其内部开辟内存空间),接着return new_hello的内存地址给了hello,那么原来的函数hello的内存地址被现在new_hello的内存地址覆盖了,而且由于现在的函数hello还引用着函数new_hello的内存地址,所以函数outer的空间不会被销毁"""
# 如果现在调用hello('HZH', 18),那么实际上hello早已不是原来的那个函数hello,现在的hello指
# 向new_hello的内存地址,执行hello('HZH', 18),实际就是可以理解为调用函数new_hello
# 而new_hello里面的func由于在其内部没有定义,所以按照内嵌函数的定义,func会往外层函数寻找
# 结果在函数outer里面找到了存储着原来函数hello内存地址的func

2、对于我们创建的装饰器,我们了解原理后知道,这个装饰器不仅可以为hello函数增加计时功能,也可以为其它函数增加同样的计时功能。那么需要增加功能需要使用装饰器,如下(假使有f1函数,f2函数,f3函数需要增加计时功能):

f1 = outer(f1)
f2 = outer(f2)
f3 = outer(f3)

但是呢,对于装饰器为其它函数增加功能(也就是执行上面这一步),我们的python有更好的写法(语法糖),可以将装饰器的定义写在原函数的上方,然后对于需要装饰的函数,只需要在其定义上方单独加一行,里面写@装饰器名,具体如下:

import time
def outer(func):
    # func = hello 这里如这样子写,那么就只能传入hello的内存地址了,所以应该放在上面传参
    def new_hello(*args, **kwargs):
        start = time.time()
        res = func(*args, **kwargs)
        stop = time.time()
        print(stop - start)
        return res
    # 同时原来new_hello在全局空间就能访问现在只能在局部空间访问,所以需要返回其内存地址到全局空间
    return new_hello
@outer
def hello(name, age):
    time.sleep(2)  # 代码暂停2秒
    print('Hello, I am {}, I was {} years old'.format(name, age))
​# 假使我们下面这个样子
# hello = outer(f1)  我们换一种方法来进行这一步操作
"""那么我们经历了如下过程,首先函数hello的内存地址传给了func(即func保存着原始函数f1的内存地址,当然func现在是在outer函数的局部空间里),接着执行def new_hello()(这里给函数new_hello赋了内存地址,即使还没有为其内部开辟内存空间),接着return new_hello的内存地址给了hello,那么原来的函数hello的内存地址被现在new_hello的内存地址覆盖了,而且由于现在的函数hello还引用着函数new_hello的内存地址,所以函数outer的空间不会被销毁"""
# 如果现在调用hello('HZH', 18),那么实际上hello早已不是原来的那个函数hello,现在的hello指
# 向new_hello的内存地址,执行hello('HZH', 18),实际就是可以理解为调用函数new_hello
# 而new_hello里面的func由于在其内部没有定义,所以按照内嵌函数的定义,func会往外层函数寻找
# 结果在函数outer里面找到了存储着原来函数hello内存地址的func
目录
相关文章
|
22天前
|
开发者 Python
探索Python中的装饰器:从基础到高级应用
本文将带你深入了解Python中的装饰器,这一强大而灵活的工具。我们将一起探讨装饰器的基本概念,它们如何工作,以及如何使用它们来增强函数和类的功能,同时不改变其核心逻辑。通过具体代码示例,我们将展示装饰器的创建和使用,并探索一些高级应用,比如装饰器堆栈和装饰带参数的装饰器。无论你是初学者还是有经验的开发者,这篇文章都将为你提供新的视角,帮助你更有效地使用装饰器来简化和优化你的代码。
|
23天前
|
测试技术 数据安全/隐私保护 开发者
探索Python中的装饰器:从基础到高级应用
装饰器在Python中是一个强大且令人兴奋的功能,它允许开发者在不修改原有函数代码的前提下增加额外的功能。本文将通过具体代码示例,带领读者从装饰器的基础概念入手,逐步深入到高级用法,如带参数的装饰器和装饰器嵌套等。无论你是初学者还是有经验的开发者,这篇文章都将为你提供有价值的见解和技巧。
|
23天前
|
开发框架 数据建模 中间件
Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器是那些静悄悄的幕后英雄。它们不张扬,却能默默地为函数或类增添强大的功能。本文将带你了解装饰器的魅力所在,从基础概念到实际应用,我们一步步揭开装饰器的神秘面纱。准备好了吗?让我们开始这段简洁而富有启发性的旅程吧!
31 6
|
11天前
|
缓存 数据安全/隐私保护 Python
python装饰器底层原理
Python装饰器是一个强大的工具,可以在不修改原始函数代码的情况下,动态地增加功能。理解装饰器的底层原理,包括函数是对象、闭包和高阶函数,可以帮助我们更好地使用和编写装饰器。无论是用于日志记录、权限验证还是缓存,装饰器都可以显著提高代码的可维护性和复用性。
24 5
|
22天前
|
测试技术 开发者 Python
探索Python中的装饰器:从入门到实践
装饰器,在Python中是一块强大的语法糖,它允许我们在不修改原函数代码的情况下增加额外的功能。本文将通过简单易懂的语言和实例,带你一步步了解装饰器的基本概念、使用方法以及如何自定义装饰器。我们还将探讨装饰器在实战中的应用,让你能够在实际编程中灵活运用这一技术。
37 7
|
21天前
|
Python
探索Python中的装饰器:简化代码,增强功能
在Python的世界里,装饰器就像是给函数穿上了一件神奇的外套,让它们拥有了超能力。本文将通过浅显易懂的语言和生动的比喻,带你了解装饰器的基本概念、使用方法以及它们如何让你的代码变得更加简洁高效。让我们一起揭开装饰器的神秘面纱,看看它是如何在不改变函数核心逻辑的情况下,为函数增添新功能的吧!
|
22天前
|
程序员 测试技术 数据安全/隐私保护
深入理解Python装饰器:提升代码重用与可读性
本文旨在为中高级Python开发者提供一份关于装饰器的深度解析。通过探讨装饰器的基本原理、类型以及在实际项目中的应用案例,帮助读者更好地理解并运用这一强大的语言特性。不同于常规摘要,本文将以一个实际的软件开发场景引入,逐步揭示装饰器如何优化代码结构,提高开发效率和代码质量。
45 6
|
21天前
|
存储 缓存 Python
Python中的装饰器深度解析与实践
在Python的世界里,装饰器如同一位神秘的魔法师,它拥有改变函数行为的能力。本文将揭开装饰器的神秘面纱,通过直观的代码示例,引导你理解其工作原理,并掌握如何在实际项目中灵活运用这一强大的工具。从基础到进阶,我们将一起探索装饰器的魅力所在。
|
22天前
|
测试技术 开发者 Python
深入理解Python装饰器:从基础到高级应用
本文旨在为读者提供一个全面的Python装饰器指南,从其基本概念讲起,逐步深入探讨其高级应用。我们将通过实例解析装饰器的工作原理,并展示如何利用它们来增强函数功能、控制程序流程以及实现代码的模块化。无论你是Python初学者还是经验丰富的开发者,本文都将为你提供宝贵的见解和实用的技巧,帮助你更好地掌握这一强大的语言特性。
33 4
|
23天前
|
开发者 Python
Python中的装饰器:从入门到实践
本文将深入探讨Python的装饰器,这一强大工具允许开发者在不修改现有函数代码的情况下增加额外的功能。我们将通过实例学习如何创建和应用装饰器,并探索它们背后的原理和高级用法。
36 5