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

Python装饰器的使用详解

2022-11-17 130
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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装饰器
忆想不到的晖
目录
相关文章
游客qf4jmczx4xu2y
|
3天前
|
设计模式 开发框架 缓存
探索Python中的装饰器：简化代码，增强功能
【9月更文挑战第16天】在Python的世界里，装饰器宛如一位巧手魔术师，轻轻一挥魔杖，便能让我们的函数和类焕发新生。本文将带你领略装饰器的魔力，从基础概念到实战应用，一步步解锁装饰器的强大潜能。让我们一起踏上这段奇妙的旅程，探索如何用装饰器简化代码，增强功能。
游客qf4jmczx4xu2y
31 19
mrq4nk6ni2neg
|
4天前
|
API Python
探索Python中的装饰器
【9月更文挑战第15天】本文将带你深入了解Python装饰器的概念、用法和实现，让你对这一强大而灵活的工具有更全面的认识。我们将从基础概念出发，逐步深入到高级应用，通过实例代码演示如何利用装饰器优化代码结构、增强函数功能以及管理API版本。
mrq4nk6ni2neg
31 15
肥猪肥猪-17824
|
4天前
|
Python
探索Python中的装饰器：从基础到进阶
【9月更文挑战第15天】本文旨在通过深入浅出的方式介绍Python中装饰器的概念、用法及其背后的原理。我们将从装饰器的简单定义开始，逐步深入到如何自定义装饰器，并探讨其在不同场景下的应用。文章不仅包含理论知识，还提供了实际代码示例，帮助读者更好地理解和掌握这一强大的工具。
肥猪肥猪-17824
31 15
萝卜带泥
|
3天前
|
缓存 开发者 Python
探索Python中的装饰器：从基础到高级应用
本文旨在深入探讨Python中一个强大且灵活的特性——装饰器（Decorator）。通过图文并茂的方式，我们将从装饰器的基本概念入手，逐步揭示其背后的工作原理，并通过一系列实用示例展示如何在实际编程中有效利用装饰器来增强代码的可读性、可维护性和功能性。最终，我们希望读者不仅能掌握装饰器的基础用法，还能激发创新思维，探索出更多高级应用场景。
萝卜带泥
17 9
君子世无双~
|
3天前
|
开发框架 缓存 数据库
探索Python中的装饰器：从入门到实践
【8月更文挑战第48天】本文将引导你进入Python装饰器的奇妙世界。不同于传统的“摘要”格式，我们将通过一段代码的演变，直观展示装饰器的魅力。文章不仅介绍基础概念，还将通过实例演示如何自定义装饰器，并探讨其在实际应用中的强大用途。让我们开始吧，一起深入理解这个改变函数行为的强大工具！
君子世无双~
19 8
muxiaoxi
|
2天前
|
缓存 开发者 Python
探索Python中的装饰器
本文将深入探讨Python中一个高级且强大的功能——装饰器。我们将从基本概念开始，逐步解析其工作原理及实际应用。通过具体示例，读者将能够理解如何使用装饰器来扩展函数功能，以及如何利用这一特性优化代码结构。无论是新手还是经验丰富的开发者，都能从中获取有价值的见解。
muxiaoxi
14 5
mrq4nk6ni2neg
|
1天前
|
Python
探索Python编程中的装饰器
【9月更文挑战第18天】本文将深入探讨Python中的一项强大功能——装饰器。通过简化的实例，我们会了解如何创建和使用装饰器来增强函数的功能，同时保持代码的整洁性和可读性。
mrq4nk6ni2neg
10 3
我不是游客20240119
|
3天前
|
测试技术 Python
Python中的装饰器：简化代码的魔法
【9月更文挑战第16天】在Python编程的世界里，装饰器就像是一把瑞士军刀，它们为函数和类赋予了额外的超能力。本文将带你探索装饰器的秘密，了解如何利用这一工具来简化代码、增强可读性并提升效率。从基础概念到实际案例，我们将一步步揭示装饰器的神秘面纱，让你的代码更加优雅和强大。
我不是游客20240119
14 5
xibeijing
|
2天前
|
设计模式 Python
探索Python中的装饰器：从基础到高级应用
本文深入探讨了Python中装饰器的使用，包括其基本定义、实际应用以及如何创建自定义装饰器。通过具体示例，我们将揭示装饰器在函数编程中的强大功能和灵活性，帮助读者更好地理解和运用这一技术。
xibeijing
14 3
aliyun1160684647-37161
|
2天前
|
缓存 数据安全/隐私保护 Python
探索Python中的装饰器
在本文中，我们将深入探讨Python装饰器的概念、应用及其背后的原理。通过具体的代码示例，您将学会如何使用装饰器来扩展函数功能，而无需永久性地修改它们。我们还将了解不同类型的装饰器，包括一元和二元装饰器，并学习如何创建和使用自定义装饰器。预计阅读时间：5分钟。
aliyun1160684647-37161
11 2

热门文章

最新文章

  • 1
    Python 第2章 基本数据类型课后习题参考答案
  • 2
    Python入门教程：内置函数—Map、Reduce、Filter
  • 3
    ?python __future__ package的几个特性
  • 4
    【Python】fastapi框架之Web部署机器学习模型
  • 5
    【机器学习算法-python实现】svm支持向量机(1)—理论知识介绍
  • 6
    CentOS 7-(64位)系统下安装Anaconda（Python3.x）及pip使用
  • 7
    python if语句
  • 8
    Python之pickle序列化
  • 9
    第24讲 python文件的写操作基础
  • 10
    Python查询Google PageRank
  • 1
    python制作七夕音乐贺卡
    83
  • 2
    Python自动化测试代理程序可用性
    42
  • 3
    使用Python pandas的sort_values()方法可按一个或多个列对DataFrame排序
    144
  • 4
    在Python的Pandas中，可以通过直接赋值或使用apply函数在DataFrame添加新列。
    219
  • 5
    Python小工具包
    86
  • 6
    python图片九宫格图片处理
    69
  • 7
    python实现Gif图片的字符画
    75
  • 8
    【🔥热闻速递】Google 裁撤 Python研发团队
    74
  • 9
    在Python中绘制移动平均线（MA）
    108
  • 10
    【Python机器学习专栏】Python机器学习工具与库的未来展望
    57

    • 相关课程

    更多
  • 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
  • raspberry-pi-os-images
    • 下一篇
    基于LNMP搭建WordPress