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

atexit – Обработчики выходаatexit – Exit handlers

Модуль atexit определяет функции для регистрации и отмены регистрации функций очистки. Зарегистрированные таким образом функции автоматически выполняются при нормальном завершении интерпретатора.

Примечание: функции, зарегистрированные через этот модуль, не вызываются, когда программа завершается по сигналу, когда обнаружена фатальная внутренняя ошибка Python или когда os._exit() вызывается.

atexit.register(func[, *args[, **kargs]])

Регистрирует функцию func для выполнения при завершении. Любые необязательные аргументы, которые нужно передать func, должны быть переданы как аргументы register().

При нормальном завершении программы (например, если вызывается sys.exit() или завершается выполнение главного модуля) все зарегистрированные функции вызываются в порядке «последним пришёл – первым обслужен». Предполагается, что модули нижнего уровня обычно импортируются раньше модулей верхнего уровня и, следовательно, должны очищаться позже.

Если во время выполнения обработчиков завершения возникает исключение, выводится трассировка (если только не было возбуждено SystemExit), а информация об исключении сохраняется. После того как все обработчики завершения отработают, последнее возникшее исключение возбуждается повторно.

Эта функция возвращает func, что позволяет использовать её в качестве декоратора без привязки исходного имени к None.

atexit.unregister(func)
Удаляет функцию func из списка функций для выполнения при завершении работы интерпретатора. После вызова unregister() гарантируется, что func не будет вызвана при остановке интерпретатора.

См. также

Модуль readline
Полезный пример использования atexit для чтения и записи readline файлов истории.

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.")

Это, очевидно, работает только с функциями, которые не принимают аргументов.