python装饰器详解之应用

于 2020-07-26 12:50:02 发布
阅读量201 收藏 5
点赞数 1
分类专栏： python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41923935/article/details/107454067
版权

python装饰器详解之应用

前言

在上一篇文章《python装饰器详解之语法》中，我着重分析了python装饰器的语法，装饰器提高了程序的可扩展性、灵活性及可复用性，若将其用在日常开发中会大大提高生产效率。但是面对装饰器，很多人特别是python新人并不知道装饰器应该使用在什么场景下，也不知道如何使用会使程序更加优雅。针对于此种问题，博主希望通过对实际案例的分析来进一步解说python装饰器，大家也可以从中获取一些灵感。

场景介绍

本文设计了一个无人机检查系统，无人机飞控系统中会有很多的检查，涉及到很多的检查项，为了方便管理我们将这些检查项进行分门别类。分类基于两个维度：检查阶段和检查模式。

  • 检查阶段分为：起飞前和飞行中
  • 检查模式分为：基础检查和可选检查

这里我们设计了四种检查：

  • 电源检查，检查电量是否足够
  • 通信检查，检查无线通信是否可用
  • 相机检查，检查相机是否可用
  • 位置检查，检查当前经纬度及高度

我们对四种检查进行分类：

起飞前飞行中
基础检查电源检查、通信检查电源检查
可选检查相机检查相机检查、位置检查

从上表中可以发现，同一个检查会出现在不同的阶段和不同模式下。

需求

我们只需要将检查阶段和检查模式作为输入，系统即可自动执行相关的检查。
比如，输入起飞前和基础检查，则执行电源检查 和通信检查

代码实现

基于if分支的实现

很多人看到这个场景和需求，第一想到的就是通过if语句实现。ok，我们就先用最简单的方式来实现这一功能：

# 示例1
# 检查项代码实现
def check_power(*args,**kw):
    '检查电源'
    return "power OK!"

def check_comm(*args,**kw):
    '检查通信'
    return "com OK!"

def check_camera(*args,**kw):
    '检查相机'
    return "cam OK!"

def check_position(*args,**kw):
    '检查位置'
    return "position OK!"
    
def start_check(chk_time, chk_mode):
	# 检查
	if chk_time=='before_fly' and chk_mode=='base':
		print(check_power())
		print(check_comm())
	elif chk_time=='flying' and chk_mode=='base':
		print(check_power())
	elif chk_time=='before_fly' and chk_mode=='opt':
		print(check_camera())
	elif chk_time=='flying' and chk_mode=='opt':
		print(check_camera())
		print(check_position())
		
if __name__=='__main__':
	start_check('before_fly', 'base')
'''
执行输出：
power OK!
com OK!
'''

示例1就是最朴素的实现方法，而且语法上也很好理解。但这种实现方法有很多问题，其中一个就是 可扩展性不足。我们通过下面两种场景进行简单分析：

  1. 表现在代码组织上，目前我们的检查项只有两个维度上的分类：检查阶段和检查模式，切每个维度只有两个值，此时if语句只有4中分支；当我们后期增加分类维度的时候，或者增加每个维度的取值数量时，if语句就会变量冗长，比如增加到3个维度，每个维度两个值，那if分支就会增加到8个。这种情况代码的可读性就会很差，可维护性也不好，后期修改代码会比较麻烦。
  2. 可扩展性不足的另一个场景，我们考虑在每个检查前都做一个检查前准备和检查后结果打包处理，那我们就要去修改每个分支或者修改每个检查函数，这个时候的要付出的代价也是很高的。

基于装饰器实现

对于以上问题，我们基于装饰器实现同样的功能，看下效果如何：

# 示例2
from functools import wraps

g_dictRunTime={}
'''
g_dictRunTime 形如
{
    "before_fly":[func1,func2]
    "after_fly":[func1]
}
'''

g_dictRunMode={}
'''
g_dictRunMode形如
{
    "manual":['func1','func2'] 
    "auto":['func1']
}
'''

def run_time_registe(*runTimes):
    def decorator(func):
        for runTime in runTimes:
            if runTime not in g_dictRunTime.keys(): 
                g_dictRunTime[runTime] = list()
            g_dictRunTime[runTime].append(func)
        @wraps(func)
        def wrapper(*args,**kw):
            return func(args,kw)
        return wrapper
    return decorator

def run_mode_registe(*runModes):
    
    def decorator(func):
        for runMode in runModes:
            if runMode not in g_dictRunMode.keys():
                g_dictRunMode[runMode] = list()
            g_dictRunMode[runMode].append(func.__name__)
        @wraps(func)
        def wrapper(*args,**kw):
            return func(args,kw)
        return wrapper
    return decorator

@run_time_registe("before_fly", 'flying')
@run_mode_registe("base")
def check_power(*args,**kw):
    '检查电源'
    return "power OK!"


@run_time_registe("before_fly")
@run_mode_registe("base")
def check_comm(*args,**kw):
    '检查通信'
    return "com OK!"

@run_time_registe("before_fly", 'flying')
@run_mode_registe("opt")
def check_camera(*args,**kw):
    '检查相机'
    return "cam OK!"

@run_time_registe("flying")
@run_mode_registe("opt")
def check_position(*args,**kw):
    '检查位置'
    return "position OK!"

def start_check(chk_time, chk_mode):
    for func in g_dictRunTime[chk_time]:
        if func.__name__ in g_dictRunMode[chk_mode]:
            print(func())

if __name__=="__main__":
    start_check('before_fly', 'base')
'''
执行输出：
power OK!
com OK!
'''

示例2使用装饰器来实现了示例1中同样的功能，不熟悉装饰的小伙伴看到这块代码可能会有点蒙，此处不对装饰器代码进行详细剖析，这块理解不好的可以看我上一篇文章python装饰器详解之语法。有遗憾的地方也可以在以上的代码的基础上修改实验，都是可以得到答案的。
这里通过两个装饰器run_time_registe()和run_mode_registe()将不同的检查函数注册到了两个dict变量，最后在start_check()中通过for循环调用所需的检查函数。
此时代码的可扩展性就变的很好了，当你想增加新的检查项时，直接定义检查函数，外加装饰器即可。当增加新的分类维度时，可以增加一个装饰器函数。
另外，当我们想在检查前和检查后增加一些处理函数时，也很方便，如下：

# -*- coding:utf-8 -*- 
from functools import wraps
import time

g_dictRunTime={}
'''
g_dictRunTime 形如
{
    "before_fly":[func1,func2]
    "after_fly":[func1]
}
'''

g_dictRunMode={}
'''
g_dictRunMode形如
{
    "base":['func1','func2'] 
    "opt":['func1']
}
'''

def run_time_registe(*runTimes):
    def decorator(func):
        for runTime in runTimes:
            if runTime not in g_dictRunTime.keys(): 
                g_dictRunTime[runTime] = list()
            g_dictRunTime[runTime].append(func)
        @wraps(func)
        def wrapper(*args,**kw):
            return func(args,kw)
        return wrapper
    return decorator

def run_mode_registe(*runModes):
    
    def decorator(func):
        for runMode in runModes:
            if runMode not in g_dictRunTime.keys():
                g_dictRunTime[runMode] = list()
            g_dictRunTime[runMode].append(func.__name__)
        @wraps(func)
        def wrapper(*args,**kw):
            return func(args,kw)
        return wrapper
    return decorator

def prepare_check(func):
    @wraps(func)
    def wrapper(*args,**kw):
        msg = "name: "+func.__name__ +"\nstartTime: "+ time.asctime( time.localtime(time.time()) )
        checkResult = func(args,kw)
        return msg+checkResult
    return wrapper

def pack_msg(func):
    @wraps(func)
    def wrapper1(*args,**kw):
        checkResult = func(args,kw)
        return "\nresult: "+checkResult+'\n'
    return wrapper1


@run_time_registe("before_fly", 'flying')
@run_mode_registe("base")
@prepare_check
@pack_msg
def check_power(*args,**kw):
    '检查电源'
    return "power OK!"


@run_time_registe("before_fly")
@run_mode_registe("base")
@prepare_check
@pack_msg
def check_comm(*args,**kw):
    '检查通信'
    return "com OK!"

@run_time_registe("before_fly", 'flying')
@run_mode_registe("opt")
@prepare_check
@pack_msg
def check_camera(*args,**kw):
    '检查相机'
    return "cam OK!"

@run_time_registe("flying")
@run_mode_registe("opt")
@prepare_check
@pack_msg
def check_position(*args,**kw):
    '检查位置'
    return "position OK!"

def start_check(chk_time, chk_mode):
    for func in g_dictRunTime[chk_time]:
        if func.__name__ in g_dictRunTime[chk_mode]:
            print(func())

if __name__=="__main__":
    start_check( 'before_fly','base')

'''
执行结果：
name: check_power
startTime: Sun Jul 26 12:15:16 2020
result: power OK!

name: check_comm
startTime: Sun Jul 26 12:15:16 2020
result: com OK!
'''

我们增加了两个函数：

  • 检查前准备 prepare_check() ，在检查前提供检查项名称和检查时间
  • 检查后消息打包 pack_msg() ，将检查结果进行简单的包装

通过装饰器，我们可以在不修改原检查函数以及检查调用 start_check() 的情况下，来实现功能的拓展。

结束语

本文通过一个实际的案例，对装饰器的用法以及其作用进行了讲述。对于新手来说，本文代码可能还需要细细品读才能明白每一处的作用，最好能够实际动手操练一下。
大家有何想法可以评论区说一说。

码字不易，如果喜欢可以点赞 关注，博主会将更多有意思的东西分享出来。

zhanghl_
关注
  • 1
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
python装饰器实例大详解
09-21
Python装饰器是一种强大的工具，它允许我们修改或增强已有函数的功能，而不必改变函数的源代码。装饰器本质上是接收一个函数作为参数并返回新函数的高阶函数。在这个实例大详解中，我们将深入探讨装饰器的作用域、...
Python 装饰器使用详解
09-21
装饰器的强大之处在于它们可以堆叠，也就是说一个函数可以被多个装饰器装饰，每个装饰器都可以添加不同的功能。这使得我们可以构建复杂的代码结构，同时保持代码的整洁和模块化。 总的来说，Python的装饰器提供了一...
Python装饰器详解
StormMaybin的博客
06-10 1642
@author StormMa @date 2017-06-09 生命不息，奋斗不止！ 开始之前 第一次接触Python的时候就是直接开始写一些爬虫或者是使用django写简单的web应用，但是最近想回头来看看Python中好玩的特性或者是基础。今天就来看一下装饰器的使用，其实感觉Python中的装饰器，有点类似于Java中的Aspect。就像你在一个方法中处理主要的业务逻辑，如果要想在
python装饰器详解,python装饰器笔记心得.doc
10-01
"Python装饰器详解" Python装饰器是程序开发中经常会用到的一个功能，用好了装饰器，开发效率如虎添翼。这也是Python面试中必问的问题。但对于好多初次接触这个知识的人来讲，这个功能有点绕，自学时直接绕过去了，...
Python装饰器基础详解
12-24
装饰器(decorator)是一种高级Python语法。装饰器可以对一个函数、方法或者类进行加工。在Python中，我们有多种方法对函数...Python装饰器以两种形式呈现： 【1】函数装饰器在函数定义的时候进行名称重绑定，提供一个逻
Python中的装饰模式如何实现？
qq_32506555的博客
07-10 219
本文和大家分享的主要是python中装饰模式的实现方式相关内容，一起来看看吧，希望对大家学习python有所帮助。 　　功能目标 　　编写一个可以打印被装饰函数名称、执行时间、内存地址得装饰器 　　前置依赖包 　　import time 　　import functools 　　from decorator import decorator 　　基于普通的
Python装饰器各种类型详解
yhy1271927580的博客
05-25 8592
装饰器装饰器有很多经典的使用场景，例如插入日志、性能测试、事务处理等等，有了装饰器，就可以提取大量函数中与本身功能无关的类似代码，从而达到代码重用的目的，而且还能将函数和类的功能进行扩充，实现被装饰对象的功能扩展 的
Python装饰器的超详细解析，保证你绝对能看懂
梅花14的博客
12-17 7498
我们不生产水，我们只做大自然的搬运工 超详细的解释，由浅入深，比廖雪峰那个教程要详细一些（不过峰哥整体教程还是挺好的，很适合入门，也适合我们回头复习Python），下面奉上超详细的Python装饰器解释，保证能看懂。 http://www.cnblogs.com/cicaday/p/python-decorator.html...
python装饰器详解
weixin_30786657的博客
10-14 300
装饰器详解 装饰器的具体定义： 1、把要装饰的方法作为输入参数； 2、在函数体内可以进行任意的操作(可以想象其中会有很多应用场景)； 3、只要确保最后返回一个可执行的函数即可（可以是原来的输入参数函数，也可以是一个新函数）。 装饰器其实就是一个闭包，把一个函数当做参数后返回一个替代版函数，闭包是装饰器的核心。 简单解释下闭包的特点： 一个函数返回的函数对象，这个函数对象执行...
Python各种类型装饰器详解说明
热门推荐
上帝De助手
10-27 1万+
装饰器说明 Python中的装饰器是一种可以装饰其它对象的工具。 该工具本质上是一个可调用的对象（callable），所以装饰器一般可以由函数、类来实现。 装饰器本身需要接受一个被装饰的对象作为参数，该参数通常为函数、方法、类等对象。 装饰器需要返回一个对象，该对象可以是 经过处理的原参数对象、一个包装且类似原参数的对象；或者返回一个不相干内容（通常不建议使用） 相信通过上述一段文字的描述...
财务报表，项目费用支出明细.xlsx
08-09
工资表，财务报表，对账表，付款申请，财务报告，费用支出表 适用人群：学习不同技术领域的小白或进阶学习者；可作为毕设项目、课程设计、大作业、工程实训或初期项目立项。
ppap-第四版.pdf
08-09
ppap-第四版
铁路转辙机 ZD6 使用说明书
最新发布
08-09
铁路转辙机 ZD6 使用说明书
Python装饰器详解与应用
"Python高级编程探讨了装饰器的概念和应用，揭示了装饰器在Python中的核心功能，即作为可接受并返回调用的调用。装饰器主要用于在函数执行前后添加额外的功能，如预处理、后处理、注册或管理资源等。通过装饰器，...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值