1.code 展示 | KWAN的解忧杂货铺

# 1.code 展示

def _register_signal_handlers(reporter: ProgressReporter):
    import signal

    def handle_signal(signum, _):
        # Handle the signal here
        reporter.info(f"Received signal {signum}, exiting...")
        reporter.dispose()
        for task in asyncio.all_tasks():
            task.cancel()
        reporter.info("All tasks cancelled. Exiting...")

    # Register signal handlers for SIGINT and SIGHUP
    signal.signal(signal.SIGINT, handle_signal)

    if sys.platform != "win32":
        signal.signal(signal.SIGHUP, handle_signal)

    def trigger_signal(signum):
        reporter.info(f"Triggering signal {signum} manually...")
        signal.raise_signal(signum)

    return trigger_signal

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 2.代码说明

这段 Python 代码定义了一个名为 _register_signal_handlers 的函数，其主要作用是注册信号处理程序，以便在接收到特定信号时执行一些清理工作，并优雅地退出程序。这个函数是异步编程环境中的一个实用工具，尤其是在需要处理长时间运行的任务时。下面是对代码的详细解释和分析。

# 3.代码解释

函数定义:
- _register_signal_handlers(reporter: ProgressReporter): 这个函数接受一个参数 reporter，它是一个 ProgressReporter 类型的对象，用于报告进度和日志信息。
导入模块:
- import signal: 导入 Python 的 signal 模块，该模块提供了处理操作系统信号的方式。
信号处理函数:
- def handle_signal(signum, _): 定义了一个内部函数 handle_signal，用于处理接收到的信号。参数 signum 表示接收到的信号编号。
信号处理逻辑:
- reporter.info(f"Received signal {signum}, exiting..."): 当接收到信号时，使用 reporter 对象记录一条信息，表明接收到了信号，并准备退出。
- reporter.dispose(): 调用 reporter 对象的 dispose 方法，这可能是一个清理资源的方法，尽管在代码中没有具体实现。
- for task in asyncio.all_tasks(): task.cancel(): 遍历当前所有异步任务，并调用它们的 cancel 方法来取消这些任务。这是确保程序可以优雅退出的重要步骤。
- reporter.info("All tasks cancelled. Exiting..."): 再次记录一条信息，表明所有任务都已取消，程序即将退出。
注册信号处理程序:
- signal.signal(signal.SIGINT, handle_signal): 为 SIGINT 信号（通常由 Ctrl+C 触发）注册 handle_signal 函数作为处理程序。
- if sys.platform != "win32": signal.signal(signal.SIGHUP, handle_signal): 如果当前平台不是 Windows，为 SIGHUP 信号（通常在终端关闭时发送）注册 handle_signal 函数。Windows 平台不使用 SIGHUP 信号。
手动触发信号:
- def trigger_signal(signum): 定义了一个内部函数 trigger_signal，用于手动触发指定的信号。
- signal.raise_signal(signum): 使用 signal.raise_signal 函数来手动触发一个信号。
返回值:
- return trigger_signal: 函数返回 trigger_signal 函数，允许在外部手动触发信号。

# 4.作用与应用场景

这段代码的主要作用是在异步编程环境中提供一个机制，以便在接收到操作系统信号时能够优雅地处理和退出程序。这在长时间运行的服务或后台任务中尤其重要，因为它们可能涉及到多个异步操作和资源管理。

# 5.应用场景举例

Web 服务器: 在一个基于异步框架（如 FastAPI 或 Sanic）的 Web 服务器中，使用这段代码可以确保在接收到停止信号时，服务器能够优雅地关闭，完成所有正在进行的请求，并释放资源。
定时任务: 在使用 asyncio 执行定时任务的应用程序中，这段代码可以帮助在需要停止任务时，安全地取消所有挂起的任务。
长时间运行的数据处理任务: 对于需要长时间运行并处理大量数据的异步任务，这段代码可以确保在任务被中断时，所有的资源都被正确地释放，数据被安全地保存。

← 05-类