如何在 Python 中捕獲 SIGINT？

Question

我正在開發一個啟動多個進程和數據庫連接的 python 腳本。 我時不時地想用Ctrl + C信號終止腳本，並且我想做一些清理工作。

在 Perl 中，我會這樣做：

$SIG{'INT'} = 'exit_gracefully';

sub exit_gracefully {
    print "Caught ^C \n";
    exit (0);
}

我如何在 Python 中模擬這個？

Answer 1

像這樣使用signal.signal注冊您的處理程序：

#!/usr/bin/env python
import signal
import sys

def signal_handler(sig, frame):
    print('You pressed Ctrl+C!')
    sys.exit(0)

signal.signal(signal.SIGINT, signal_handler)
print('Press Ctrl+C')
signal.pause()

從這里改編的代碼。

可以在此處找到有關signal更多文檔。

Answer 2

您可以像對待任何其他異常一樣將其視為異常 (KeyboardInterrupt)。 創建一個新文件並使用以下內容從您的 shell 運行它以了解我的意思：

import time, sys

x = 1
while True:
    try:
        print x
        time.sleep(.3)
        x += 1
    except KeyboardInterrupt:
        print "Bye"
        sys.exit()

Answer 3

作為上下文管理器：

import signal

class GracefulInterruptHandler(object):

    def __init__(self, sig=signal.SIGINT):
        self.sig = sig

    def __enter__(self):

        self.interrupted = False
        self.released = False

        self.original_handler = signal.getsignal(self.sig)

        def handler(signum, frame):
            self.release()
            self.interrupted = True

        signal.signal(self.sig, handler)

        return self

    def __exit__(self, type, value, tb):
        self.release()

    def release(self):

        if self.released:
            return False

        signal.signal(self.sig, self.original_handler)

        self.released = True

        return True

使用：

with GracefulInterruptHandler() as h:
    for i in xrange(1000):
        print "..."
        time.sleep(1)
        if h.interrupted:
            print "interrupted!"
            time.sleep(2)
            break

嵌套處理程序：

with GracefulInterruptHandler() as h1:
    while True:
        print "(1)..."
        time.sleep(1)
        with GracefulInterruptHandler() as h2:
            while True:
                print "\t(2)..."
                time.sleep(1)
                if h2.interrupted:
                    print "\t(2) interrupted!"
                    time.sleep(2)
                    break
        if h1.interrupted:
            print "(1) interrupted!"
            time.sleep(2)
            break

從這里： https : //gist.github.com/2907502

Answer 4

您可以通過捕獲KeyboardInterrupt異常來處理CTRL + C。 您可以在異常處理程序中實現任何清理代碼。

Answer 5

另一個片段

將main作為主函數， exit_gracefully作為CTRL + c處理程序

if __name__ == '__main__':
    try:
        main()
    except KeyboardInterrupt:
        pass
    finally:
        exit_gracefully()

Answer 6

來自 Python 的文檔：

import signal
import time

def handler(signum, frame):
    print 'Here you go'

signal.signal(signal.SIGINT, handler)

time.sleep(10) # Press Ctrl+c here

Answer 7

我改編了@udi 的代碼以支持多個信號（沒什么特別的）：

class GracefulInterruptHandler(object):
    def __init__(self, signals=(signal.SIGINT, signal.SIGTERM)):
        self.signals = signals
        self.original_handlers = {}

    def __enter__(self):
        self.interrupted = False
        self.released = False

        for sig in self.signals:
            self.original_handlers[sig] = signal.getsignal(sig)
            signal.signal(sig, self.handler)

        return self

    def handler(self, signum, frame):
        self.release()
        self.interrupted = True

    def __exit__(self, type, value, tb):
        self.release()

    def release(self):
        if self.released:
            return False

        for sig in self.signals:
            signal.signal(sig, self.original_handlers[sig])

        self.released = True
        return True

此代碼支持鍵盤中斷調用 ( SIGINT ) 和SIGTERM ( kill <process> )

Answer 8

與Matt J的回答相反，我使用了一個簡單的對象。 這使我有可能將此處理程序解析為需要停止安全的所有線程。

class SIGINT_handler():
    def __init__(self):
        self.SIGINT = False

    def signal_handler(self, signal, frame):
        print('You pressed Ctrl+C!')
        self.SIGINT = True


handler = SIGINT_handler()
signal.signal(signal.SIGINT, handler.signal_handler)

別處

while True:
    # task
    if handler.SIGINT:
        break

Answer 9

如果您想確保您的清理過程完成，我會通過使用SIG_IGN來添加Matt J 的答案，以便忽略進一步的SIGINT ，這將防止您的清理被中斷。

import signal
import sys

def signal_handler(signum, frame):
    signal.signal(signum, signal.SIG_IGN) # ignore additional signals
    cleanup() # give your process a chance to clean up
    sys.exit(0)

signal.signal(signal.SIGINT, signal_handler) # register the signal with the signal handler first
do_stuff()

Answer 10

您可以使用 Python 內置信號模塊中的函數在 Python 中設置信號處理程序。 具體來說， signal.signal(signalnum, handler)函數用於為信號signalnum注冊handler函數。

Answer 11

感謝現有答案，但添加了signal.getsignal()

import signal

# store default handler of signal.SIGINT
default_handler = signal.getsignal(signal.SIGINT)
catch_count = 0

def handler(signum, frame):
    global default_handler, catch_count
    catch_count += 1
    print ('wait:', catch_count)
    if catch_count > 3:
        # recover handler for signal.SIGINT
        signal.signal(signal.SIGINT, default_handler)
        print('expecting KeyboardInterrupt')

signal.signal(signal.SIGINT, handler)
print('Press Ctrl+c here')

while True:
    pass

Answer 12

就個人而言，我無法使用 try/except KeyboardInterrupt，因為我使用的是阻塞的標准套接字 (IPC) 模式。 所以 SIGINT 被提示，但只有在套接字上接收到數據后才出現。

設置信號處理程序的行為相同。

另一方面，這僅適用於實際終端。 其他起始環境可能不接受Ctrl + C或預先處理信號。

此外，Python 中有“Exceptions”和“BaseExceptions”，它們的不同之處在於解釋器需要自己干凈地退出，因此某些異常的優先級高於其他異常（Exceptions 派生自 BaseException）