cpython/Doc/library/atexit.rst

128 lines
4.5 KiB
ReStructuredText
Raw Normal View History

:mod:`!atexit` --- Exit handlers
================================
2007-08-15 11:28:22 -03:00
.. module:: atexit
:synopsis: Register and execute cleanup functions.
.. moduleauthor:: Skip Montanaro <skip.montanaro@gmail.com>
.. sectionauthor:: Skip Montanaro <skip.montanaro@gmail.com>
2007-08-15 11:28:22 -03:00
--------------
2007-08-15 11:28:22 -03:00
The :mod:`atexit` module defines functions to register and unregister cleanup
functions. Functions thus registered are automatically executed upon normal
interpreter termination. :mod:`atexit` runs these functions in the *reverse*
order in which they were registered; if you register ``A``, ``B``, and ``C``,
at interpreter termination time they will be run in the order ``C``, ``B``,
``A``.
**Note:** The functions registered via this module are not called when the
program is killed by a signal not handled by Python, when a Python fatal
internal error is detected, or when :func:`os._exit` is called.
2007-08-15 11:28:22 -03:00
**Note:** The effect of registering or unregistering functions from within
a cleanup function is undefined.
.. versionchanged:: 3.7
When used with C-API subinterpreters, registered functions
are local to the interpreter they were registered in.
2007-08-15 11:28:22 -03:00
.. function:: register(func, *args, **kwargs)
2007-08-15 11:28:22 -03:00
Register *func* as a function to be executed at termination. Any optional
arguments that are to be passed to *func* must be passed as arguments to
:func:`register`. It is possible to register the same function and arguments
more than once.
2007-08-15 11:28:22 -03:00
At normal program termination (for instance, if :func:`sys.exit` is called or
the main module's execution completes), all functions registered are called in
last in, first out order. The assumption is that lower level modules will
normally be imported before higher level modules and thus must be cleaned up
later.
If an exception is raised during execution of the exit handlers, a traceback is
printed (unless :exc:`SystemExit` is raised) and the exception information is
2021-06-22 13:49:12 -03:00
saved. After all exit handlers have had a chance to run, the last exception to
2007-08-15 11:28:22 -03:00
be raised is re-raised.
This function returns *func*, which makes it possible to use it as a
decorator.
2007-08-15 11:28:22 -03:00
.. warning::
Starting new threads or calling :func:`os.fork` from a registered
function can lead to race condition between the main Python
runtime thread freeing thread states while internal :mod:`threading`
routines or the new process try to use that state. This can lead to
crashes rather than clean shutdown.
.. versionchanged:: 3.12
Attempts to start a new thread or :func:`os.fork` a new process
in a registered function now leads to :exc:`RuntimeError`.
2007-08-15 11:28:22 -03:00
.. function:: unregister(func)
Remove *func* from the list of functions to be run at interpreter shutdown.
:func:`unregister` silently does nothing if *func* was not previously
registered. If *func* has been registered more than once, every occurrence
of that function in the :mod:`atexit` call stack will be removed. Equality
comparisons (``==``) are used internally during unregistration, so function
references do not need to have matching identities.
2007-08-15 11:28:22 -03:00
.. seealso::
Module :mod:`readline`
Useful example of :mod:`atexit` to read and write :mod:`readline` history
files.
2007-08-15 11:28:22 -03:00
.. _atexit-example:
:mod:`atexit` Example
---------------------
The following simple example demonstrates how a module can initialize a counter
from a file when it is imported and save the counter's updated value
automatically when the program terminates without relying on the application
making an explicit call into this module at termination. ::
try:
2021-06-22 13:49:12 -03:00
with open('counterfile') as infile:
_count = int(infile.read())
2011-10-12 15:10:51 -03:00
except FileNotFoundError:
2007-08-15 11:28:22 -03:00
_count = 0
def incrcounter(n):
global _count
_count = _count + n
def savecounter():
2021-06-22 13:49:12 -03:00
with open('counterfile', 'w') as outfile:
outfile.write('%d' % _count)
2007-08-15 11:28:22 -03:00
import atexit
2021-06-22 13:49:12 -03:00
2007-08-15 11:28:22 -03:00
atexit.register(savecounter)
Positional and keyword arguments may also be passed to :func:`register` to be
passed along to the registered function when it is called::
def goodbye(name, adjective):
2021-06-22 13:49:12 -03:00
print('Goodbye %s, it was %s to meet you.' % (name, adjective))
2007-08-15 11:28:22 -03:00
import atexit
2021-06-22 13:49:12 -03:00
atexit.register(goodbye, 'Donny', 'nice')
2007-08-15 11:28:22 -03:00
# or:
atexit.register(goodbye, adjective='nice', name='Donny')
Merged revisions 59259-59274 via svnmerge from svn+ssh://pythondev@svn.python.org/python/trunk ........ r59260 | lars.gustaebel | 2007-12-01 22:02:12 +0100 (Sat, 01 Dec 2007) | 5 lines Issue #1531: Read fileobj from the current offset, do not seek to the start. (will backport to 2.5) ........ r59262 | georg.brandl | 2007-12-01 23:24:47 +0100 (Sat, 01 Dec 2007) | 4 lines Document PyEval_* functions from ceval.c. Credits to Michael Sloan from GHOP. ........ r59263 | georg.brandl | 2007-12-01 23:27:56 +0100 (Sat, 01 Dec 2007) | 2 lines Add a few refcount data entries. ........ r59264 | georg.brandl | 2007-12-01 23:38:48 +0100 (Sat, 01 Dec 2007) | 4 lines Add test suite for cmd module. Written by Michael Schneider for GHOP. ........ r59265 | georg.brandl | 2007-12-01 23:42:46 +0100 (Sat, 01 Dec 2007) | 3 lines Add examples to the ElementTree documentation. Written by h4wk.cz for GHOP. ........ r59266 | georg.brandl | 2007-12-02 00:12:45 +0100 (Sun, 02 Dec 2007) | 3 lines Add "Using Python on Windows" document, by Robert Lehmann. Written for GHOP. ........ r59271 | georg.brandl | 2007-12-02 15:34:34 +0100 (Sun, 02 Dec 2007) | 3 lines Add example to mmap docs. Written for GHOP by Rafal Rawicki. ........ r59272 | georg.brandl | 2007-12-02 15:37:29 +0100 (Sun, 02 Dec 2007) | 2 lines Convert bdb.rst line endings to Unix style. ........ r59274 | georg.brandl | 2007-12-02 15:58:50 +0100 (Sun, 02 Dec 2007) | 4 lines Add more entries to the glossary. Written by Jeff Wheeler for GHOP. ........
2007-12-02 11:22:16 -04:00
Usage as a :term:`decorator`::
2007-08-15 11:28:22 -03:00
import atexit
@atexit.register
def goodbye():
2021-06-22 13:49:12 -03:00
print('You are now leaving the Python sector.')
2007-08-15 11:28:22 -03:00
This only works with functions that can be called without arguments.