]> granicus.if.org Git - python/commitdiff
added warning about incompatibility with other codes' use of sys.exitfunc.
authorSkip Montanaro <skip@pobox.com>
Wed, 5 Jul 2000 23:11:26 +0000 (23:11 +0000)
committerSkip Montanaro <skip@pobox.com>
Wed, 5 Jul 2000 23:11:26 +0000 (23:11 +0000)
Doc/lib/libatexit.tex

index df0cdd49752af548e788afad7014e9d826c64542..e74cc742c4afe4c24499d7f03eaad8f2b42e62bd 100644 (file)
@@ -20,6 +20,14 @@ This is an alternate interface to the functionality provided by the
 \code{sys.exitfunc} variable.
 \withsubitem{(in sys)}{\ttindex{exitfunc}}
 
+Note: This module is unlikely to work correctly when used with other code
+that sets \code{sys.exitfunc}.  In particular, other core Python modules are
+free to use \module{atexit} without the programmer's knowledge.  Authors who
+use \code{sys.exitfunc} should convert their code to use
+\module{atexit} instead.  The simplest way to convert code that sets
+\code{sys.exitfunc} is to import \module{atexit} and register the function
+that had been bound to \code{sys.exitfunc}.
+
 \begin{funcdesc}{register}{func\optional{, *args\optional{, **kargs}}}
 Register \var{func} as a function to be executed at termination.  Any
 optional arguments that are to be passed to \var{func} must be passed