Python装饰器使用方法全面梳理

2024-10-01 18:24:14

1 装饰器背景知识

1.1 基本概念

装饰器（Decorator）是 Python 中一种函数或类，用来修饰其他函数或类。装饰器可以改变被装饰函数的行为，或者在调用被装饰函数之前和之后增加额外的操作。装饰器的语法是使用 @ 语法符，在函数定义之前增加装饰器函数的名称。

@decorator_func
def my_func():
    pass

1.2 应用场景

代码重用：装饰器可以让我们在不更改原函数代码的情况下，为其添加额外的功能。
日志记录：装饰器可以记录函数的调用日志，帮助我们追踪程序的运行情况。
权限控制：装饰器可以用来实现函数级别的权限控制，只允许特定的用户访问特定的函数。
缓存：装饰器可以用来缓存函数的返回值，避免重复计算。
类型检查：装饰器可以用来在函数调用前检查参数的类型是否符合要求。
装饰器可以让你在函数或类的定义中添加额外的逻辑，而不更改它们的实现。

2 简单的装饰器代码

def decorator_func(func):
    def wrapper():
        print("Before calling the function")
        func()
        print("After calling the function")
    return wrapper
@decorator_func
def my_func():
    print("Inside the function")
my_func()
# Output: Before calling the function
#         Inside the function
#         After calling the function

上面展示了最简单的装饰器示例代码。在代码中，我们建立了一个名为decorator_func的装饰器和一个名为my_func函数。

装饰器外部的return必须为装饰器的内部函数，不含括号。通过代码结构可以看出，装饰器本身也是一个闭包。
在定义装饰器decorator_func时，括号中的’func’指代被装饰器装饰的函数，在这段代码中指代的就是my_func函数。
在被装饰器装时候，函数的实际执行执行顺序变成了内部函数wrapper所指定的顺序。即先执行print(“Before calling the function”)；再执行func()指代的my_func函数；最后执行print(“After calling the function”)。
本段代码的最终输出为：Before calling the function；Inside the function；After calling the function

3 使用装饰器记录函数执行次数

def cal_times(func):
    l=[]
    def wrapper(*var):
        l.append('1')
        func(*var)
        print("函数执行了%s次"%(len(l)))
    return wrapper
@cal_times
def my_func(i):
    print('%s的平方是%s'%(i,i**2))
my_func(5)
my_func(6)

在my_func(i)函数中，我们增加了形参的输入，因此，在装饰器中，也要为之做出更改。此处装饰器中的wrapper函数我们使用*var传参，这种设计方式的优点是可以让这个装饰器适用于任何函数。

再加入了cal_times装饰器后，函数每运行一次，都会使列表l添加一个1，这样可以计算函数的运行次数。这段代码的运行结果如下：

4 带参数的装饰器

装饰器与函数一样，也可以带入参数，我们在第二节的基础上，对代码做出如下修改：

def decorator_func(param1, param2):
    def decorator(func):
        def wrapper():
            print("Before calling the function with params:", param1,param2)
            func()
            print("After calling the function")
        return wrapper
    return decorator
@decorator_func("hello", "world")
def my_func():
    print("Inside the function")
my_func()

这段代码使用了装饰器来在my_func函数调用前后打印额外的信息，并且装饰器函数decorator_func接受两个参数，在调用wrapper函数时使用这两个参数。

最终，代码将输出：

Before calling the function with params: hello world； Inside the function；After calling the function。

如果同时还有字典类型的参数传入，可以使用（*var,**_var）进行解决

5 装饰器处理有返回值的函数

前面我们定义的函数都是执行某种功能，不涉及到return的相关操作。当涉及到处理有返回值的函数时，对于内部函数我们应该使用一个变量将函数的运行结果保存起来，并放在内层函数的return中。为了实现这一功能，我们将第三部分的代码做出如下修改：

def cal_times(func):
    l=[]
    def wrapper(*var):
        l.append('1')
        result = func(*var)
        print("函数执行了%s次"%(len(l)))
        return result
    return wrapper
@cal_times
def my_func(i):
    print('%s的平方是%s'%(i,i**2))
    return i**2
a = my_func(5)
b = my_func(6)
print(a,b)

对于这个装饰器，我们在内部函数wrapper使用result保存运行结果，并将result return，这样a与b就可以被正常的赋值，运行结果如下图。

而如果不执行保存result并return，a和b将不会得到任何值：

到此这篇关于Python装饰器使用方法全面梳理的文章就介绍到这了,更多相关Python装饰器内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

Python使用自定义装饰器的示例详解

在Python自动化测试中,使用自定义的装饰器来给测试方法传递测试数据: reader.py import csv import json from openpyxl import load_workbook from setting import DATA_DIR from os import path class Reader: @classmethod def read_excel(cls,xlname, min_row, max_row, min_col, max_col): xlnam
详解Python装饰器的四种定义形式

目录前言用函数装饰函数用函数装饰一个类用类定义装饰器,然后装饰一个函数用类定义装饰器,然后装饰一个类小结前言装饰器(decorator)在Python框架中扮演着重要角色,是Python中实现切面编程(AOP)的重要手段. aspect-oriented programming (AOP) ,在不改变代码自身的前提下增加程序功能不改变代码自身,但需要在函数和类头上加一个标注(annotation),这个标注在Python里叫装饰器,在java里叫注解.在Python里,一共有四
python装饰器底层原理详解

目录 1 python装饰器的作用 2 python装饰器的原理 3 python装饰器的实现 3.1 最简陋的装饰器 3.2 给有返回值的函数加上装饰器 3.3 给有返回值和参数的函数加上装饰器 3.4 让我还是那个我 4 python装饰器在自动化测试框架中的应用 4.1 从一个需求开始 1 python装饰器的作用被装饰对象加上装饰器(戴了个帽子),被装饰对象获得了更强大的功能. 2 python装饰器的原理 python装饰器本身是一个函数这个函数的参数是一个函数对象这个函数的返回
Python中的装饰器使用

目录 Python装饰器用法修改装饰器如下(其实就加了一行代码hhh) 总结 Python装饰器用法 Python的装饰器是个好东西,它能干很多事情. 但对于新手,它看起来似乎没那么简单. 但事实上,装饰器本身也只是个函数. import time def log(func): def wrapper(*args, **kwargs): start = time.time() result = func(*args, **kwargs)
Python装饰器使用方法全面梳理

目录 1 装饰器背景知识 1.1 基本概念 1.2 应用场景 2 简单的装饰器代码 3 使用装饰器记录函数执行次数 4 带参数的装饰器 5 装饰器处理有返回值的函数 1 装饰器背景知识 1.1 基本概念装饰器(Decorator)是 Python 中一种函数或类,用来修饰其他函数或类.装饰器可以改变被装饰函数的行为,或者在调用被装饰函数之前和之后增加额外的操作.装饰器的语法是使用 @ 语法符,在函数定义之前增加装饰器函数的名称. @decorator_func def my_func(): p
python装饰器使用方法实例

什么是python的装饰器? 网络上的定义:装饰器就是一函数,用来包装函数的函数,用来修饰原函数,将其重新赋值给原来的标识符,并永久的丧失原函数的引用. 最能说明装饰器的例子如下: 复制代码代码如下: #-*- coding: UTF-8 -*-import time def foo(): print 'in foo()' # 定义一个计时器,传入一个,并返回另一个附加了计时功能的方法def timeit(func): # 定义一个内嵌的包装函数,给传入的函数加上计时功能的包装 d
Python装饰器实现方法及应用场景详解

应用场景: 1.授权(Authorization) 装饰器能有助于检查某个人是否被授权去使用一个web应用的端点(endpoint).它们被大量使用于Flask和Django web框架中.这里是一个例子来使用基于装饰器的授权: from functools import wraps # 最新版python引用是 import functools def requires_auth(f): # f 就是我们需要装饰的函数,一看就是不带参数的装饰器 @wraps(f) # 新版python写法 @
Python实现对一个函数应用多个装饰器的方法示例

本文实例讲述了Python实现对一个函数应用多个装饰器的方法.分享给大家供大家参考,具体如下: 下面的例子展示了对一个函数应用多个装饰器,可以加多个断点,在debug模式下,查看程序的运行轨迹... #!/usr/bin/env python #coding:utf-8 def decorator1(func): def wrapper(): print 'hello python 之前' func() return wrapper def decorator2(func): def wrapp
基于Python 装饰器装饰类中的方法实例

title: Python 装饰器装饰类中的方法 comments: true date: 2017-04-17 20:44:31 tags: ['Python', 'Decorate'] category: ['Python'] --- 目前在中文网上能搜索到的绝大部分关于装饰器的教程,都在讲如何装饰一个普通的函数.本文介绍如何使用Python的装饰器装饰一个类的方法,同时在装饰器函数中调用类里面的其他方法.本文以捕获一个方法的异常为例来进行说明. 有一个类Test, 它的结构如下: clas
python装饰器-限制函数调用次数的方法(10s调用一次)

这是博主最近一家大公司的面试题,写一个装饰器,限制函数每10s调用一次.当时是笔试的,只写了大概的代码,回来后温习了python装饰器的基础知识,把代码写完了.决定写篇博客记录下. 装饰器分为带参数得装饰器以及不带参数得装饰器. #不带参数的装饰器 @dec1 @dec2 def func(): ... #这个函数声明等价于 func = dec1(dec2(func)) #带参数的装饰器 @dec(some_args) def func(): ... #这个函数声明等价于 func = dec
python装饰器常见使用方法分析

本文实例讲述了python装饰器常见使用方法.分享给大家供大家参考,具体如下: python 的装饰器,可以用来实现,类似spring AOP 类似的功能.一样可以用来记录某个方法执行前做什么,执行后做什么,或者用来记录日志,运行的时间等,更有甚者,用这个来做权限拦截,也未尝不可.从两个方面来描述python 的装饰模式: 1. 对普通方法的装饰 2. 对在 class 类中的方法的装饰,不需要给参数的情况 3. 对在 class 类中的方法的装饰,需要给参数的情况一,对普通方法的装饰.比如,
Python函数装饰器实现方法详解

本文实例讲述了Python函数装饰器实现方法.分享给大家供大家参考,具体如下: 编写函数装饰器这里主要介绍编写函数装饰器的相关内容. 跟踪调用如下代码定义并应用一个函数装饰器,来统计对装饰的函数的调用次数,并且针对每一次调用打印跟踪信息. class tracer: def __init__(self,func): self.calls = 0 self.func = func def __call__(self,*args): self.calls += 1 print('call %s
简单了解python装饰器原理及使用方法

这篇文章主要介绍了简单了解python装饰器原理及使用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下如果你接触 Python 有一段时间了的话,想必你对 @ 符号一定不陌生了,没错 @ 符号就是装饰器的语法糖. 装饰器的使用方法很固定: 先定义一个装饰函数(帽子)(也可以用类.偏函数实现) 再定义你的业务函数.或者类(人)最后把这顶帽子带在这个人头上 Python装饰器就是用于拓展原来函数功能的一种函数,目的是在不改变原函数名(或类名)的
python装饰器代替set get方法实例

对于变量的访问和设置,我们可以使用get.set方法,如下: class student: def __init__(self,name): self.__name = name def get_name(self): return self.__name def set_name(self,name): self.__name = name 我们也可以使用python 的装饰器,用@语法糖,使得我们要使用set get功能时只需要通过.xx的形式即可 class student1: def _