funcguard 0.1.5

FuncGuard是一个Python库，提供函数执行超时控制、重试机制、HTTP请求封装和格式化打印工具。

FuncGuard

FuncGuard是一个Python库，提供了函数执行超时控制和重试机制的实用工具。

功能特点

• 函数执行超时控制
• 函数执行失败自动重试
• HTTP请求封装（支持自动重试）
• 格式化打印工具（分隔线和块打印）
• 时间日志记录和耗时统计

安装/升级

pip install --upgrade funcguard

使用方法

超时控制

使用timeout_handler函数可以控制函数的执行时间，防止函数运行时间过长：

from funcguard import timeout_handler

def long_running_function():
    # 模拟一个耗时操作
    import time
    time.sleep(10)
    return "操作完成"

try:
    # 设置超时时间为5秒
    result = timeout_handler(long_running_function, execution_timeout=5)
    print(result)
except TimeoutError as e:
    print(f"捕获到超时错误: {e}")

重试机制

使用retry_function函数可以在函数执行失败时自动重试：

from funcguard import retry_function

def unstable_function():
    # 模拟一个可能失败的操作
    import random
    if random.random() < 0.7:  # 70%的概率失败
        raise Exception("随机错误")
    return "操作成功"

try:
    # 最多重试3次，每次执行超时时间为10秒
    result = retry_function(unstable_function, max_retries=3, execute_timeout=10, task_name="测试任务")
    print(result)
except Exception as e:
    print(f"重试后仍然失败: {e}")

HTTP请求

使用send_request函数发送HTTP请求，支持自动重试：

from funcguard import send_request

# 不使用重试
response = send_request(
    method="GET",
    url="https://api.example.com/data",
    headers={"Content-Type": "application/json"},
    timeout=30
)
print(response)

# 使用重试
response = send_request(
    method="POST",
    url="https://api.example.com/data",
    headers={"Content-Type": "application/json"},
    data={"key": "value"},
    timeout=30,
    auto_retry={
        "task_name": "API请求",
        "max_retries": 3,
        "execute_timeout": 60
    }
)
print(response)

格式化打印

使用print_line和print_block函数进行格式化打印，便于查看和调试：

from funcguard import print_line, print_block

# 打印分隔线
print_line()  # 默认使用40个'-'字符
print_line("*", 30)  # 使用30个'*'字符

# 打印块内容
print_block("用户信息", {"name": "张三", "age": 25})

# 自定义分隔符
print_block("配置信息", {"debug": True, "port": 8080}, "=", 50)

# 打印复杂内容
result = {
    "status": "success",
    "data": [1, 2, 3, 4, 5],
    "message": "操作完成"
}
print_block("API响应", result)

时间日志记录

使用time_log和time_diff函数记录任务执行时间和统计信息：

from funcguard import time_log, time_diff

# 获取开始时间
start_time = time_diff()

# 记录任务开始（i从0开始）
time_log("开始处理数据", 0, 100, 0, start_time)

# 模拟处理过程
import time
for i in range(1, 101):
    time.sleep(0.1)  # 模拟处理时间
    if i % 20 == 0:
        time_log(f"处理进度", i, 100, 0, start_time)  # 显示进度和预计完成时间

# 记录任务完成并打印统计信息
time_log("数据处理完成", 100, 100, 0, start_time)
time_diff(start_time, 100, "cn")  # 中文显示统计信息

或者当i从1开始时：

from funcguard import time_log, time_diff

# 获取开始时间
start_time = time_diff()

# 记录任务开始（i从1开始）
time_log("开始处理数据", 1, 100, 1, start_time)

# 模拟处理过程
import time
for i in range(1, 101):
    time.sleep(0.1)  # 模拟处理时间
    if i % 20 == 0:
        time_log(f"处理进度", i, 100, 1, start_time)  # 显示进度和预计完成时间

# 记录任务完成并打印统计信息
time_log("数据处理完成", 100, 100, 1, start_time)
time_diff(start_time, 100, "cn")  # 中文显示统计信息

时间日志功能特点：

• 自动显示北京时间（UTC+8）
• 支持进度显示和预计完成时间计算
• 提供中英文双语统计信息
• 可显示总耗时、平均耗时等详细统计
• 支持i从0或从1开始的计数方式

API文档

funcguard.core

timeout_handler(func, args=(), kwargs=None, execution_timeout=90)

• 参数:
  • func: 需要执行的目标函数
  • args: 目标函数的位置参数，默认为空元组
  • kwargs: 目标函数的关键字参数，默认为None
  • execution_timeout: 函数执行的超时时间，单位为秒，默认为90秒
• 返回值: 目标函数的返回值
• 异常: TimeoutError - 当函数执行超过指定时间时抛出

retry_function(func, max_retries=5, execute_timeout=90, task_name="", *args, **kwargs)

• 参数:
  • func: 需要重试的函数
  • max_retries: 最大重试次数，默认为5
  • execute_timeout: 执行超时时间，默认为90秒
  • task_name: 任务名称，用于打印日志
  • args: func的位置参数
  • kwargs: func的关键字参数
• 返回值: func的返回值
• 异常: 当重试次数用尽后仍然失败时，抛出最后一次的异常

funcguard.tools

send_request(method, url, headers, data=None, return_type="json", timeout=60, auto_retry=None)

• 参数:
  • method: HTTP方法（GET, POST等）
  • url: 请求URL
  • headers: 请求头
  • data: 请求数据，默认为None
  • return_type: 返回类型，可选"json"、"response"或"text"，默认为"json"
  • timeout: 请求超时时间，单位为秒，默认为60
  • auto_retry: 自动重试配置，格式为{"task_name": "", "max_retries": 5, "execute_timeout": 90}，默认为None
• 返回值: 根据return_type参数返回不同格式的响应数据
• 异常: 当请求失败且重试次数用尽后，抛出相应的异常

time_log(message, i=0, max_num=0, start_from=0, s_time=None)

• 参数:
  • message: 日志消息
  • i: 当前进度，默认为0
  • max_num: 总进度数量，默认为0
  • start_from: i是否从0开始，0表示从0开始，1表示从1开始，默认为0
  • s_time: 开始时间，用于计算预计完成时间，默认为None
• 返回值: 无
• 功能: 打印带时间戳的日志信息，支持进度显示和预计完成时间计算

time_diff(s_time=None, max_num=0, language="cn")

• 参数:
  • s_time: 开始时间，默认为None
  • max_num: 任务数量，默认为0
  • language: 语言选择（"cn"中文，其他为英文），默认为"cn"
• 返回值: 如果s_time为None则返回当前时间，否则返回None
• 功能: 计算并打印任务执行时间统计信息，支持中英文双语输出

funcguard.printer

print_line(separator_char: str = "-", separator_length: int = 40) -> None

• 参数:
  • separator_char: 分隔符字符，默认为'-'
  • separator_length: 分隔符长度，默认为40
• 返回值: 无
• 功能: 打印分隔线，用于分隔不同的打印块

print_block(title: str, content: Any, separator_char: str = "-", separator_length: int = 40) -> None

• 参数:
  • title: 标题
  • content: 打印的内容
  • separator_char: 分隔符字符，默认为'-'
  • separator_length: 分隔符长度，默认为40
• 返回值: 无
• 功能: 使用分隔符打印标题和内容，便于查看

许可证

MIT License