#11700: proxy object close methods can now be called multiple times

This makes them work like the close provided by regular file objects.  This
patch also backports the close-the-underlying-file code for _ProxyFile objects
that was introduced along with context manager support in the 3.x branch.

diff --git a/Lib/mailbox.py b/Lib/mailbox.py
index 99783596338476ec066f85f7d14c74c440e387b6..a9d9c282ea1ebdefdfe91a5d0e6720efb1dbfc84 100644 (file)
--- a/Lib/mailbox.py
+++ b/Lib/mailbox.py
@@ -1854,7 +1854,10 @@ class _ProxyFile:
 
     def close(self):
         """Close the file."""
-        del self._file
+        if hasattr(self, '_file'):
+            if hasattr(self._file, 'close'):
+                self._file.close()
+            del self._file
 
     def _read(self, size, read_method):
         """Read size bytes using read_method."""
@@ -1898,6 +1901,12 @@ class _PartialFile(_ProxyFile):
             size = remaining
         return _ProxyFile._read(self, size, read_method)
 
+    def close(self):
+        # do *not* close the underlying file object for partial files,
+        # since it's global to the mailbox object
+        if hasattr(self, '_file'):
+            del self._file
+
 
 def _lock_file(f, dotlock=True):
     """Lock file f using lockf and dot locking."""

diff --git a/Lib/test/test_mailbox.py b/Lib/test/test_mailbox.py
index 3c7a3e6e6c0184da97b4d097311211d0fbf2a35d..112497993c6512af89d17e71eb8b29f02b0b772b 100644 (file)
--- a/Lib/test/test_mailbox.py
+++ b/Lib/test/test_mailbox.py
@@ -174,6 +174,13 @@ class TestMailbox(TestBase):
         self.assertEqual(self._box.get_file(key1).read().replace(os.linesep, '\n'),
                          _sample_message)
 
+    def test_get_file_can_be_closed_twice(self):
+        # Issue 11700
+        key = self._box.add(_sample_message)
+        f = self._box.get_file(key)
+        f.close()
+        f.close()
+
     def test_iterkeys(self):
         # Get keys using iterkeys()
         self._check_iteration(self._box.iterkeys, do_keys=True, do_values=False)
@@ -1670,7 +1677,8 @@ class TestProxyFileBase(TestBase):
     def _test_close(self, proxy):
         # Close a file
         proxy.close()
-        self.assertRaises(AttributeError, lambda: proxy.close())
+        # Issue 11700 subsequent closes should be a no-op, not an error.
+        proxy.close()
 
 
 class TestProxyFile(TestProxyFileBase):

diff --git a/Misc/NEWS b/Misc/NEWS
index 5fa417856a52c41cacc5b9f26ac4bf2cdfea487c..2e33e7f5b801d920203eda6b185e59349ce3d05e 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -16,6 +16,9 @@ Core and Builtins
 Library
 -------
 
+- Issue #11700: mailbox proxy object close methods can now be called multiple
+  times without error, and _ProxyFile now closes the wrapped file.
+
 - Issue #12133: AbstractHTTPHandler.do_open() of urllib.request closes the HTTP
   connection if its getresponse() method fails with a socket error. Patch
   written by Ezio Melotti.