Python进阶--装饰器

简介: Python进阶--装饰器

装饰器简介

每个Python开发者早晚都会遇到装饰器@,装饰器通常用于增强函数功能。

例如,在Django中用装饰器为视图添加权限:

@permission_required('edit_publisher')
def publisher_edit(request, pk=None):
    ...


注册标签

@register.simple_tag
def generic_simple_tag(arg1, arg2):
    ...

装饰器是可调用对象,其参数是一个函数。返回值是一个函数。

下面我们定义一个装饰器dec,它的作用是在执行函数前打印一句话"做了一个装饰"。

def dec(func):
    def inner():
        print("做了一个装饰")
        func()
    return inner

可以用两种方式使用装饰器

  1. @dec放在函数定义上面一行。(常用)
  2. 将函数传递给装饰器dec(func2)
@dec
def func1():
    print("Hello! func1")

def func2():
    print("Hello! func2")

func1()
print("---")
dec_func2 = dec(func2)
print("---")
dec_func2() 

输出:

做了一个装饰
Hello! func1
---
---
做了一个装饰
Hello! func2

实用的装饰器

1. 计时器

下面定义了一个记录函数耗时的装饰器。

import time
import functools
def clock(func):
    @functools.wraps(func)
    def clocked(*args, **kwargs):
        t0 = time.perf_counter()
        result = func(*args, **kwargs)
        elapsed = time.perf_counter() - t0
        name = func.__name__
        arg_lst = [repr(arg) for arg in args]
        arg_lst.extend(f'{k}={v!r}' for k, v in kwargs.items())
        arg_str = ', '.join(arg_lst)
        print(f'[{elapsed:0.8f}s] {name}({arg_str}) -> {result!r}')
        return result
    return clocked

@clock
def factorial(n):
    return 1 if n < 2 else n*factorial(n-1)

factorial(3)

运行结果:

[0.00000030s] factorial(1) -> 1
[0.00004380s] factorial(2) -> 2
[0.00005380s] factorial(3) -> 6

clocked在执行函数前后各记录一次时间,得到函数运行耗时,并且打印函数名称和参数。

clocked函数使用@functools.wraps(func)修饰,@wraps的作用是将所有元数据从一个函数复制到另一个函数,这样可以保留原始函数的信息。(*args, **kwargs)实现了可变数量的位置参数、关键字参数。

2. 返回装饰器的函数

返回装饰器的函数可以实现更灵活的装饰器。

下面定义了一个返回装饰器的函数。装饰器的作用是:当upper_case=True时将func的返回字符串转化成大写,否则返回原始字符串。

from functools import wraps
def function_that_creates_a_decorator(upper_case=False):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            result = func(*args, **kwargs)
            if upper_case: 
                result = result.upper()
            return result
        return wrapper
    return decorator

这个代码看起来有点奇怪,我们一层层地读一下。

  • 最外层定义了一个函数def function_that_creates_a_decorator(upper_case=False),这个函数的作用是返回一个装饰器。
  • 第二层的def decorator(func)是真正的装饰器,返回包装后的函数。
  • 第三层的def wrapper(*args, **kwargs)是包装的函数。这个函数使用@wraps修饰。
@function_that_creates_a_decorator(upper_case=True)
def normalize_user_input(user_input: str, default: str | None=None) -> str | None:
    """Reduce PBCK as much as possible"""
    return str(user_input).strip().casefold() or default


result = normalize_user_input("HEllo, WoRLD")
print(result)

运行结果:

HELLO, WORLD

注意@function_that_creates_a_decorator(upper_case=True)使用了(),是一个函数调用,返回了装饰器。

装饰器的注意事项

  1. 装饰器在导入模块时立即执行,而被装饰的函数只在显式调用时运行。
  2. 可以使用多个装饰器,装饰器将按照从里到外的顺序进行装饰。如:
def dec1(func):
    def inner():
        print("做了一个装饰dec1")
        func()
    return inner

def dec2(func):
    def inner():
        print("做了一个装饰dec2")
        func()
    return inner

@dec2 
@dec1
def func1():
    print("Hello! func1")

func1()

运行结果:

做了一个装饰dec2
做了一个装饰dec1
Hello! func1

参考&推荐阅读

  1. 《流畅的Python》(第二版) 第9章 装饰器和闭包
  2. https://www.bitecode.dev/p/xmas-decoration-part-2
相关文章
|
13天前
|
监控 测试技术 Python
颠覆传统!Python闭包与装饰器的高级实战技巧,让你的项目效率翻倍
【7月更文挑战第7天】Python的闭包与装饰器是强大的工具。闭包是能记住外部作用域变量的内部函数,常用于动态函数创建和工厂模式。例如,`make_power`返回含外部变量`n`的`power`闭包。装饰器则允许在不修改函数代码的情况下添加新功能,如日志或性能监控。`my_decorator`函数接收一个函数并返回包装后的函数,添加了前后处理逻辑。掌握这两者,可提升编程效率和灵活性。
24 3
|
8天前
|
存储 算法 搜索推荐
算法进阶之路:Python 归并排序深度剖析,让数据排序变得艺术起来!
【7月更文挑战第12天】归并排序是高效稳定的排序算法,采用分治策略。Python 实现包括递归地分割数组及合并已排序部分。示例代码展示了如何将 `[12, 11, 13, 5, 6]` 分割并归并成有序数组 `[5, 6, 11, 12, 13]`。虽然 $O(n log n)$ 时间复杂度优秀,但需额外空间,适合大规模数据排序。对于小规模数据,可考虑其他算法。**
33 4
|
10天前
|
算法 Python
Python算法高手进阶指南:分治法、贪心算法、动态规划,掌握它们,算法难题迎刃而解!
【7月更文挑战第10天】探索Python算法的精华:分治法(如归并排序)、贪心策略(如找零钱问题)和动态规划(解复杂问题)。通过示例代码揭示它们如何优化问题解决,提升编程技能。掌握这些策略,攀登技术巅峰。
|
13天前
|
程序员 Python
从零到一,彻底掌握Python闭包与装饰器的精髓,成为编程界的隐藏Boss
【7月更文挑战第7天】探索Python编程的两大基石:闭包与装饰器。闭包是内部函数记住外部作用域的变量,如`make_multiplier_of`返回的`multiplier`,它保持对`n`的引用。装饰器则是函数工厂,接收函数并返回新函数,如`my_decorator`,它在不改变原函数代码的情况下添加日志功能。掌握这些,让代码更优雅,效率更高,助你成为编程高手。
18 3
|
13天前
|
程序员 Python
程序员必看!Python闭包与装饰器的高级应用,让你的代码更优雅、更强大
【7月更文挑战第7天】Python中的闭包和装饰器是高级特性,用于增强代码功能。闭包是内部函数记住外部作用域的变量,常用于动态函数和函数工厂。示例展示了`make_multiplier_of`返回记住n值的`multiplier`闭包。装饰器则是接收函数并返回新函数的函数,用于不修改原函数代码就添加功能。`my_decorator`装饰器通过`@`语法应用到`say_hello`函数上,展示了在调用前后添加额外行为的能力。这两种技术能提升代码的优雅性和效率。
20 3
|
13天前
|
Python
Python编程实战:利用闭包与装饰器优化日志记录功能
【7月更文挑战第7天】Python的闭包和装饰器简化了日志记录。通过定义如`log_decorator`的装饰器,可以在不修改原函数代码的情况下添加日志功能。当@log_decorator用于`add(x, y)`函数时,调用时自动记录日志。进一步,`timestamp_log_decorator`展示了如何创建特定功能的装饰器,如添加时间戳。这些技术减少了代码冗余,提高了代码的可维护性。
17 1
|
13天前
|
Python
Python黑魔法揭秘:闭包与装饰器的高级玩法,让你代码飞起来
【7月更文挑战第7天】Python的闭包和装饰器是提升代码效率的神器。闭包是能记住外部作用域变量的内部函数,常用于动态函数创建。示例中,`make_multiplier_of`返回一个保留`n`值的闭包。装饰器则是一个接收函数并返回新函数的函数,用于在不修改原函数情况下添加功能,如日志或性能追踪。`@my_decorator`装饰的`say_hello`函数在执行时会自动加上额外操作。掌握这两者,能让Python代码更优雅、强大。**
|
16天前
|
自然语言处理 Python
从菜鸟到大神,一篇文章带你玩转Python闭包与装饰器的深度应用
【7月更文挑战第4天】Python中的闭包和装饰器是增强代码优雅性的关键特性。闭包是能访问外部作用域变量的内部函数,如示例中的`inner_function`。装饰器则是接收函数并返回新函数的函数,用于扩展功能,如`my_decorator`。装饰器可与闭包结合,如`repeat`装饰器,它使用闭包记住参数并在调用时重复执行原函数。这些概念提升了代码复用和可维护性。
|
1天前
|
SQL 前端开发 数据库
Python Web开发进阶之路:从模板引擎到ORM的全面掌握
【7月更文挑战第19天】在Python Web开发中,提升技能的关键是理解和运用模板引擎(如Jinja2)与ORM技术。模板引擎,如在Flask中使用的Jinja2,使前端HTML与后端逻辑分离,便于维护。例如,通过路由函数`show_posts()`和`render_template()`呈现文章列表模板,用Jinja2的`for`循环展示内容。ORM,如SQLAlchemy,提供Pythonic的数据库操作,将表映射为类,SQL转化为方法调用。在博客系统中,定义Post模型并与数据库交互,展示了ORM简化数据管理的优势。通过实践这些工具,开发者能更好地驾驭复杂的Web项目。
9 0
|
6天前
|
缓存 测试技术 Python
Python中的装饰器:优雅地增强函数功能
在Python编程中,装饰器是一种强大的工具,它能够在不改变函数本身的情况下,动态地增强其功能。本文将深入探讨装饰器的工作原理、常见用法以及如何利用装饰器提高代码的可重用性和可维护性。