From: Georg Brandl <georg@python.org>
Date: Thu, 16 Nov 2006 16:50:59 +0000 (+0000)
Subject: Bug #1597824: return the registered function from atexit.register()
X-Git-Tag: v2.6a1~2429
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=540821183b0a6105d5cf262db837332b14e0e259;p=python

Bug #1597824: return the registered function from atexit.register()
to facilitate usage as a decorator.
---

diff --git a/Doc/lib/libatexit.tex b/Doc/lib/libatexit.tex
index 33dc7ddf8c..9798b57507 100644
--- a/Doc/lib/libatexit.tex
+++ b/Doc/lib/libatexit.tex
@@ -44,6 +44,10 @@ If an exception is raised during execution of the exit handlers, a
 traceback is printed (unless \exception{SystemExit} is raised) and the
 exception information is saved.  After all exit handlers have had a
 chance to run the last exception to be raised is re-raised.
+
+\versionchanged[This function now returns \var{func} which makes it
+                possible to use it as a decorator without binding the
+		original name to \code{None}]{2.6}
 \end{funcdesc}
 
 
@@ -92,3 +96,15 @@ atexit.register(goodbye, 'Donny', 'nice')
 # or:
 atexit.register(goodbye, adjective='nice', name='Donny')
 \end{verbatim}
+
+Usage as a decorator:
+
+\begin{verbatim}
+import atexit
+
+@atexit.register
+def goodbye():
+    print "You are now leaving the Python sector."
+\end{verbatim}
+
+This obviously only works with functions that don't take arguments.
diff --git a/Lib/atexit.py b/Lib/atexit.py
index c9f4cc6775..93fddf7f99 100644
--- a/Lib/atexit.py
+++ b/Lib/atexit.py
@@ -40,8 +40,11 @@ def register(func, *targs, **kargs):
     func - function to be called at exit
     targs - optional arguments to pass to func
     kargs - optional keyword arguments to pass to func
+
+    func is returned to facilitate usage as a decorator.
     """
     _exithandlers.append((func, targs, kargs))
+    return func
 
 if hasattr(sys, "exitfunc"):
     # Assume it's another registered exit function - append it to our list
diff --git a/Misc/NEWS b/Misc/NEWS
index 2d4e31d3d4..32cdb1f688 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -98,6 +98,9 @@ Core and builtins
 Library
 -------
 
+- Bug #1597824: return the registered function from atexit.register()
+  to facilitate usage as a decorator.
+
 - Patch #1360200: Use unmangled_version RPM spec field to deal with
   file name mangling.