atexit — Обробники виходу

---

Модуль atexit визначає функції для реєстрації та скасування реєстрації функцій очищення. Зареєстровані таким чином функції автоматично виконуються після звичайного завершення роботи інтерпретатора. atexit запускає ці функції у зворотному порядку, у якому вони були зареєстровані; якщо ви зареєструєте A, B і C, під час завершення роботи інтерпретатора вони виконуватимуться в порядку C, B, A .

Примітка: Функції, зареєстровані за допомогою цього модуля, не викликаються, коли програма припиняється через сигнал, який не оброблюється Python, коли виявлено критичну внутрішню помилку Python або коли викликається os._exit().

Note: The effect of registering or unregistering functions from within a cleanup function is undefined.

Змінено в версії 3.7: При використанні з субінтерпретаторами C-API зареєстровані функції є локальними для інтерпретатора, у якому вони були зареєстровані.

atexit.register(func, *args, **kwargs)

Зареєструйте func як функцію, яка буде виконуватися після завершення. Будь-які необов’язкові аргументи, які мають бути передані в func, повинні бути передані як аргументи в register(). Є можливість зареєструвати ту саму функцію та аргументи кілька разів.

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

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

Ця функція повертає func, що дає змогу використовувати її як декоратор.

Попередження

Starting new threads or calling os.fork() from a registered function can lead to race condition between the main Python runtime thread freeing thread states while internal threading routines or the new process try to use that state. This can lead to crashes rather than clean shutdown.

Змінено в версії 3.12: Attempts to start a new thread or os.fork() a new process in a registered function now leads to RuntimeError.

atexit.unregister(func)

Видаліть func зі списку функцій, які будуть запускатися після завершення роботи інтерпретатора. unregister() мовчки нічого не робить, якщо func не було раніше зареєстровано. Якщо func було зареєстровано кілька разів, кожне входження цієї функції в стек викликів atexit буде видалено. Порівняння рівності (==) використовуються внутрішньо під час скасування реєстрації, тому посилання на функції не повинні мати відповідні ідентифікатори.

Дивись також

Модуль readline

Корисний приклад atexit для читання та запису файлів історії readline.

atexit Приклад

Наступний простий приклад демонструє, як модуль може ініціалізувати лічильник із файлу під час його імпорту та автоматично зберігати оновлене значення лічильника, коли програма завершує роботу, не покладаючись на те, що програма здійснює явний виклик цього модуля під час завершення.

try:
    with open('counterfile') as infile:
        _count = int(infile.read())
except FileNotFoundError:
    _count = 0

def incrcounter(n):
    global _count
    _count = _count + n

def savecounter():
    with open('counterfile', 'w') as outfile:
        outfile.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')
# or:
atexit.register(goodbye, adjective='nice', name='Donny')

Використання як decorator:

import atexit

@atexit.register
def goodbye():
    print('You are now leaving the Python sector.')

Це працює лише з функціями, які можна викликати без аргументів.