探索Python装饰器:优雅地增强函数功能

本文涉及的产品
日志服务 SLS,月写入数据量 50GB 1个月
简介: 探索Python装饰器:优雅地增强函数功能

Python 装饰器是一种高级功能,允许你在不修改原始函数代码的情况下,动态地修改或扩展函数的行为。

基本语法

装饰器是一种特殊的函数,其基本语法如下:

def decorator_function(func):
    def wrapper(*args, **kwargs):
        # 在调用原始函数之前的操作
        result = func(*args, **kwargs)
        # 在调用原始函数之后的操作
        return result
    return wrapper

常用命令

  • @decorator_function:将装饰器应用到函数上的语法糖。
  • decorator_function:装饰器函数本身。

示例

示例 1:简单装饰器
def my_decorator(func):
    def wrapper():
        print("Something is happening before the function is called.")
        func()
        print("Something is happening after the function is called.")
    return wrapper
@my_decorator
def say_hello():
    print("Hello!")
say_hello()
示例 2:带参数的装饰器
def repeat(num_times):
    def decorator_repeat(func):
        def wrapper(*args, **kwargs):
            for _ in range(num_times):
                result = func(*args, **kwargs)
            return result
        return wrapper
    return decorator_repeat
@repeat(num_times=3)
def greet(name):
    print(f"Hello {name}")
greet("Alice")

应用场景

1. 日志记录

装饰器在日志记录中发挥着重要作用,它可以捕获函数的输入参数、执行时间以及输出结果,从而方便开发人员跟踪函数的执行过程和调试代码。通过装饰器记录日志,可以提高代码的可读性和可维护性。

示例代码

import logging
import time
def log_decorator(func):
    def wrapper(*args, **kwargs):
        logging.info(f"Calling function {func.__name__} with args: {args}, kwargs: {kwargs}")
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        logging.info(f"Function {func.__name__} executed in {end_time - start_time} seconds with result: {result}")
        return result
    return wrapper
@log_decorator
def add(x, y):
    return x + y
result = add(3, 5)
print("Result:", result)
2. 性能监控

装饰器在性能监控方面也具有重要作用,它可以帮助开发人员监控函数的执行时间,发现潜在的性能瓶颈并进行优化。通过装饰器进行性能监控,可以提高代码的效率和性能。

示例代码

import time
def performance_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"Function {func.__name__} executed in {end_time - start_time} seconds")
        return result
    return wrapper
@performance_decorator
def calculate_factorial(n):
    factorial = 1
    for i in range(1, n + 1):
        factorial *= i
    return factorial
result = calculate_factorial(10)
print("Factorial:", result)
3. 权限验证

装饰器可以用于权限验证,例如检查用户是否具有执行特定操作的权限。这种方式使得权限验证逻辑与业务逻辑分离,提高了代码的模块化和可维护性。

示例代码

def permission_required(permission):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if check_permission(permission):
                return func(*args, **kwargs)
            else:
                raise PermissionError("Permission denied")
        return wrapper
    return decorator
def check_permission(permission):
    # 检查用户是否具有指定权限的逻辑
    return True  # 此处仅为示例,实际需根据业务逻辑实现
@permission_required("admin")
def delete_user(user_id):
    # 删除用户的逻辑
    print(f"User {user_id} deleted successfully")
delete_user(123)

注意事项

1. 装饰器顺序

当多个装饰器应用于同一个函数时,它们的执行顺序与它们在代码中的顺序相反。这意味着最先定义的装饰器实际上会最后执行,而最后定义的装饰器会最先执行。

示例代码

def decorator1(func):
    def wrapper():
        print("Decorator 1 executed")
        func()
    return wrapper
def decorator2(func):
    def wrapper():
        print("Decorator 2 executed")
        func()
    return wrapper
@decorator1
@decorator2
def greet():
    print("Hello!")
greet()

输出结果为:

Decorator 1 executed
Decorator 2 executed
Hello!
2. 装饰器的参数

如果装饰器本身需要接受参数,则需要在装饰器函数外再包裹一层函数。这样的装饰器称为带参数的装饰器。在定义带参数的装饰器时,外层函数接受装饰器参数,内层函数接受被装饰函数。

示例代码

def decorator_with_param(param):
    def decorator(func):
        def wrapper():
            print(f"Decorator with parameter {param} executed")
            func()
        return wrapper
    return decorator
@decorator_with_param("test")
def greet():
    print("Hello!")
greet()

输出结果为:

Decorator with parameter test executed
Hello!

总结

装饰器是 Python 中一种强大的工具,可用于动态修改函数的行为,常用于日志记录、性能监控、权限验证等场景。通过合理使用装饰器,可以提高代码的灵活性、可重用性和可维护性。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
打赏
0
0
0
0
32
分享
相关文章
Python 语言结合 Flask 框架来实现一个基础的代购商品管理、用户下单等功能的简易系统
这是一个使用 Python 和 Flask 框架实现的简易代购系统示例,涵盖商品管理、用户注册登录、订单创建及查看等功能。通过 SQLAlchemy 进行数据库操作,支持添加商品、展示详情、库存管理等。用户可注册登录并下单,系统会检查库存并记录订单。此代码仅为参考,实际应用需进一步完善,如增强安全性、集成支付接口、优化界面等。
Python装饰器实战:打造高效性能计时工具
在数据分析中,处理大规模数据时,分析代码性能至关重要。本文介绍如何使用Python装饰器实现性能计时工具,在不改变现有代码的基础上,方便快速地测试函数执行时间。该方法具有侵入性小、复用性强、灵活度高等优点,有助于快速发现性能瓶颈并优化代码。通过设置循环次数参数,可以更准确地评估函数的平均执行时间,提升开发效率。
111 61
Python装饰器实战:打造高效性能计时工具
Python入门:8.Python中的函数
### 引言 在编写程序时,函数是一种强大的工具。它们可以将代码逻辑模块化,减少重复代码的编写,并提高程序的可读性和可维护性。无论是初学者还是资深开发者,深入理解函数的使用和设计都是编写高质量代码的基础。本文将从基础概念开始,逐步讲解 Python 中的函数及其高级特性。
Python入门:8.Python中的函数
Python装饰器是什么?
装饰器是Python中用于动态修改函数、方法或类功能的工具,无需改变原代码。通过将函数作为参数传递并返回新函数,装饰器可以在原函数执行前后添加额外逻辑。例如,使用`@logger`装饰器可以打印函数调用日志,而`@timethis`则可用于计算函数执行时间。为了保持被装饰函数的元信息(如`__name__`和`__doc__`),可使用`functools.wraps`装饰器。此外,带参数的装饰器可通过嵌套函数实现,如`@timeitS(2)`,以根据参数条件输出特定信息。
90 59
通义灵码 2.0 智能编码功能评测:Deepseek 加持下的 Python 开发体验
通义灵码 2.0 智能编码功能评测:Deepseek 加持下的 Python 开发体验
75 11
|
1月前
|
[oeasy]python057_如何删除print函数_dunder_builtins_系统内建模块
本文介绍了如何删除Python中的`print`函数,并探讨了系统内建模块`__builtins__`的作用。主要内容包括: 1. **回忆上次内容**:上次提到使用下划线避免命名冲突。 2. **双下划线变量**:解释了双下划线(如`__name__`、`__doc__`、`__builtins__`)是系统定义的标识符,具有特殊含义。
32 3
|
1月前
|
深入理解 Python 的 eval() 函数与空全局字典 {}
`eval()` 函数在 Python 中能将字符串解析为代码并执行,但伴随安全风险,尤其在处理不受信任的输入时。传递空全局字典 {} 可限制其访问内置对象,但仍存隐患。建议通过限制函数和变量、使用沙箱环境、避免复杂表达式、验证输入等提高安全性。更推荐使用 `ast.literal_eval()`、自定义解析器或 JSON 解析等替代方案,以确保代码安全性和可靠性。
51 2
[oeasy]python061_如何接收输入_input函数_字符串_str_容器_ 输入输出
本文介绍了Python中如何使用`input()`函数接收用户输入。`input()`函数可以从标准输入流获取字符串,并将其赋值给变量。通过键盘输入的值可以实时赋予变量,实现动态输入。为了更好地理解其用法,文中通过实例演示了如何接收用户输入并存储在变量中,还介绍了`input()`函数的参数`prompt`,用于提供输入提示信息。最后总结了`input()`函数的核心功能及其应用场景。更多内容可参考蓝桥、GitHub和Gitee上的相关教程。
21 0
Seaborn 教程-绘图函数
Seaborn 教程-绘图函数
93 8
python装饰器底层原理
Python装饰器是一个强大的工具,可以在不修改原始函数代码的情况下,动态地增加功能。理解装饰器的底层原理,包括函数是对象、闭包和高阶函数,可以帮助我们更好地使用和编写装饰器。无论是用于日志记录、权限验证还是缓存,装饰器都可以显著提高代码的可维护性和复用性。
53 5

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等