百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

python 三大神器之一——装饰器(Decorator)

off999 2024-12-03 00:13 15 浏览 0 评论

引子

你现在有一个任务,需要统计开发人员编写的代码的性能(比如每个函数执行时间),你会怎么做呢?

  1. 在每个函数头和函数尾部添加时间,并进行减法运算
    import time
    def func1():
        start = time.time()
        print('in func1')
        print(time.time() - start)

    func1()
  1. 在原本的代码上添加计算时间的语句
    import time
    def func1():
        print('in func1')

    start = time.time()
    func1()
    print(time.time() - start)
  1. 提供一个带有变量的函数,直接调用该函数来进行统计
    import time
    def timer(func):
        start = time.time()
        func()
        print(time.time() - start)

    def func1():
        print('in func1')

    def func2():
        print('in func2')

    timer(func1)
    timer(func2)
  1. 有没有一种方式我直接调用func1 的时候,能够实现调用timer 方法的效果, 你应该会想到闭包函数
    import time
    def timer(func):
        def inner():
            start = time.time()
            func()
            print(time.time() - start)
        return inner

    def func1():
        print('in func1')

    func1 = timer(func1)
    func1()

在这里,装饰器的雏形就出来了,但我们每次调用的时候还要做一次赋值,这个有没有要的方式解决呢,pyhton 为我们提供了一句语法糖来解决这个问题

import time
    def timer(func):
        def inner():
            start = time.time()
            func()
            print(time.time() - start)
        return inner
    @timer  # 相当于func1 = timer(func1)
    def func1():
        print('in func1')
    func1()

到此,完整的装饰器就完成了。
总结:

  1. 装饰器的本质,就是一个闭包函数
  2. 装饰器是一种设计模式
  3. 装饰器的功能:在不修改原函数及其调用方式的情况下,对原函数功能进行扩展
    有了上面这些信息,我们来定义下什么是装饰器

2 装饰器定义

  • 定义:在用于不改变原有函数代码的情况下,增加函数的功能。本质上是一个返回另一个函数的函数,他接收被装饰的函数作为参数,并返回一个新的函数,这个新的函数会在原有的函数基础上添加一些额外的功能

3 装饰器的基本语法

  • 语法:装饰器使用@ 符号来应用,定位于函数定义之前。
def decorator(func):
    def inner(*args,**kwargs):
        result = func(*args,**kwargs)
        return result
    return inner

@decorator
def func1():
    pass
func1()

4 带参数的装饰器

有时,我们希望装饰器能够接受参数。为了实现这一点,我们可以定义一个外部函数来创建装饰器。这个外部函数接收装饰器的参数,并返回实际的装饰器函数。

def my_decorator_with_args(decorator_arg):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print(f"Decorator argument: {decorator_arg}")
            result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator

@my_decorator_with_args("Hello from decorator!")
def say_hello():
    print("Hello!")

say_hello()

5 装饰器的陷阱

  1. 保持函数签名:装饰器应该尽可能保持原有函数的签名不变,这意味着如果原函数接受n个参数,装饰器返回的函数也应当接受n个参数。
  2. 考虑异常处理:装饰器内部的代码可能会抛出异常,这会阻止原有函数的执行。因此,装饰器应当妥善处理可能出现的异常。
  3. 避免全局变量:在装饰器中使用全局变量可能会导致不可预见的问题,尤其是在多线程环境中。
  4. 使用`functools.wraps`:functools.wraps是一个实用的装饰器,用于解决闭包内函数属性丢失的问题。它将被装饰函数的name__`、`_doc_`、`__module等属性复制到装饰器返回的新函数上。
from functools import wraps

def my_decorator(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        # ... 装饰器的逻辑 ...
        return func(*args, **kwargs)
    return wrapper

6 装饰器的应用场景

  1. 日志记录:在函数调用前后添加日志记录。
  2. 性能测试:测量函数执行时间。
  3. 事务处理:在数据库操作函数前后添加事务开启和提交。
  4. 权限检查:在执行某些操作前进行权限验证。
  5. 缓存:缓存函数的结果以提高性能。

7 装饰器实例

使用装饰器实现一个简单的缓存机制通常涉及到将函数的结果存储起来,以便在下一次相同的输入参数被传递给函数时,可以直接返回之前计算的结果,而不是重新执行函数。这种技术被称为“记忆化”(memoization)。

下面是一个简单的装饰器实现缓存机制的例子:

import functools

def memoize(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        # 创建一个缓存字典,如果已经计算过结果,就直接返回
        cache_key = (args, tuple(kwargs.items()))
        if cache_key not in wrapper.cache:
            wrapper.cache[cache_key] = func(*args, **kwargs)
        return wrapper.cache[cache_key]
    wrapper.cache = {}
    return wrapper

@memoize
def fibonacci(n):
    if n in (0, 1):
        return n
    return fibonacci(n-1) + fibonacci(n-2)

print(fibonacci(10))  # 第一次计算,结果为55
print(fibonacci(10))  # 第二次调用,直接从缓存中获取结果

在这个例子中,memoize装饰器会检查wrapper.cache字典,看看是否已经计算了给定参数的结果。如果已经计算过,它会直接从缓存中返回结果;如果没有计算过,它会调用原始函数,将结果存储到缓存中,并返回结果。

这个简单的缓存机制有几个关键点:

  1. 参数的哈希化:为了将参数存储在字典中,我们需要将参数转换为一个可哈希的键。在这个例子中,我们使用了参数的元组表示形式,包括位置参数和关键字参数的键值对。
  2. functools.wraps:这个装饰器用于保持原始函数的元数据(如函数名、文档字符串等)不变。这是一个好习惯,因为它使得使用装饰器的函数更容易理解和调试。
  3. 缓存字典:wrapper.cache是一个字典,用于存储已经计算过的结果。字典的键是参数的哈希值,值是函数的计算结果。

相关推荐

Modbus RTU 指令基本功能介绍(modbus-rtu)

ModbusRTU协议概述:入门级知识点ModbusRTU协议,是工业自动化领域应用广泛的串行通信协议。它简单、可靠,在各种工业设备之间建立通信桥梁,实现数据的采集和控制。ModbusRTU...

AIOT开发选型:行空板 K10 与 M10 适用场景与选型深度解析

前言随着人工智能和物联网技术的飞速发展,越来越多的开发者、学生和爱好者投身于创意项目的构建。在众多的开发板中,行空板K10和M10以其独特的优势脱颖而出。本文旨在为读者提供一份详尽的行空板K...

程序员花了1个月时间,手搓低成本机械臂:跟着他你也能复刻一台

在开源硬件的广阔天地中,SO-ARM100作为一款备受瞩目的开源机械臂项目脱颖而出。它以标准化的四轴机械臂设计为核心,构建起一个开放共享的技术平台,为机械臂爱好者与开发者提供了绝佳的远程操作实践场域...

RPC接口测试技术-Tcp 协议的接口测试

首先明确Tcp的概念,针对Tcp协议进行接口测试,是指基于Tcp协议的上层协议比如Http,串口,网口,Socket等。这些协议与Http测试方法类似(具体查看接口自动化测试章...

同事开玩笑说:你这个python程序要是外流出去了,可能会有危险

引言公司因为业务原因,购入了一些高灵敏高精度的振动传感器。老板说:“拿去进行测试,看看数据如何?”吭哧吭哧接入数据,一看,确实精度和灵敏度非常高。具体多高呢?将传感器固定在相关的结构物上,在办公室中人...

STM32搭建简易环境监测站并通过网络实时上报

一、系统总体架构本系统以STM32F407为核心,搭建一个环境监测节点,能够采集温湿度、光照、空气质量等数据,并通过OLED屏显示,同时通过ESP8266模块实现局域网数据上报。适合室内空气监测、智慧...

STM32通过NB-IoT模块实现远程告警推送

一、项目概述本系统以STM32F103C8T6作为主控核心,通过串口控制NB-IoT通信模块(移远BC26),实现对外设状态的远程监测和异常自动告警推送(如温度超限、设备震动异常等)。支持通过UDP或...

MicroPython 玩转硬件系列3:上电执行程序

1.引言上一篇:MicroPython玩转硬件系列2:点灯实验我们在ESP32上实现了LED灯的闪烁,但是有一个问题,该功能的实现需要我们在串口终端里去手动执行代码,可不可以让ESP32上电后自动...

打标机与上位机通讯异常如何快速定位?串口工具验证流程拆解

打标机与上位机通信过程中出现的错误问题需要通过串口通信助手验证,主要原因在于串口通信的底层特性以及问题隔离的工程需求。以下是原理说明和验证方法:一、验证原理底层数据透明化串口通信本质上是基于二进制数据...

4G短信猫发送中文短信(Python)(4g短信)

4G短信猫发送中文短信(Python)4G短信猫发送中文短信的方式可以使用TEXT模式或者PDU模式。1.TEXT模式在TEXT模式下发送中文短信的指令序列:AT+CSCS="UCS2...

ESP32如何刷microPython固件(esp32 固件升级)

目录为什么要刷microPython固件固件和工具的获取刷固件的步骤检验是否成功1.为什么要刷固件microPython是由计算机工程师DamienGeorge设计出来的,他的初衷是——用Pyth...

CH9329双头线使用说明(双头线是干什么用的)

目录1.介绍说明2.测试说明3.修改为ASCII模式(CH9328字符模式)常见问题解答:1.介绍说明CH9329双头线是集成了CH9329+CH340芯片的成品线,主要作用是使用主控电脑发送串口指令...

Windows下最简单的ESP8266_ROTS_ESP-IDF环境搭建与腾讯云SDK编译

前言其实也没啥可说的,只是我感觉ESP-IDF对新手来说很不友好,很容易踩坑,尤其是对业余DIY爱好者搭建环境非常困难,即使有官方文档,或者网上的其他文档,但是还是很容易踩坑,多研究,记住两点就行了,...

CPU眼里的:Python 和 C(cpp和python)

“Python跟C语言有什么联系?它们在计算机系统中分别扮演着什么角色?”01提出问题Python可能是当今最热门的编程语言,凭借简洁易读的语法和强大的生态,成为许多新手程序员的首选。然而,作为一门解...

Python在工控领域的应用与优势(python工业控制系统)

前言之前利用Python编写了一些S7系列的PLC调试工具和组态开发,今天就具体讲讲Python在工控领域还有哪些应用与优势。Python在工业控制工控领域的应用逐渐增多,得益于其简洁的语法、丰富的生...

取消回复欢迎 发表评论: