bpo-29183: Fix double exceptions in wsgiref.handlers.BaseHandler (GH-12914)
authorBerker Peksag <berker.peksag@gmail.com>
Sun, 19 May 2019 15:56:15 +0000 (18:56 +0300)
committerGitHub <noreply@github.com>
Sun, 19 May 2019 15:56:15 +0000 (18:56 +0300)
Lib/test/test_wsgiref.py
Lib/wsgiref/handlers.py
Misc/NEWS.d/next/Library/2019-04-22-22-55-29.bpo-29183.MILvsk.rst [new file with mode: 0644]

index 46f88a94434bcdf0c42ae445d7852891accd3bbe..42432bfbd260e730ce1dc61b0de0b350be6bedaf 100644 (file)
@@ -806,6 +806,31 @@ class HandlerTests(TestCase):
 
                 self.assertFalse(stderr.getvalue())
 
+    def testDontResetInternalStateOnException(self):
+        class CustomException(ValueError):
+            pass
+
+        # We are raising CustomException here to trigger an exception
+        # during the execution of SimpleHandler.finish_response(), so
+        # we can easily test that the internal state of the handler is
+        # preserved in case of an exception.
+        class AbortingWriter:
+            def write(self, b):
+                raise CustomException
+
+        stderr = StringIO()
+        environ = {"SERVER_PROTOCOL": "HTTP/1.0"}
+        h = SimpleHandler(BytesIO(), AbortingWriter(), stderr, environ)
+        h.run(hello_app)
+
+        self.assertIn("CustomException", stderr.getvalue())
+
+        # Test that the internal state of the handler is preserved.
+        self.assertIsNotNone(h.result)
+        self.assertIsNotNone(h.headers)
+        self.assertIsNotNone(h.status)
+        self.assertIsNotNone(h.environ)
+
 
 if __name__ == "__main__":
     unittest.main()
index 834073d50091e033ab232e95bfdd2394f9502fbb..31360e58785ac6e824a339d2005ac1d0d5087df7 100644 (file)
@@ -183,7 +183,16 @@ class BaseHandler:
                 for data in self.result:
                     self.write(data)
                 self.finish_content()
-        finally:
+        except:
+            # Call close() on the iterable returned by the WSGI application
+            # in case of an exception.
+            if hasattr(self.result, 'close'):
+                self.result.close()
+            raise
+        else:
+            # We only call close() when no exception is raised, because it
+            # will set status, result, headers, and environ fields to None.
+            # See bpo-29183 for more details.
             self.close()
 
 
diff --git a/Misc/NEWS.d/next/Library/2019-04-22-22-55-29.bpo-29183.MILvsk.rst b/Misc/NEWS.d/next/Library/2019-04-22-22-55-29.bpo-29183.MILvsk.rst
new file mode 100644 (file)
index 0000000..1d19f19
--- /dev/null
@@ -0,0 +1,3 @@
+Fix double exceptions in :class:`wsgiref.handlers.BaseHandler` by calling
+its :meth:`~wsgiref.handlers.BaseHandler.close` method only when no
+exception is raised.