AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

Python装饰器的使用详解

2022-11-17 138
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： Python装饰器，大致可分为：无参装饰器、带参装饰器。接下来我们一探究竟

装饰器

Python装饰器，大致可分为：无参装饰器、带参装饰器。接下来我们一探究竟

<br/>

多个装饰器一起使用

"""
装饰器的具体使用
"""

print("# -------------------- 多个装饰器一起使用 -------------------- #")


# 加粗
def make_bold(fn):
    def wrapped():
        return "<b>" + fn() + "</b>"

    return wrapped


# 斜体
def make_italic(fn):
    def wrapped():
        return "<i>" + fn() + "</i>"

    return wrapped


@make_bold
def test1():
    return "hello world-1"


@make_italic
def test2():
    return "hello world-2"


# 两个装饰器一起使用
@make_bold
@make_italic
def test3():
    return "hello world-3"


print(test1())
print(test2())
print(test3())

<br/>

运行结果：

# -------------------- 多个装饰器一起使用 -------------------- #
<b>hello world-1</b>
<i>hello world-2</i>
<b><i>hello world-3</i></b>

<br/>

可以发现装饰 test3 的结果是先变斜体，然后在加粗。首先程序是从上到下执行的，当遇到 @make_bold 时它会把下面的函数引用传递给 make_bold 函数，但下面的又是一个装饰器 @make_italic ，这个装饰器一样会把下面的函数 test3 传递给 make_italic 函数，先将make_italic 函数的返回值 wrapped 赋值给 test3，然后这个新的 test3 函数再传递给 make_bold。因此是先变斜体，然后再加粗。

可能理解起来会很绕，看看下面这段程序结果你就更明白了，最好是亲自去尝试一下，加强理解。

"""
装饰器的具体使用
"""

print("# -------------------- 多个装饰器一起使用 -------------------- #")


# 加粗
def make_bold(fn):
    print("make_bold called")
    print(fn.__name__)

    def wrapped():
        return "<b>" + fn() + "</b>"

    return wrapped


# 斜体
def make_italic(fn):
    print("make_italic called")
    print(fn.__name__)

    def wrapped():
        return "<i>" + fn() + "</i>"

    return wrapped


# 两个装饰器一起使用
@make_bold
@make_italic
def test3():
    return "hello world-3"


print(test3())

<br/>

运行结果：

# -------------------- 多个装饰器一起使用 -------------------- #
make_italic called
function name: test3
    
make_bold called
function name: wrapped
<b><i>hello world-3</i></b>

先传递 test3 函数，经过 @make_italic 装饰器后 test3 = wrapped，在传递 test3 函数，而此时test3 其实就是 wrapped。因此第二次 fn.__name__，打印是 wrapped。

<br/>

各种装饰器示例

无参数的装饰器

print("# -------------------- 无参数装饰器 -------------------- #")
from time import ctime, sleep


# 打印当前运行时间
def cur_time(func):
    def wrapped_func():
        print("%s called at %s" % (func.__name__, ctime()))
        func()

    return wrapped_func


@cur_time
def foo():
    print("I am foo")


foo()
sleep(2)
foo()

<br/>

上面代码理解装饰器执行行为可理解成


# foo先作为参数赋值给func后,foo接收指向timefun返回的wrapped_func
foo = timefun(foo)

# 调用foo(),即等价调用wrapped_func()
foo()

# 内部函数wrapped_func被引用，所以外部函数的func变量(自由变量)并没有释放
# func里保存的是原foo函数对象

<br/>

运行结果：

# -------------------- 无参数装饰器 -------------------- #
foo called at Thu Apr 15 20:40:35 2021
I am foo
foo called at Thu Apr 15 20:40:37 2021
I am foo

<br/>

被装饰的函数有参数

print("# -------------------- 被装饰的函数有参数 -------------------- #")
from time import ctime, sleep


def cur_time(func):

    # 注意在这里接受函数参数
    def wrapped_func(a, b):
        print("%s called at %s" % (func.__name__, ctime()))
        print(a, b)
        func(a, b)

    return wrapped_func


@cur_time
def foo(a, b):
    print(a + b)


foo(3, 5)
sleep(2)
foo(2, 4)

<br/>

运行结果：

# -------------------- 被装饰的函数有参数 -------------------- #
foo called at Thu Apr 15 20:47:18 2021
3 5
8
foo called at Thu Apr 15 20:47:20 2021
2 4
6

<br/>

被装饰的函数有不定长参数

print("# -------------------- 被装饰的函数有不定长参数 -------------------- #")
from time import ctime, sleep


def cur_time(func):

    # 这里用*arg **kwargs来接受不定长参数
    def wrapped_func(*args, **kwargs):
        print("%s called at %s" % (func.__name__, ctime()))
        print("args:", args)
        print("kwargs:", kwargs)
        func(*args, **kwargs)

    return wrapped_func


@cur_time
def foo(a, b, c):
    print(a + b + c)


foo(1, 3, 5)
sleep(2)
foo(2, 4, c=6)

<br/>

运行结果：

# -------------------- 被装饰的函数有不定长参数 -------------------- #
foo called at Thu Apr 15 21:10:02 2021
args: (1, 3, 5)
kwargs: {}
9

foo called at Thu Apr 15 21:10:05 2021
args: (2, 4)
kwargs: {'c': 6}
12

以 foo(2, 4, c=6) 举例，2, 4 会以元组的形式传递给 args，c=6 这种键值对的则是以字典的形式传递给 kwargs ，需注意的是在函数参数定义的时候需在参数名前带上 *。参数名称可以自定义但 * 不能少，否则就不是不定参数函数。例如 *args 可以换成 *params ，*kwargs 可以换成 *kws。但我们最好不要改动。

<br/>

装饰器中的return

print("# -------------------- 装饰器的return -------------------- #")
from time import ctime, sleep


def cur_time(func):
    def wrapped_func():
        print("%s called at %s" % (func.__name__, ctime()))
        func()

    return wrapped_func


@cur_time
def foo():
    print("I am foo")


@cur_time
def get_info():
    return '----hei hei---'


foo()
sleep(2)
foo()

print(get_info())

<br/>

执行结果：

# -------------------- 装饰器的return -------------------- #
foo called at Thu Apr 15 21:27:52 2021
I am foo

foo called at Thu Apr 15 21:27:54 2021
I am foo

get_info called at Thu Apr 15 21:27:54 2021
None

<br/>

如果修改装饰器为如下

def cur_time(func):
    def wrapped_func():
        print("%s called at %s" % (func.__name__, ctime()))
        ret = func() # 先接收函数的返回值
        return ret   # 然后返回出去

    return wrapped_func

<br/>

则运行结果：

# -------------------- 装饰器的return -------------------- #
foo called at Thu Apr 15 21:32:43 2021
I am foo

foo called at Thu Apr 15 21:32:45 2021
I am foo

get_info called at Thu Apr 15 21:32:45 2021
----hei hei---

<br/>

说明：

一般情况下为了让装饰器更通用，可以有 return

<br/>

装饰器带参数

print("# -------------------- 装饰器带参数 -------------------- #")
from time import ctime, sleep


def time_arg(pre="hello"):

    def cur_time(func):
        def wrapped_func():
            print("%s called at %s %s" % (func.__name__, ctime(), pre))
            return func()

        return wrapped_func

    return cur_time


@time_arg("hui")
def foo():
    print("I am foo")


@time_arg("python")
def goo():
    print("I am goo")


foo()
sleep(2)
foo()

goo()
sleep(2)
goo()

<br/>

装饰过程如下

1. 先调用 time_arg("hui")

2. 将步骤1得到的返回值，即cur_time返回， 然后装饰器@time_arg('hui')就变成了@cur_time

3. 将 foo 传递给 cur_time

3. 将 cur_time(foo)的结果返回，即wrapped_func

4. 让foo = wrapped_fun，即foo现在指向wrapped_func

可以理解为

foo() == timef_arg("hui")(foo)()
goo() == timef_arg("python")(goo)()

<br/>

记住 xxx() 即 xxx 调用，而 @decorate 则执行 decorate 函数，只不过会把 @ 下面被装饰的函数当做参数传递给 decorate 函数执行。

<br/>

类装饰器（扩展）

装饰器函数其实是这样一个接口约束，它必须接受一个 callable 对象作为参数，然后返回一个 callable 对象。在Python中一般 callable 对象都是函数，但也有例外。只要某个对象重写了 __call__() 方法，那么这个对象就是 callable 的。

  • callable 就是可被调用执行的对象
class Test():
    def __call__(self):
        print('call me!')

t = Test()
t()  # 输出 call me

<br/>

类装饰器demo

class Test(object):
    
    def __init__(self, func):
        print("---初始化---")
        print("func name is %s" % func.__name__)
        self.__func = func
        
    def __call__(self):
        print("---装饰器中的功能---")
        self.__func()

@Test
def test():
    print("----test---")
test()

<br/>

说明：

1. 当用Test来装作装饰器对test函数进行装饰的时候，首先会创建Test的实例对象
    并且会把test这个函数名当做参数传递到__init__方法中
    即在__init__方法中的属性__func指向了test指向的函数

2. test指向了用Test创建出来的实例对象

3. 当在使用test()进行调用时，就相当于让这个对象()，因此会调用这个对象的__call__方法

4. 为了能够在__call__方法中调用原来test指向的函数体，
    所以在__init__方法中就需要一个实例属性来保存这个函数体的引用
    所以才有了self.__func = func这句代码，从而在调用__call__方法中能够调用到test之前的函数体

<br/>

运行结果如下：

---初始化---
func name is test
---装饰器中的功能---
----test---

<br/>

源代码

源代码已上传到 Gitee PythonKnowledge: Python知识宝库，欢迎大家来访。

✍ 码字不易，万水千山总是情，点赞再走行不行，还望各位大侠多多支持❤️

<br/>

公众号

新建文件夹X

大自然用数百亿年创造出我们现实世界，而程序员用几百年创造出一个完全不同的虚拟世界。我们用键盘敲出一砖一瓦，用大脑构建一切。人们把1000视为权威，我们反其道行之，捍卫1024的地位。我们不是键盘侠，我们只是平凡世界中不凡的缔造者 。
文章标签：
Python
程序员
关键词：
Python装饰器
忆想不到的晖
目录
相关文章
丰宝宝
|
11天前
|
Python
深入理解Python装饰器：从入门到实践####
本文旨在通过简明扼要的方式，为读者揭开Python装饰器的神秘面纱，从基本概念、工作原理到实际应用场景进行全面解析。不同于常规的摘要仅概述内容概要，本文将直接以一段精炼代码示例开篇，展示装饰器如何优雅地增强函数功能，激发读者探索兴趣，随后深入探讨其背后的机制与高级用法。 ####
丰宝宝
43 11
游客moiomvrp3vyac2
|
7天前
|
设计模式 缓存 开发者
深入浅出Python装饰器
【10月更文挑战第39天】本文将通过浅显易懂的语言和生动的比喻，带你探索Python中一个神奇而又强大的特性——装饰器。我们将一起揭开装饰器的神秘面纱，了解它的工作原理，并通过实际代码示例学习如何应用它来美化我们的代码。无论你是编程新手还是有经验的开发者，这篇文章都将为你打开一扇新的大门，让你的代码更加优雅和高效。
游客moiomvrp3vyac2
23 5
游客sjjs6jgz4gp7m1
|
7天前
|
缓存 测试技术 数据库
深入理解Python中的装饰器
在本文中，我们将探讨Python语言中一个强大而灵活的特性——装饰器。装饰器允许开发者在不修改原有函数或方法代码的情况下增加额外的功能，这大大提高了代码的复用性和可读性。通过具体示例和应用场景的讲解，本篇文章旨在为读者提供一个关于如何使用装饰器的全面指南，包括装饰器的定义、使用场景、以及如何自定义装饰器等内容。
游客sjjs6jgz4gp7m1
19 3
aliyun8599273441-30642
|
12天前
|
设计模式 Python
掌握Python中的装饰器
【10月更文挑战第34天】装饰器是Python中一种强大的工具，它允许我们在不修改原函数代码的情况下增加其功能。本文通过简单易懂的语言和实例，引导你理解装饰器的概念、种类及其应用，帮助你在编程实践中灵活使用这一高级特性。
aliyun8599273441-30642
26 0
游客sjjs6jgz4gp7m1
|
8天前
|
缓存 监控 测试技术
Python中的装饰器：功能扩展与代码复用的利器###
本文深入探讨了Python中装饰器的概念、实现机制及其在实际开发中的应用价值。通过生动的实例和详尽的解释，文章展示了装饰器如何增强函数功能、提升代码可读性和维护性，并鼓励读者在项目中灵活运用这一强大的语言特性。 ###
游客sjjs6jgz4gp7m1
28 5
肥猪肥猪-17824
|
11天前
|
缓存 开发者 Python
探索Python中的装饰器：简化代码，增强功能
【10月更文挑战第35天】装饰器在Python中是一种强大的工具，它允许开发者在不修改原有函数代码的情况下增加额外的功能。本文旨在通过简明的语言和实际的编码示例，带领读者理解装饰器的概念、用法及其在实际编程场景中的应用，从而提升代码的可读性和复用性。
肥猪肥猪-17824
32 8
萝卜带泥
|
7天前
|
设计模式 缓存 开发框架
Python中的装饰器：从入门到实践####
本文深入探讨了Python中装饰器的工作原理与应用，通过具体案例展示了如何利用装饰器增强函数功能、提高代码复用性和可读性。读者将学习到装饰器的基本概念、实现方法及其在实际项目开发中的实用技巧。 ####
萝卜带泥
20 3
shuj
|
7天前
|
Python
探索Python中的装饰器：简化代码，提升效率
【10月更文挑战第39天】在编程的世界中，我们总是在寻找使代码更简洁、更高效的方法。Python的装饰器提供了一种强大的工具，能够让我们做到这一点。本文将深入探讨装饰器的基本概念，展示如何通过它们来增强函数的功能，同时保持代码的整洁性。我们将从基础开始，逐步深入到装饰器的高级用法，让你了解如何利用这一特性来优化你的Python代码。准备好让你的代码变得更加优雅和强大了吗？让我们开始吧！
shuj
15 1
游客5fdji2pvmf8888
|
12天前
|
设计模式 缓存 监控
Python中的装饰器：代码的魔法增强剂
在Python编程中，装饰器是一种强大而灵活的工具，它允许程序员在不修改函数或方法源代码的情况下增加额外的功能。本文将探讨装饰器的定义、工作原理以及如何通过自定义和标准库中的装饰器来优化代码结构和提高开发效率。通过实例演示，我们将深入了解装饰器的应用，包括日志记录、性能测量、事务处理等常见场景。此外，我们还将讨论装饰器的高级用法，如带参数的装饰器和类装饰器，为读者提供全面的装饰器使用指南。
游客5fdji2pvmf8888
31 7
游客762btuqu5wybw666
|
8天前
|
存储 缓存 监控
掌握Python装饰器：提升代码复用性与可读性的利器
在本文中，我们将深入探讨Python装饰器的概念、工作原理以及如何有效地应用它们来增强代码的可读性和复用性。不同于传统的函数调用，装饰器提供了一种优雅的方式来修改或扩展函数的行为，而无需直接修改原始函数代码。通过实际示例和应用场景分析，本文旨在帮助读者理解装饰器的实用性，并鼓励在日常编程实践中灵活运用这一强大特性。
游客762btuqu5wybw666
15 1

热门文章

最新文章

  • 1
    手把手教你用Python实践深度学习
  • 2
    3、Python与设计模式--建造者模式
  • 3
    Python 阿里云盾滑块验证
  • 4
    python类的使用
  • 5
    python 合并当天tomcat异常日志
  • 6
    python第三节课堂练习：统计一句单词
  • 7
    [PYTHON] 核心编程笔记之二-Python起步
  • 8
    python 带参数的多重继承
  • 9
    CentOS下-Python-人脸识别-DLib的环境安装(一)
  • 10
    Python基础教程笔记——条件，循环和其他语句
  • 1
    使用Python实现深度学习模型：文本生成与自然语言处理
    120
  • 2
    python类型错误（TypeError）
    62
  • 3
    python属性错误（AttributeError）
    208
  • 4
    python变量未定义（NameError）
    105
  • 5
    Python进行自动化
    66
  • 6
    深度剖析：AJAX、Fetch API如何成为Python后端开发者的最佳拍档！
    92
  • 7
    从零到精通，AJAX与Fetch API让你的Python Web前后端交互无所不能！
    42
  • 8
    颠覆传统！AJAX、Fetch API与Python后端，开启Web开发新篇章！
    40
  • 9
    告别‘老司机’时代，AJAX与Fetch API让你的前端与Python后端无缝对接！
    61
  • 10
    Python数据分析加速器：深度挖掘Pandas与NumPy的高级功能
    48

    • 相关课程

    更多
  • Python Web开发基础
  • Python开发基础入门
  • Python常用数据科学库
  • Python网络爬虫实战
  • Python完全自学手册图文教程
  • Python基础快速入门实战教程

    • 相关电子书

    更多
  • From Python Scikit-Learn to Sc
  • Data Pre-Processing in Python:
  • 双剑合璧-Python和大数据计算平台的结合

    • 相关实验场景

    更多
  • Python新手入门
  • Python入门
  • Python选择及循环结构
  • Python新手入门（Anolis OS）
  • Python网络通信程序典型应用
  • 云端Python及基本操作

    • 推荐镜像

    更多
  • python-release
  • nodejs-release
  • golang
    • 下一篇
    阿里云OSS设置跨域访问