Issue #14167: Document return statement in finally blocks.
authorAndrew Svetlov <andrew.svetlov@gmail.com>
Tue, 14 Aug 2012 12:38:15 +0000 (15:38 +0300)
committerAndrew Svetlov <andrew.svetlov@gmail.com>
Tue, 14 Aug 2012 12:38:15 +0000 (15:38 +0300)
Patch by Yury Selivanov.

Doc/reference/compound_stmts.rst

index 4ce7324550ee087cea313ea66af8650d6f31e340..687ba3e1360ec6adf6138716241e850075fa0ec5 100644 (file)
@@ -307,12 +307,23 @@ If :keyword:`finally` is present, it specifies a 'cleanup' handler.  The
 :keyword:`try` clause is executed, including any :keyword:`except` and
 :keyword:`else` clauses.  If an exception occurs in any of the clauses and is
 not handled, the exception is temporarily saved. The :keyword:`finally` clause
-is executed.  If there is a saved exception, it is re-raised at the end of the
-:keyword:`finally` clause. If the :keyword:`finally` clause raises another
-exception or executes a :keyword:`return` or :keyword:`break` statement, the
-saved exception is set as the context of the new exception.  The exception
-information is not available to the program during execution of the
-:keyword:`finally` clause.
+is executed.  If there is a saved exception or :keyword:`break` statement,
+it is re-raised at the end of the :keyword:`finally` clause. If the
+:keyword:`finally` clause raises another exception the saved exception
+is set as the context of the new exception; if the :keyword:`finally` clause
+executes a :keyword:`return` statement, the saved exception is discarded::
+
+    def f():
+        try:
+            1/0
+        finally:
+            return 42
+
+    >>> f()
+    42
+
+The exception information is not available to the program during execution of
+the :keyword:`finally` clause.
 
 .. index::
    statement: return