Как мне захватить SIGINT в Python?

Я работаю над сценарием Python, который запускает несколько процессов и соединений с базой данных. Время от времени я хочу убить скрипт с помощью сигнала Ctrl+C, и я хотел бы сделать некоторую очистку.

В Perl я бы сделал это:

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

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

Как мне сделать аналог этого в Python?

13 ответов

Решение

Зарегистрируйте ваш обработчик 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 можно найти здесь.

Вы можете рассматривать это как исключение (KeyboardInterrupt), как и любое другое. Создайте новый файл и запустите его из вашей оболочки со следующим содержимым, чтобы понять, что я имею в виду:

import time, sys

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

И как менеджер контекста:

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

Вы можете справиться с CTRL+C, поймав KeyboardInterrupt исключение. Вы можете реализовать любой код очистки в обработчике исключений.

Еще один фрагмент

Приглашение main в качестве основной функции и exit_gracefully как обработчик CTRL + c

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

Из документации 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

Если вы хотите, чтобы ваш процесс очистки завершился, я бы добавил к ответу Мэтта Дж., Используя SIG_IGN, чтобы в дальнейшем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()

Я адаптировал код из @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>)

В отличие от Мэтта 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

Вы можете использовать функции во встроенном сигнальном модуле Python для настройки обработчиков сигналов в Python. В частности, signal.signal(signalnum, handler) функция используется для регистрации handler функция для сигнала signalnum,

Спасибо за существующие ответы, но добавил 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

Вот однострочный код (без импорта), протестированный на Python 3.10 (насчет других версий не уверен):

      #!/usr/bin/env python3
from signal import SIGINT, SIGTERM, sigwait


print('received', sigwait({SIGINT, SIGTERM}))

Хотя поведение будет забавным, если вы отправите другой сигнал, например USR1, перед INT/TERM. sigwait будет ждать INT/TERM, но не выведет строку «полученный {сигнал}», как ожидалось.

      $ ./test.py # ctrl + c
^Creceived Signals.SIGINT

$ ./test.py # kill -TERM <pid>
received Signals.SIGTERM

$ ./test.py # kill -USR1 <pid> ; kill -TERM <pid>
User defined signal 1: 30

Лично я не мог использовать try/ кроме KeyboardInterrupt, потому что я использовал стандартный режим сокета (IPC), который блокирует. Таким образом, SIGINT был задан, но пришел только после получения данных на сокете.

Установка обработчика сигнала ведет себя так же.

С другой стороны, это работает только для реального терминала. Другие стартовые среды могут не принять Ctrl+C или предварительно обработать сигнал.

Кроме того, в Python есть "Исключения" и "BaseExceptions", которые отличаются в том смысле, что интерпретатору необходимо завершить работу самостоятельно, поэтому некоторые исключения имеют более высокий приоритет, чем другие (исключения получены из BaseException)

Другие вопросы по тегам