两个很实用的Python装饰器详解

落日邮差
落日邮差
发布时间:2026-10-15| 6人浏览过
原创

本文详细介绍两个实用的Python装饰器:用于处理外部API调用或爬虫中超时问题的timeout装饰器,以及用于调试和演示代码执行顺序的trace装饰器。通过具体代码示例,展示如何自定义异常处理与sys.settrace机制,提升Python开发的健壮性与可维护性。

1.超时函数

该函数的主要作用是为任何可能陷入停滞的函数添加超时机制。在开发外部API调用、网络爬虫程序或执行数据库查询时,这一功能尤为关键,能有效防止程序因无响应而长时间挂起。

实现timeout装饰器的具体代码如下:


import signal,functools #下面会用到的两个库 
class TimeoutError(Exception): pass #定义一个Exception,后面超时抛出 
def timeout(seconds, error_message = 'Function call timed out'):
  def decorated(func):
    def _handle_timeout(signum, frame):
      raise TimeoutError(error_message)
    def wrapper(*args, **kwargs):
      signal.signal(signal.SIGALRM, _handle_timeout)
      signal.alarm(seconds)
      try:
        result = func(*args, **kwargs)
      finally:
        signal.alarm(0)
      return result
    return functools.wraps(func)(wrapper)
  return decorated

使用示例如下:


@timeout(5) #限定下面的slowfunc函数如果在5s内不返回就强制抛TimeoutError Exception结束 
def slowfunc(sleep_time):
  import time
  time.sleep(sleep_time) #这个函数就是休眠sleep_time秒 
slowfunc(3) #sleep 3秒,正常返回 没有异常
slowfunc(10) #被终止 

## 输出 --------------------------------------------------------------------------- TimeoutError Traceback (most recent call last)

2.Trace函数

在编写演示代码或进行调试时,往往需要清晰了解程序每一步的执行顺序及调用逻辑。类似于Bash脚本中通过bash -x进行调试的方式,Python解释器并未内置此类功能。因此,我们需要“自己动手,丰衣足食”,通过自定义装饰器来实现这一需求。

实现Trace装饰器的具体代码如下:


'''
学习中遇到问题没人解答?小编创建了一个Python学习交流群:725638078
寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书!
'''
import sys,os,linecache
def trace(f):
  def globaltrace(frame, why, arg):
    if why == "call": return localtrace
    return None
  def localtrace(frame, why, arg):
    if why == "line":
      # record the file name and line number of every trace
      filename = frame.f_code.co_filename
      lineno = frame.f_lineno
      bname = os.path.basename(filename)
      print("{}({}): {}".format(  bname,
        lineno,
        linecache.getline(filename, lineno).strip('\r\n')),)
    return localtrace
  def _f(*args, **kwds):
    sys.settrace(globaltrace)
    result = f(*args, **kwds)
    sys.settrace(None)
    return result
  return _f

使用示例如下:


@trace
def xxx():
  print (1)
  print (22)
  print (333)
xxx() #调用 

## 输出 <ipython-input-4-da50741ac84e>(3): print 1 # @trace 的输出 1 <ipython-input-4-da50741ac84e>(4): print 22 # @trace 的输出 22 <ipython-input-4-da50741ac84e>(5): print 333 # @trace 的输出 333

总结

本文到此结束,希望能为读者提供帮助。同时也欢迎大家关注本站,获取更多技术内容!

相关标签:

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。