Содержание страницы
27.8. atexit – Обработчики завершения¶atexit – Exit handlers
Новое в версии 2.0.
Модуль atexit определяет единственную функцию для регистрации функций очистки. Зарегистрированные таким образом функции автоматически выполняются при нормальном завершении интерпретатора.
Примечание: функции, зарегистрированные через этот модуль, не вызываются, когда программа завершается по сигналу, когда обнаружена фатальная внутренняя ошибка Python или когда os._exit() вызывается.
Это альтернативный интерфейс к функциональности, предоставляемой переменной sys.exitfunc.
Примечание: Этот модуль вряд ли будет работать корректно при использовании с другим кодом, который устанавливает sys.exitfunc. В частности, другие основные модули Python могут свободно использовать atexit без ведома программиста. Авторам, использующим sys.exitfunc, следует преобразовать свой код для использования atexit. Самый простой способ преобразовать код, устанавливающий sys.exitfunc, – это импортировать atexit и зарегистрировать функцию, которая была привязана к sys.exitfunc.
- atexit.register(func[, *args[, **kargs]])¶
Регистрирует функцию func для выполнения при завершении. Любые необязательные аргументы, которые нужно передать func, должны быть переданы как аргументы register().
При нормальном завершении программы (например, если вызывается sys.exit() или завершается выполнение главного модуля) все зарегистрированные функции вызываются в порядке «последним пришёл – первым обслужен». Предполагается, что модули нижнего уровня обычно импортируются раньше модулей верхнего уровня и, следовательно, должны очищаться позже.
Если во время выполнения обработчиков завершения возникает исключение, выводится трассировка (если только не было возбуждено SystemExit), а информация об исключении сохраняется. После того как все обработчики завершения отработают, последнее возникшее исключение возбуждается повторно.
Изменено в версии 2.6: Теперь эта функция возвращает func, что позволяет использовать её в качестве decorator без привязки исходного имени к None.
См. также
27.8.1. atexit Пример¶atexit Example
Следующий простой пример демонстрирует, как модуль может инициализировать счётчик из файла при импорте и автоматически сохранять обновлённое значение счётчика при завершении программы, не полагаясь на явный вызов этого модуля приложением при завершении.
try:
_count = int(open("/tmp/counter").read())
except IOError:
_count = 0
def incrcounter(n):
global _count
_count = _count + n
def savecounter():
open("/tmp/counter", "w").write("%d" % _count)
import atexit
atexit.register(savecounter)
Позиционные и именованные аргументы также могут быть переданы в register() для последующей передачи зарегистрированной функции при её вызове:
def goodbye(name, adjective):
print 'Goodbye, %s, it was %s to meet you.' % (name, adjective)
import atexit
atexit.register(goodbye, 'Donny', 'nice')
# или:
atexit.register(goodbye, adjective='nice', name='Donny')
Использование в качестве декоратора:
import atexit
@atexit.register
def goodbye():
print "You are now leaving the Python sector."
Это, очевидно, работает только с функциями, которые не принимают аргументов.