Python 超时控制利器：func-timeout 使用详解

诸神缄默不语-个人技术博文与视频目录

在 Python 编程中，我们经常需要控制函数的执行时间，防止某些操作（如网络请求、文件处理等）因异常或延迟而阻塞程序的运行。func-timeout 是一个轻量级的第三方库，能够为任意函数设置超时时间，并在超时后抛出异常，从而优雅地中断函数执行。

pypi官网：https://pypi.org/project/func-timeout/

📦 安装方法

使用 pip 安装：

pip install func-timeout

🛠️ 基本用法

1. 使用装饰器 @func_set_timeout

from func_timeout import func_set_timeout, FunctionTimedOut
import time

@func_set_timeout(5)  # 设置超时时间为5秒
def long_task():
    print("任务开始")
    time.sleep(10)  # 模拟耗时操作
    print("任务完成")

try:
    long_task()
except FunctionTimedOut:
    print("函数执行超时")

在上述示例中，long_task 函数被设置了 5 秒的超时时间，但实际执行时间为 10 秒，因此会抛出 FunctionTimedOut 异常。

2. 使用 func_timeout 函数

from func_timeout import func_timeout, FunctionTimedOut
import time

def long_task():
    print("任务开始")
    time.sleep(10)
    print("任务完成")

try:
    func_timeout(5, long_task)  # 设置超时时间为5秒
except FunctionTimedOut:
    print("函数执行超时")

这种方式适用于不方便使用装饰器的场景。

⚙️ 工作原理

func-timeout 的核心机制是利用 Python 的信号（signal）模块设置闹钟信号（SIGALRM），在指定时间后触发异常，从而中断函数的执行。

具体流程如下：

1. 设置一个定时器，在指定时间后发送 SIGALRM 信号。
2. 当函数执行时间超过设定值时，接收到 SIGALRM 信号，触发 FunctionTimedOut 异常。
3. 函数被中断，程序可以根据需要进行异常处理。

需要注意的是，signal 模块的 SIGALRM 信号在 Windows 系统上不支持，因此 func-timeout 在 Windows 上的表现可能不如在类 Unix 系统上稳定。

signal模块的教程可以参考我写的另一篇博文：Python signal 模块详解：优雅处理异步事件

⚠️ 注意事项

• 线程限制：func-timeout 使用 signal 模块设置超时信号，而 signal 只能在主线程中使用。因此，在多线程环境中，只有主线程可以设置超时，子线程中使用 func-timeout 可能无法达到预期效果。

• 资源清理：当函数被中断时，func-timeout 会尝试进行一些清理工作，如恢复原来的信号处理器。但如果函数中有需要手动释放的资源（如文件句柄、网络连接等），建议在异常处理中进行适当的资源释放。

🧪 实际应用场景

1. 网络请求超时控制

import requests
from func_timeout import func_timeout, FunctionTimedOut

def fetch_data():
    response = requests.get("https://example.com", timeout=10)
    return response.text

try:
    data = func_timeout(5, fetch_data)
except FunctionTimedOut:
    print("请求超时")

在上述示例中，虽然 requests.get 自身支持超时设置，但通过 func_timeout 可以为整个函数执行设置一个总的超时时间，提供更全面的超时控制。

2. 防止死循环或长时间计算

from func_timeout import func_set_timeout, FunctionTimedOut

@func_set_timeout(3)
def infinite_loop():
    while True:
        pass

try:
    infinite_loop()
except FunctionTimedOut:
    print("函数执行超时，可能存在死循环")

通过设置超时时间，可以有效防止函数陷入死循环或长时间计算，提升程序的健壮性。

🔚 总结

func-timeout 是一个实用的工具，能够为函数执行设置超时时间，防止程序因某些操作阻塞而影响整体运行。在使用时，需要注意其在多线程环境中的限制，以及在不同操作系统上的兼容性。合理地使用 func-timeout，可以提升程序的稳定性和用户体验。

📚 参考资料

• func-timeout 官方文档
• Python 之 func_timeout 设置函数最大超时时间
• 当线程遇到超时：用 func_timeout 优雅地说再见：这篇里面提到的并发中的超时相关问题，我后面可能也会详细介绍。总之基础使用本文都已经概括了，在更大项目中的使用细节以后再说吧。