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

536

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

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

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

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

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

Джеймс Томпсон
источник

Ответы:

787

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

Мэтт Дж
источник
13
Не могли бы вы сказать мне, почему использовать это вместо исключения KeyboardInterrupt? Разве это не более интуитивно понятно?
noio
35
Noio: 2 причины. Во-первых, SIGINT может быть отправлен в ваш процесс любым количеством способов (например, 'kill -s INT <pid>'); Я не уверен, что KeyboardInterruptException реализован как обработчик SIGINT или он действительно только перехватывает нажатия Ctrl + C, но в любом случае использование обработчика сигнала делает ваше намерение явным (по крайней мере, если ваше намерение совпадает с намерением OP). Что еще более важно, с сигналом вам не нужно оборачивать пробные уловки вокруг всего, чтобы заставить их работать, что может быть в большей или меньшей степени компоновкой и общим выигрышем в разработке программного обеспечения в зависимости от структуры вашего приложения.
Мэтт Дж
35
Пример того, почему вы хотите перехватить сигнал, а не поймать исключение. Допустим, вы запустили свою программу и перенаправили вывод в файл журнала ./program.py > output.log. Когда вы нажимаете Ctrl-C, вы хотите, чтобы ваша программа корректно завершала работу, регистрируя, что все файлы данных были очищены и помечены как чистые, чтобы подтвердить, что они остались в известном исправном состоянии. Но Ctrl-C отправляет SIGINT всем процессам в конвейере, поэтому оболочка может закрыть STDOUT (теперь «output.log»), прежде чем program.py завершит печать окончательного журнала. Python будет жаловаться: «Не удалось закрыть в деструкторе файлового объекта: Ошибка в sys.excepthook:».
Ноа Спурриер
24
Обратите внимание, что signal.pause () недоступен в Windows. docs.python.org/dev/library/signal.html
Май Оукс
10
-1 единорог для использования signal.pause (), предполагает, что мне придется ждать такого блокирующего вызова вместо какой-то реальной работы. ;)
Ник Т
177

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

import time, sys

x = 1
while True:
    try:
        print x
        time.sleep(.3)
        x += 1
    except KeyboardInterrupt:
        print "Bye"
        sys.exit()
rledley
источник
22
Внимание при использовании этого решения. Вам также следует использовать этот код перед блоком перехвата KeyboardInterrupt: signal.signal(signal.SIGINT, signal.default_int_handler)или вы потерпите неудачу, потому что KeyboardInterrupt не срабатывает в каждой ситуации, в которой он должен срабатывать! Подробности здесь .
Велда
67

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

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

Уди
источник
Он также может вызвать a, StopIterationчтобы разорвать внутренний цикл при нажатии Ctrl-C, верно?
Тео Белер
@TheoBelaire Вместо того, чтобы просто вызывать StopIteration, я бы создал генератор, который принимает итерацию в качестве параметра и регистрирует / освобождает обработчик сигнала.
Уди
28

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

Джей Конрод
источник
21

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

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

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

if __name__ == '__main__':
    try:
        main()
    except KeyboardInterrupt:
        pass
    finally:
        exit_gracefully()
Йосеф Харуш
источник
4
Вы должны использовать только для вещей, которые не должны происходить. В этом случае KeyboardInterrupt должен произойти. Так что это не очень хорошая конструкция.
Тристан
16
@TristanT На любом другом языке да, но в Python исключения не только для вещей, которые не должны происходить. На самом деле в Python считается хорошим стилем использовать исключения для управления потоком (где это уместно).
Ян Голдби
8

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

Кирилл Н.
источник
5

В отличие от Мэтта 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
Томас Девугдт
источник
Вы должны использовать событие или time.sleep()вместо выполнения занятого цикла для переменной.
OlivierM
@OlivierM Это действительно специфично для приложения и определенно не в этом примере. Например, блокировка вызовов или функции ожидания не будут загружать процессор. Кроме того, это всего лишь пример того, как все можно сделать. KeyboardInterrupts достаточно часто, как упомянуто в других ответах.
Томас Девугдт
4

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

Брэндон Э Тейлор
источник
3

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

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

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

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

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

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

Hatebit
источник