Python进阶系列(五)

举报
zhulin1028 发表于 2022/06/17 00:45:13 2022/06/17
【摘要】 目录 装饰器 使用场景 授权(Authorization) 日志(Logging) 带参数的装饰器 在函数中嵌入装饰器 装饰器类 装饰器 使用场景 现在我们来看一下装饰器在哪些地方特别耀眼,以及使用它可以让一些事情管理起来变得更简单。 授权(Authorization) 装饰器能有助于检查某个人是否被授权去...

目录

装饰器

使用场景

授权(Authorization)

日志(Logging)

带参数的装饰器

在函数中嵌入装饰器

装饰器类


装饰器

使用场景

现在我们来看一下装饰器在哪些地方特别耀眼,以及使用它可以让一些事情管理起来变得更简单。

授权(Authorization)

装饰器能有助于检查某个人是否被授权去使用一个web应用的端点(endpoint)。它们被大量

使用于Flask和Django web框架中。这里是一个例子来使用基于装饰器的授权:


  
  1. from functools import wraps
  2. def requires_auth(f):
  3.     @wraps(f)
  4.     def decorated(*args, **kwargs):
  5.         auth = request.authorization
  6.         if not auth or not check_auth(auth.username, auth.password):
  7.             authenticate()
  8.         return f(*args, **kwargs)
  9. return decorated

日志(Logging)

日志是装饰器运用的另一个亮点。这是个例子:


  
  1. from functools import wraps
  2. def logit(func):
  3.     @wraps(func)
  4.     def with_logging(*args, **kwargs):
  5.         print(func.__name__ + " was called")
  6.         return func(*args, **kwargs)
  7.     return with_logging
  8. @logit
  9. def addition_func(x):
  10.     """Do some math."""
  11.     return x + x
  12. result = addition_func(4)
  13. # Output: addition_func was called

我敢肯定你已经在思考装饰器的一个其他聪明用法了。

带参数的装饰器

来想想这个问题,难道@wraps不也是个装饰器吗?但是,它接收一个参数,就像任何普通的函数能做的那样。那么,为什么我们不也那样做呢?

这是因为,当你使用@my_decorator语法时,你是在应用一个以单个函数作为参数的一个包裹函数。记住,Python里每个东西都是一个对象,而且这包括函数!记住了这些,我们可以编写一下能返回一个包裹函数的函数。

在函数中嵌入装饰器

我们回到日志的例子,并创建一个包裹函数,能让我们指定一个用于输出的日志文件。


  
  1. from functools import wraps
  2. def logit(logfile='out.log'):
  3.     def logging_decorator(func):
  4.         @wraps(func)
  5.         def wrapped_function(*args, **kwargs):
  6.             log_string = func.__name__ + " was called"
  7.             print(log_string)
  8.             # 打开logfile,并写入内容
  9.             with open(logfile, 'a') as opened_file:
  10.                 # 现在将日志打到指定的logfile
  11.                 opened_file.write(log_string + '\n')
  12.             return func(*args, **kwargs)
  13.         return wrapped_function
  14.     return logging_decorator
  15. @logit()
  16. def myfunc1():
  17.     pass
  18. myfunc1()
  19. # Output: myfunc1 was called
  20. # 现在一个叫做 out.log 的文件出现了,里面的内容就是上面的字符串
  21. @logit(logfile='func2.log')
  22. def myfunc2():
  23.     pass
  24. myfunc2()
  25. # Output: myfunc2 was called
  26. # 现在一个叫做 func2.log 的文件出现了,里面的内容就是上面的字符串

装饰器类

现在我们有了能用于正式环境的logit装饰器,但当我们的应用的某些部分还比较脆弱时,异常也许是需要更紧急关注的事情。比方说有时你只想打日志到一个文件。而有时你想把引起你注意的问题发送到一个email,同时也保留日志,留个记录。这是一个使用继承的场景,但目前为止我们只看到过用来构建装饰器的函数。

幸运的是,类也可以用来构建装饰器。那我们现在以一个类而不是一个函数的方式,来重新构建logit。


  
  1. from functools import wraps
  2. class logit(object):
  3.     def __init__(self, logfile='out.log'):
  4.         self.logfile = logfile
  5.     def __call__(self, func):
  6.         @wraps(func)
  7.         def wrapped_function(*args, **kwargs):
  8.             log_string = func.__name__ + " was called"
  9.             print(log_string)
  10.             # 打开logfile并写入
  11.             with open(self.logfile, 'a') as opened_file:
  12.                 # 现在将日志打到指定的文件
  13.                 opened_file.write(log_string + '\n')
  14.             # 现在,发送一个通知
  15.             self.notify()
  16.             return func(*args, **kwargs)
  17.         return wrapped_function
  18.     def notify(self):
  19.         # logit只打日志,不做别的
  20.         pass

这个实现有一个附加优势,在于比嵌套函数的方式更加整洁,而且包裹一个函数还是使用跟以前一样的语法:


  
  1. @logit()
  2. def myfunc1():
  3.     pass

现在,我们给logit创建子类,来添加email的功能(虽然email这个话题不会在这里展开)。

class email_logit(logit):
    一个logit的实现版本,可以在函数调用时发送email给管理员


  
  1.     def __init__(self, email='admin@myproject.com', *args, **kwargs)
  2.         self.email = email
  3.         super(logit, self).__init__(*args, **kwargs)
  4.     def notify(self):
  5.         # 发送一封email到self.email
  6.         # 这里就不做实现了
  7.         pass

从现在起,@email_logit将会和@logit产生同样的效果,但是在打日志的基础上,还会多发送一封邮件给管理员。

文章来源: zhulin1028.blog.csdn.net,作者:zhulin1028,版权归原作者所有,如需转载,请联系作者。

原文链接:zhulin1028.blog.csdn.net/article/details/124419434

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。