Python装饰器用法实例总结

Stella981
• 阅读 456

一、装饰器是什么

python的装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象。简单的说装饰器就是一个用来返回函数的函数。

它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。

概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能。

二、为什么需要装饰器

1、先来看一个简单例子:

?

1

2

def foo():

print ( 'i am foo' )

2、增加需求

现在有一个新的需求,希望可以记录下函数的执行日志,于是在代码中添加日志代码:

?

1

2

3

def foo():

print ( 'i am foo' )

print ( "foo is running" )

3、又有需求

假设现在有100个函数需要增加这个需求,并且后续可能还要对这一百个函数都增加执行前打印日志的需求,怎么办?还一个个改吗?

当然不了,这样会造成大量雷同的代码,为了减少重复写代码,我们可以这样做,重新定义一个函数:专门处理日志 ,日志处理完之后再执行真正的业务代码。

?

1

2

3

4

5

6

7

8

9

def use_logging(func):

print ( "%s is running" % func.__name__)

func()

def bar():

print ( 'i am bar' )

use_logging(bar)

#result:

#bar is running

#i am bar

通过以上use_logging函数我们增加了日志功能,不管以后有多少函数需要增加日志或者修改日志的格式我们只需要修改use_logging函数,并执行use_logging(被装饰的函数)就达到了我们想要的效果。

?

1

2

3

4

5

6

7

def use_logging(func):

print ( "%s is running" % func.__name__)

return func

@use_logging

def bar():

print ( 'i am bar' )

bar()

三、基础装饰器入门

1、装饰器语法糖

python提供了@符号作为装饰器的语法糖,使我们更方便的应用装饰函数。但使用语法糖要求装饰函数必须return一个函数对象。因此我们将上面的func函数使用内嵌函数包裹并return。

装饰器相当于执行了装饰函数use_loggin后又返回被装饰函数bar,因此bar()被调用的时候相当于执行了两个函数。等价于use_logging(bar)()

?

1

2

3

4

5

6

7

8

9

def use_logging(func):

def _deco():

print ( "%s is running" % func.__name__)

func()

return _deco

@use_logging

def bar():

print ( 'i am bar' )

bar()

2、对带参数的函数进行装饰

现在我们的参数需要传入两个参数并计算值,因此我们需要对内层函数进行改动传入我们的两个参数a和b,等价于use_logging(bar)(1,2)

?

1

2

3

4

5

6

7

8

9

def use_logging(func):

def _deco(a,b):

print ( "%s is running" % func.__name__)

func(a,b)

return _deco

@use_logging

def bar(a,b):

print ( 'i am bar:%s' % (a + b))

bar( 1 , 2 )

我们装饰的函数可能参数的个数和类型都不一样,每一次我们都需要对装饰器做修改吗?这样做当然是不科学的,因此我们使用python的变长参数*args和**kwargs来解决我们的参数问题。

3、函数参数数量不确定

不带参数装饰器版本,这个格式适用于不带参数的装饰器。

经过以下修改我们已经适应了各种长度和类型的参数。这个版本的装饰器已经可以任意类型的无参数函数。

?

1

2

3

4

5

6

7

8

9

10

11

12

13

def use_logging(func):

def _deco( * args, * * kwargs):

print ( "%s is running" % func.__name__)

func( * args, * * kwargs)

return _deco

@use_logging

def bar(a,b):

print ( 'i am bar:%s' % (a + b))

@use_logging

def foo(a,b,c):

print ( 'i am bar:%s' % (a + b + c))

bar( 1 , 2 )

foo( 1 , 2 , 3 )

4、装饰器带参数

带参数的装饰器,这个格式适用于带参数的装饰器。

某些情况我们需要让装饰器带上参数,那就需要编写一个返回一个装饰器的高阶函数,写出来会更复杂。比如:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

#! /usr/bin/env python

# -*- coding:utf-8 -*-

# __author__ = "TKQ"

def use_logging(level):

def _deco(func):

def __deco( * args, * * kwargs):

if level = = "warn" :

print "%s is running" % func.__name__

return func( * args, * * kwargs)

return __deco

return _deco

@use_logging (level = "warn" )

def bar(a,b):

print ( 'i am bar:%s' % (a + b))

bar( 1 , 3 )

# 等价于use_logging(level="warn")(bar)(1,3)

5、functools.wraps

使用装饰器极大地复用了代码,但是他有一个缺点就是原函数的元信息不见了,比如函数的docstring、__name__、参数列表,先看例子:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

def use_logging(func):

def _deco( * args, * * kwargs):

print ( "%s is running" % func.__name__)

func( * args, * * kwargs)

return _deco

@use_logging

def bar():

print ( 'i am bar' )

print (bar.__name__)

bar()

#bar is running

#i am bar

#_deco

#函数名变为_deco而不是bar,这个情况在使用反射的特性的时候就会造成问题。因此引入了functools.wraps解决这个问题。

使用functools.wraps:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

import functools

def use_logging(func):

@functools .wraps(func)

def _deco( * args, * * kwargs):

print ( "%s is running" % func.__name__)

func( * args, * * kwargs)

return _deco

@use_logging

def bar():

print ( 'i am bar' )

print (bar.__name__)

bar()

#result:

#bar is running

#i am bar

#bar ,这个结果是我们想要的。OK啦!

6、实现带参数和不带参数的装饰器自适应

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

import functools

def use_logging(arg):

if callable (arg): #判断参入的参数是否是函数,不带参数的装饰器调用这个分支

@functools .wraps(arg)

def _deco( * args, * * kwargs):

print ( "%s is running" % arg.__name__)

arg( * args, * * kwargs)

return _deco

else : #带参数的装饰器调用这个分支

def _deco(func):

@functools .wraps(func)

def __deco( * args, * * kwargs):

if arg = = "warn" :

print "warn%s is running" % func.__name__

return func( * args, * * kwargs)

return __deco

return _deco

@use_logging ( "warn" )

# @use_logging

def bar():

print ( 'i am bar' )

print (bar.__name__)

bar()

三、类装饰器

使用类装饰器可以实现带参数装饰器的效果,但实现的更加优雅简洁,而且可以通过继承来灵活的扩展.

1、类装饰器

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

class loging( object ):

def __init__( self ,level = "warn" ):

self .level = level

def __call__( self ,func):

@functools .wraps(func)

def _deco( * args, * * kwargs):

if self .level = = "warn" :

self .notify(func)

return func( * args, * * kwargs)

return _deco

def notify( self ,func):

# logit只打日志,不做别的

print "%s is running" % func.__name__

@loging (level = "warn" ) #执行__call__方法

def bar(a,b):

print ( 'i am bar:%s' % (a + b))

bar( 1 , 3 )

2、继承扩展类装饰器

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

class email_loging(Loging):

'''

一个loging的实现版本,可以在函数调用时发送email给管理员

'''

def __init__( self , email = 'admin@myproject.com' , * args, * * kwargs):

self .email = email

super (email_loging, self ).__init__( * args, * * kwargs)

def notify( self ,func):

# 发送一封email到self.email

print "%s is running" % func.__name__

print "sending email to %s" % self .email

@email_loging (level = "warn" )

def bar(a,b):

print ( 'i am bar:%s' % (a + b))

bar( 1 , 3 )

点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
半臻 半臻
3年前
Python基础5——装饰器
13、装饰器其本质:在不需要做任何代码变动的前提下,增加额外的功能。装饰器返回的是一个函数对象。相当于把函数作为参数传递进去,然后对函数进行装饰其本质就是一个闭包作用:1.给原来的函数增加额外的功能2.把原来的函数作为参数传递进去13.1基本用法标准版的装饰器pythondefwrapper(func):func为原来的函数名defin
Irene181 Irene181
3年前
恶补了 Python 装饰器的六种写法,你随便问~
大家好,我是明哥。今天给大家分享一下关于装饰器的知识点,内容非常干,全程高能,认真吸收看完,一定会对装饰器有更深的理解。Hello,装饰器装饰器本质上是一个Python函数,它可以让其他函数在不需要做任何代码变动的前提下增加额外功能,装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景,比如:插入日志、性能测试、事务处理、缓存、权限校验等场景。装饰
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
Karen110 Karen110
3年前
浅析装饰器的那些事儿
一、装饰器的简单定义外层函数返回里层函数的引用,里层函数引用外层函数的变量。二、装饰器的作用通俗来讲装饰器的作用就是在不改变已有函数代码前提下,为该函数增加新的功能。defrun():print('我会跑')fun()现在我想在原有函数的基础上新增一个功能:我会唱歌。这个时候利用装饰器则轻松可以帮我们实现这个功能。三、实例理解(1)不
Python进阶者 Python进阶者
3年前
浅析装饰器的那些事儿
一、装饰器的简单定义外层函数返回里层函数的引用,里层函数引用外层函数的变量。二、装饰器的作用通俗来讲装饰器的作用就是在不改变已有函数代码前提下,为该函数增加新的功能。defrun():print('我会跑')fun()现在我想在原有函数的基础上新增一个功能:我会唱歌。这个时候利用装饰器则轻松可以帮我们实现这个功能。三、实
Stella981 Stella981
2年前
Python进阶笔记(2)
'''装饰器装饰器(Decorators)是Python的一个重要部分。简单地说:他们是修改其他函数的功能的函数。他们有助于让我们的代码更简短。如果已经接触过FLASK的,想想路由功能。如果没有接触过FLASK的,建议学习下。''''''各种推导式(compre
Stella981 Stella981
2年前
Python 装饰器(Decorator)
Python 装饰器(Decorator)装饰模式有很多经典的使用场景,例如插入日志、性能测试、事务处理等等,有了装饰器,就可以提取大量函数中与本身功能无关的类似代码,从而达到代码重用的目的。下面就一步步看看Python中的装饰器。装饰器本身是一个Python函数,他可以让其他函数在不需要做任何代码变动
Stella981 Stella981
2年前
Python中函数装饰器及练习
1)装饰器的理解:1、作用:在不改变原函数的基础上,给函数增加功能   2、返回值:把一个函数当作参数,返回一个替代版的函数3、本质:返回函数的函数4、应用场景:计时器、记录日志、用户登陆认证、函数参数认证2)无参函数装饰器  实例:被装饰的函数没有参数     执行结果为:  
3A网络 3A网络
1年前
Golang 常见设计模式之装饰模式
Golang常见设计模式之装饰模式想必只要是熟悉Python的同学对装饰模式一定不会陌生,这类Python从语法上原生支持的装饰器,大大提高了装饰模式在Python中的应用。尽管Go语言中装饰模式没有Python中应用的那么广泛,但是它也有其独到的地方。接下来就一起看下装饰模式在Go语言中的应用。简单装饰器我们通过一个简单的例子来