Changeset 391 for python/trunk/Doc/library/atexit.rst

Timestamp:

Mar 19, 2014, 11:31:01 PM (11 years ago)

Author:

dmik

Message:

python: Merge vendor 2.7.6 to trunk.

Location:

python/trunk

Files:

• . (modified) (1 prop)
• Doc/library/atexit.rst (modified) (7 diffs)

python/trunk/Doc/library/atexit.rst

@@ -1 @@
-
 :mod:`atexit` --- Exit handlers
 ===============================
@@ -11 +10 @@
 .. versionadded:: 2.0
 
+**Source code:** :source:`Lib/atexit.py`
+
+--------------
+
 The :mod:`atexit` module defines a single function to register cleanup
 functions.  Functions thus registered are automatically executed upon normal
-interpreter termination.
+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, when a Python fatal internal error is detected, or when
-:func:`os._exit` is called.
+**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.
 
 .. index:: single: exitfunc (in sys)
 
 This is an alternate interface to the functionality provided by the
-``sys.exitfunc`` variable.
+:func:`sys.exitfunc` variable.
 
 Note: This module is unlikely to work correctly when used with other code that
@@ -36 +42 @@
    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`.
+   :func:`register`.  It is possible to register the same function and arguments
+   more than once.
 
    At normal program termination (for instance, if :func:`sys.exit` is called or
@@ -50 +57 @@
 
    .. versionchanged:: 2.6
-      This function now returns *func* which makes it possible to use it as a
-      decorator without binding the original name to ``None``.
+      This function now returns *func*, which makes it possible to use it as a
+      decorator.
 
 
@@ -71 +78 @@
 
    try:
-       _count = int(open("/tmp/counter").read())
+       _count = int(open("counter").read())
    except IOError:
        _count = 0
@@ -80 +87 @@
 
    def savecounter():
-       open("/tmp/counter", "w").write("%d" % _count)
+       open("counter", "w").write("%d" % _count)
 
    import atexit
@@ -105 +112 @@
        print "You are now leaving the Python sector."
 
-This obviously only works with functions that don't take arguments.
-
+This only works with functions that can be called without arguments.