Документация Python неофициальный перевод

signal.md

258 строк · 29.3 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.3/library/signal.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 18.5. [`signal`](https://python-all.ru/3.3/library/signal.html#module-signal) – Установка обработчиков для асинхронных событий89Этот модуль предоставляет механизмы для использования обработчиков сигналов в Python.1011## 18.5.1. Общие правила1213Функция [`signal.signal()`](https://python-all.ru/3.3/library/signal.html#signal.signal) позволяет определять пользовательские обработчики, которые выполняются при получении сигнала. Установлено небольшое количество обработчиков по умолчанию: `SIGPIPE` игнорируется (так что ошибки записи в каналы и сокеты могут сообщаться как обычные исключения Python), а `SIGINT` преобразуется в исключение [`KeyboardInterrupt`](https://python-all.ru/3.3/library/exceptions.html#KeyboardInterrupt).1415Обработчик конкретного сигнала после установки остаётся активным, пока его явно не сбросят (Python эмулирует интерфейс в стиле BSD независимо от базовой реализации), за исключением обработчика `SIGCHLD`, который следует базовой реализации.1617Нет способа временно «блокировать» сигналы в критических секциях (поскольку это поддерживается не во всех разновидностях Unix).1819### 18.5.1.1. Выполнение обработчиков сигналов Python2021Обработчик сигналов Python не выполняется внутри низкоуровневого (C) обработчика сигналов. Вместо этого низкоуровневый обработчик устанавливает флаг, который сообщает [*виртуальной машине*](https://python-all.ru/3.3/glossary.html#term-virtual-machine) выполнить соответствующий обработчик Python позже (например, на следующей инструкции [*байткода*](https://python-all.ru/3.3/glossary.html#term-bytecode)). Это имеет последствия:2223- Нет особого смысла перехватывать синхронные ошибки, такие как `SIGFPE` или `SIGSEGV`, вызванные недопустимой операцией в коде C. Python вернётся из обработчика сигнала в код C, который, скорее всего, снова вызовет тот же сигнал, из-за чего Python может зависнуть. Начиная с Python 3.3 можно использовать модуль [`faulthandler`](https://python-all.ru/3.3/library/faulthandler.html#module-faulthandler) для сообщения о синхронных ошибках.24- Длительное вычисление, реализованное чисто на C (например, сравнение с регулярным выражением по большому объему текста), может выполняться без прерывания сколь угодно долго, независимо от полученных сигналов. Обработчики сигналов Python будут вызваны по завершении вычисления.2526### 18.5.1.2. Сигналы и потоки2728Обработчики сигналов Python всегда выполняются в главном потоке Python, даже если сигнал был получен в другом потоке. Это означает, что сигналы нельзя использовать как средство межпоточного взаимодействия. Вместо этого можно использовать примитивы синхронизации из модуля [`threading`](https://python-all.ru/3.3/library/threading.html#module-threading).2930Кроме того, только главный поток может устанавливать новый обработчик сигнала.3132## 18.5.2. Содержание модуля3334Переменные, определённые в модуле [`signal`](https://python-all.ru/3.3/library/signal.html#module-signal):3536#### `signal.SIG_DFL`3738Это один из двух стандартных вариантов обработки сигналов; он просто выполняет действие по умолчанию для сигнала. Например, на большинстве систем действие по умолчанию для `SIGQUIT` – сбросить дамп ядра и завершиться, а для `SIGCHLD` – просто игнорировать его.3940#### `signal.SIG_IGN`4142Это еще один стандартный обработчик сигнала, который просто игнорирует данный сигнал.4344#### `SIG*`4546Все номера сигналов определены символически. Например, сигнал отбоя (hangup) определён как `signal.SIGHUP`; имена переменных совпадают с именами, используемыми в программах на C, как в `<signal.h>`. Страница руководства Unix для ‘`signal()`‘ содержит список существующих сигналов (в некоторых системах это *signal(2)*, в других список находится в *signal(7)*). Обратите внимание, что не все системы определяют один и тот же набор имён сигналов; этот модуль определяет только те имена, которые определены системой.4748#### `signal.CTRL_C_EVENT`4950Сигнал, соответствующий событию нажатия клавиш CTRL+C. Этот сигнал можно использовать только с [`os.kill()`](https://python-all.ru/3.3/library/os.html#os.kill).5152Доступность: Windows.5354Новое в версии 3.2.5556#### `signal.CTRL_BREAK_EVENT`5758Сигнал, соответствующий событию нажатия клавиш CTRL+BREAK. Этот сигнал можно использовать только с [`os.kill()`](https://python-all.ru/3.3/library/os.html#os.kill).5960Доступность: Windows.6162Новое в версии 3.2.6364#### `signal.NSIG`6566На единицу больше номера самого высокого сигнала.6768#### `signal.ITIMER_REAL`6970Уменьшает интервальный таймер в реальном времени и отправляет `SIGALRM` по истечении.7172#### `signal.ITIMER_VIRTUAL`7374Уменьшает интервальный таймер только во время выполнения процесса и отправляет SIGVTALRM по истечении.7576#### `signal.ITIMER_PROF`7778Уменьшает интервальный таймер как при выполнении процесса, так и при выполнении системой от имени процесса. В паре с ITIMER\_VIRTUAL этот таймер обычно используется для профилирования времени, затраченного приложением в пользовательском и ядерном пространстве. SIGPROF доставляется по истечении времени.7980#### `signal.SIG_BLOCK`8182Возможное значение для параметра *how* функции [`pthread_sigmask()`](https://python-all.ru/3.3/library/signal.html#signal.pthread_sigmask), указывающее, что сигналы необходимо заблокировать.8384Новое в версии 3.3.8586#### `signal.SIG_UNBLOCK`8788Возможное значение для параметра *how* функции [`pthread_sigmask()`](https://python-all.ru/3.3/library/signal.html#signal.pthread_sigmask), указывающее, что сигналы должны быть разблокированы.8990Новое в версии 3.3.9192#### `signal.SIG_SETMASK`9394Возможное значение для параметра *how* функции [`pthread_sigmask()`](https://python-all.ru/3.3/library/signal.html#signal.pthread_sigmask), указывающее, что маска сигналов должна быть заменена.9596Новое в версии 3.3.9798Модуль [`signal`](https://python-all.ru/3.3/library/signal.html#module-signal) определяет одно исключение:99100#### `exception signal.ItimerError`101102Возникает при ошибке в реализации [`setitimer()`](https://python-all.ru/3.3/library/signal.html#signal.setitimer) или [`getitimer()`](https://python-all.ru/3.3/library/signal.html#signal.getitimer). Ожидайте этой ошибки, если в [`setitimer()`](https://python-all.ru/3.3/library/signal.html#signal.setitimer) передан неверный интервальный таймер или отрицательное время. Эта ошибка является подтипом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).103104Новое в версии 3.3: Ранее это исключение было подтипом [`IOError`](https://python-all.ru/3.3/library/exceptions.html#IOError), который теперь является псевдонимом [`OSError`](https://python-all.ru/3.3/library/exceptions.html#OSError).105106Модуль [`signal`](https://python-all.ru/3.3/library/signal.html#module-signal) определяет следующие функции:107108#### `signal.alarm(time)`109110Если *time* не равно нулю, эта функция запрашивает отправку сигнала `SIGALRM` процессу через *time* секунд. Любой ранее запланированный сигнал отменяется (в любой момент времени может быть запланирован только один сигнал). Возвращаемое значение – количество секунд до момента, когда должен был быть доставлен любой ранее установленный сигнал. Если *time* равно нулю, сигнал не планируется, а любой запланированный отменяется. Если возвращаемое значение равно нулю, сигнал в данный момент не запланирован. (См. man-страницу Unix *alarm(2)*.) Доступность: Unix.111112#### `signal.getsignal(signalnum)`113114Возвращает текущий обработчик сигнала для сигнала *signalnum*. Возвращаемое значение может быть вызываемым объектом Python или одним из специальных значений: [`signal.SIG_IGN`](https://python-all.ru/3.3/library/signal.html#signal.SIG_IGN), [`signal.SIG_DFL`](https://python-all.ru/3.3/library/signal.html#signal.SIG_DFL) или [`None`](https://python-all.ru/3.3/library/constants.html#None). Здесь [`signal.SIG_IGN`](https://python-all.ru/3.3/library/signal.html#signal.SIG_IGN) означает, что сигнал ранее игнорировался, [`signal.SIG_DFL`](https://python-all.ru/3.3/library/signal.html#signal.SIG_DFL) означает, что ранее использовался способ обработки сигнала по умолчанию, а `None` означает, что предыдущий обработчик сигнала не был установлен из Python.115116#### `signal.pause()`117118Заставляет процесс спать до получения сигнала; затем будет вызван соответствующий обработчик. Ничего не возвращает. Недоступно в Windows. (См. страницу руководства Unix *signal(2)*.)119120См. также [`sigwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigwait), [`sigwaitinfo()`](https://python-all.ru/3.3/library/signal.html#signal.sigwaitinfo), [`sigtimedwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigtimedwait) и [`sigpending()`](https://python-all.ru/3.3/library/signal.html#signal.sigpending).121122#### `signal.pthread_kill(thread_id, signum)`123124Отправляет сигнал *signum* потоку *thread\_id*, другому потоку в том же процессе, что и вызывающий. Целевой поток может выполнять любой код (Python или нет). Однако если целевой поток выполняет интерпретатор Python, обработчики сигналов Python будут [*выполнены главным потоком*](https://python-all.ru/3.3/library/signal.html#signals-and-threads). Поэтому единственный смысл отправки сигнала конкретному потоку Python – заставить выполняющийся системный вызов завершиться с ошибкой [`InterruptedError`](https://python-all.ru/3.3/library/exceptions.html#InterruptedError).125126Используйте [`threading.get_ident()`](https://python-all.ru/3.3/library/threading.html#threading.get_ident) или атрибут [`ident`](https://python-all.ru/3.3/library/threading.html#threading.Thread.ident) объектов [`threading.Thread`](https://python-all.ru/3.3/library/threading.html#threading.Thread), чтобы получить подходящее значение для *thread\_id*.127128Если *signum* равно 0, сигнал не отправляется, но проверка ошибок всё равно выполняется; это можно использовать для проверки, работает ли целевой поток до сих пор.129130Доступность: Unix (см. страницу руководства *pthread\_kill(3)* для получения дополнительной информации).131132См. также [`os.kill()`](https://python-all.ru/3.3/library/os.html#os.kill).133134Новое в версии 3.3.135136#### `signal.pthread_sigmask(how, mask)`137138Получает и/или изменяет маску сигналов вызывающего потока. Маска сигналов – это набор сигналов, доставка которых в настоящий момент заблокирована для вызывающей стороны. Возвращает старую маску сигналов в виде набора сигналов.139140Поведение вызова зависит от значения *how* следующим образом.141142- [`SIG_BLOCK`](https://python-all.ru/3.3/library/signal.html#signal.SIG_BLOCK): набор блокируемых сигналов является объединением текущего набора и аргумента *mask*.143- [`SIG_UNBLOCK`](https://python-all.ru/3.3/library/signal.html#signal.SIG_UNBLOCK): сигналы из *mask* удаляются из текущего набора блокируемых сигналов. Допускается попытка разблокировать сигнал, который не был заблокирован.144- [`SIG_SETMASK`](https://python-all.ru/3.3/library/signal.html#signal.SIG_SETMASK): набор блокируемых сигналов устанавливается равным аргументу *mask*.145146*mask* – это набор номеров сигналов (например, {`signal.SIGINT`, `signal.SIGTERM`}). Используйте `range(1, signal.NSIG)` для полной маски, включающей все сигналы.147148Например, `signal.pthread_sigmask(signal.SIG_BLOCK, [])` читает маску сигналов вызывающего потока.149150Доступность: Unix. См. страницы руководства *sigprocmask(3)* и *pthread\_sigmask(3)* для получения дополнительной информации.151152См. также [`pause()`](https://python-all.ru/3.3/library/signal.html#signal.pause), [`sigpending()`](https://python-all.ru/3.3/library/signal.html#signal.sigpending) и [`sigwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigwait).153154Новое в версии 3.3.155156#### `signal.setitimer(which, seconds[, interval])`157158Устанавливает заданный интервальный таймер (один из [`signal.ITIMER_REAL`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_REAL), [`signal.ITIMER_VIRTUAL`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_VIRTUAL) или [`signal.ITIMER_PROF`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_PROF)), указанный *which*, чтобы он сработал через *seconds* (принимается число с плавающей запятой, в отличие от [`alarm()`](https://python-all.ru/3.3/library/signal.html#signal.alarm)) и после этого каждые *interval* секунд. Интервальный таймер, указанный *which*, можно сбросить, установив seconds в ноль.159160Когда интервальный таймер срабатывает, процессу отправляется сигнал. Отправляемый сигнал зависит от используемого таймера; [`signal.ITIMER_REAL`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_REAL) доставляет `SIGALRM`, [`signal.ITIMER_VIRTUAL`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_VIRTUAL) отправляет `SIGVTALRM`, а [`signal.ITIMER_PROF`](https://python-all.ru/3.3/library/signal.html#signal.ITIMER_PROF) доставляет `SIGPROF`.161162Старые значения возвращаются в виде кортежа: (delay, interval).163164Попытка передать недопустимый интервальный таймер вызовет [`ItimerError`](https://python-all.ru/3.3/library/signal.html#signal.ItimerError). Доступность: Unix.165166#### `signal.getitimer(which)`167168Возвращает текущее значение указанного интервального таймера, заданного через *which*. Доступность: Unix.169170#### `signal.set_wakeup_fd(fd)`171172Устанавливает дескриптор файла пробуждения в *fd*. Когда сигнал получен, номер сигнала записывается в fd как один байт. Это может быть использовано библиотекой для пробуждения вызова poll или select, позволяя полностью обработать сигнал.173174Возвращается старый дескриптор пробуждения. *fd* должен быть неблокирующим. Библиотека должна удалить все байты перед повторным вызовом poll или select.175176Используйте, например, `struct.unpack('%uB' % len(data), data)` для декодирования списка номеров сигналов.177178Когда потоки включены, эту функцию можно вызывать только из основного потока; попытка вызова из других потоков приведёт к возникновению исключения [`ValueError`](https://python-all.ru/3.3/library/exceptions.html#ValueError).179180#### `signal.siginterrupt(signalnum, flag)`181182Изменяет поведение перезапуска системных вызовов: если *flag* равно [`False`](https://python-all.ru/3.3/library/constants.html#False), системные вызовы будут перезапущены при прерывании сигналом *signalnum*, в противном случае системные вызовы будут прерваны. Ничего не возвращает. Доступность: Unix (см. man-страницу *siginterrupt(3)* для получения дополнительной информации).183184Обратите внимание, что установка обработчика сигнала с помощью [`signal()`](https://python-all.ru/3.3/library/signal.html#module-signal) сбросит поведение перезапуска на прерываемое, неявно вызывая `siginterrupt()` со значением *flag*, равным true, для данного сигнала.185186#### `signal.signal(signalnum, handler)`187188Устанавливает обработчик сигнала *signalnum* как функцию *handler*. *handler* может быть вызываемым объектом Python, принимающим два аргумента (см. ниже), или одним из специальных значений [`signal.SIG_IGN`](https://python-all.ru/3.3/library/signal.html#signal.SIG_IGN) или [`signal.SIG_DFL`](https://python-all.ru/3.3/library/signal.html#signal.SIG_DFL). Ранее установленный обработчик сигнала будет возвращён (см. описание [`getsignal()`](https://python-all.ru/3.3/library/signal.html#signal.getsignal) выше). (См. страницу руководства Unix *signal(2)*.)189190Когда потоки включены, эту функцию можно вызывать только из основного потока; попытка вызова из других потоков приведёт к возникновению исключения [`ValueError`](https://python-all.ru/3.3/library/exceptions.html#ValueError).191192*handler* вызывается с двумя аргументами: номером сигнала и текущим стековым кадром (`None` или объект кадра; описание объектов кадра см. в [*описании иерархии типов*](https://python-all.ru/3.3/reference/datamodel.html#frame-objects) или в описаниях атрибутов в модуле [`inspect`](https://python-all.ru/3.3/library/inspect.html#module-inspect)).193194В Windows [`signal()`](https://python-all.ru/3.3/library/signal.html#module-signal) можно вызывать только с `SIGABRT`, `SIGFPE`, `SIGILL`, `SIGINT`, `SIGSEGV` или `SIGTERM`. В любом другом случае будет вызвано [`ValueError`](https://python-all.ru/3.3/library/exceptions.html#ValueError).195196#### `signal.sigpending()`197198Проверяет набор сигналов, ожидающих доставки вызывающему потоку (т.е. сигналы, которые были подняты, пока были заблокированы). Возвращает набор ожидающих сигналов.199200Доступность: Unix (см. страницу руководства *sigpending(2)* для получения дополнительной информации).201202См. также [`pause()`](https://python-all.ru/3.3/library/signal.html#signal.pause), [`pthread_sigmask()`](https://python-all.ru/3.3/library/signal.html#signal.pthread_sigmask) и [`sigwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigwait).203204Новое в версии 3.3.205206#### `signal.sigwait(sigset)`207208Приостанавливает выполнение вызывающего потока до доставки одного из сигналов, указанных в наборе сигналов *sigset*. Функция принимает сигнал (удаляет его из списка ожидающих сигналов) и возвращает номер сигнала.209210Доступность: Unix (см. страницу руководства *sigwait(3)* для получения дополнительной информации).211212См. также [`pause()`](https://python-all.ru/3.3/library/signal.html#signal.pause), [`pthread_sigmask()`](https://python-all.ru/3.3/library/signal.html#signal.pthread_sigmask), [`sigpending()`](https://python-all.ru/3.3/library/signal.html#signal.sigpending), [`sigwaitinfo()`](https://python-all.ru/3.3/library/signal.html#signal.sigwaitinfo) и [`sigtimedwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigtimedwait).213214Новое в версии 3.3.215216#### `signal.sigwaitinfo(sigset)`217218Приостанавливает выполнение вызывающего потока до поступления одного из сигналов, указанных в наборе сигналов *sigset*. Функция принимает сигнал и удаляет его из списка ожидающих сигналов. Если один из сигналов в *sigset* уже ожидает обработки в вызывающем потоке, функция немедленно вернётся с информацией об этом сигнале. Обработчик сигнала для доставленного сигнала не вызывается. Функция вызывает исключение [`InterruptedError`](https://python-all.ru/3.3/library/exceptions.html#InterruptedError), если она была прервана сигналом, не входящим в *sigset*.219220Возвращаемое значение – объект, представляющий данные, содержащиеся в структуре `siginfo_t`, а именно: `si_signo`, `si_code`, `si_errno`, `si_pid`, `si_uid`, `si_status`, `si_band`.221222Доступность: Unix (см. страницу руководства *sigwaitinfo(2)* для получения дополнительной информации).223224См. также [`pause()`](https://python-all.ru/3.3/library/signal.html#signal.pause), [`sigwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigwait) и [`sigtimedwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigtimedwait).225226Новое в версии 3.3.227228#### `signal.sigtimedwait(sigset, timeout)`229230Как и [`sigwaitinfo()`](https://python-all.ru/3.3/library/signal.html#signal.sigwaitinfo), но принимает дополнительный аргумент *timeout*, задающий тайм-аут. Если *timeout* указан как `0`, выполняется опрос. Возвращает [`None`](https://python-all.ru/3.3/library/constants.html#None), если произошёл тайм-аут.231232Доступно: Unix (см. man-страницу *sigtimedwait(2)* для получения дополнительной информации).233234См. также [`pause()`](https://python-all.ru/3.3/library/signal.html#signal.pause), [`sigwait()`](https://python-all.ru/3.3/library/signal.html#signal.sigwait) и [`sigwaitinfo()`](https://python-all.ru/3.3/library/signal.html#signal.sigwaitinfo).235236Новое в версии 3.3.237238## 18.5.3. Пример239240Вот минимальный пример программы. В ней используется функция [`alarm()`](https://python-all.ru/3.3/library/signal.html#signal.alarm) для ограничения времени ожидания открытия файла; это полезно, если файл относится к последовательному устройству, которое может быть выключено, и обычно это приводит к тому, что [`os.open()`](https://python-all.ru/3.3/library/os.html#os.open) зависает на неопределённый срок. Решение – установить 5-секундный будильник перед открытием файла; если операция займёт слишком много времени, будет отправлен сигнал будильника, и обработчик вызовет исключение.241242```python243import signal, os244245def handler(signum, frame):246    print('Signal handler called with signal', signum)247    raise OSError("Couldn't open device!")248249# Установить обработчик сигнала и 5-секундный будильник250signal.signal(signal.SIGALRM, handler)251signal.alarm(5)252253# Этот вызов open() может зависнуть навсегда254fd = os.open('/dev/ttyS0', os.O_RDWR)255256signal.alarm(0)          # Отключить будильник257```258