[3.11] bpo-35332: Handle os.close() errors in shutil.rmtree() (GH-23766) (GH-112764)

* Ignore os.close() errors when ignore_errors is True.
* Pass os.close() errors to the error handler if specified.
* os.close no longer retried after error.

(cherry picked from commit 11d88a178b)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Miss Islington (bot) 2023-12-05 20:25:52 +01:00 committed by GitHub
parent 23920a0843
commit 54ca4c64d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 56 additions and 2 deletions

View file

@ -409,6 +409,41 @@ class TestRmTree(BaseTest, unittest.TestCase):
self.assertFalse(shutil._use_fd_functions)
self.assertFalse(shutil.rmtree.avoids_symlink_attacks)
@unittest.skipUnless(shutil._use_fd_functions, "requires safe rmtree")
def test_rmtree_fails_on_close(self):
# Test that the error handler is called for failed os.close() and that
# os.close() is only called once for a file descriptor.
tmp = self.mkdtemp()
dir1 = os.path.join(tmp, 'dir1')
os.mkdir(dir1)
dir2 = os.path.join(dir1, 'dir2')
os.mkdir(dir2)
def close(fd):
orig_close(fd)
nonlocal close_count
close_count += 1
raise OSError
close_count = 0
with support.swap_attr(os, 'close', close) as orig_close:
with self.assertRaises(OSError):
shutil.rmtree(dir1)
self.assertTrue(os.path.isdir(dir2))
self.assertEqual(close_count, 2)
close_count = 0
errors = []
def onerror(*args):
errors.append(args)
with support.swap_attr(os, 'close', close) as orig_close:
shutil.rmtree(dir1, onerror=onerror)
self.assertEqual(len(errors), 2)
self.assertIs(errors[0][0], close)
self.assertEqual(errors[0][1], dir2)
self.assertIs(errors[1][0], close)
self.assertEqual(errors[1][1], dir1)
self.assertEqual(close_count, 2)
@unittest.skipUnless(shutil._use_fd_functions, "dir_fd is not supported")
def test_rmtree_with_dir_fd(self):
tmp_dir = self.mkdtemp()