Address reviewer comments from ZeroIntensity

Author: berland

Lib/shutil.py

@@ -524,16 +524,16 @@ def _copytree(entries, src, dst, symlinks, ignore, copy_function,
                     else:
                         copy_function(srcobj, dstname)
             elif srcentry.is_dir():
+                # Will raise shutil.Error containing multiple exceptions gathered
+                # from recursion
                 copytree(srcobj, dstname, symlinks, ignore, copy_function,
                          ignore_dangling_symlinks, dirs_exist_ok)
             else:
-                # Will raise a SpecialFileError for unsupported file types
+                # Can raise SpecialFileError or SameFileError
                 copy_function(srcobj, dstname)
         except SameFileError as err:
             errors.append((srcname, dstname, str(err)))
         except Error as err:
-            # catch the Error from the recursive copytree so that we can
-            # continue with other files
             errors.extend(err.args[0])
         except OSError as why:
             errors.append((srcname, dstname, str(why)))

Lib/test/test_shutil.py

@@ -1103,33 +1103,36 @@ def test_copytree_subdirectory(self):
 
     def test_copytree_to_itself_gives_sensible_error_message(self):
         base_dir = self.mkdtemp()
+        self.addCleanup(shutil.rmtree, base_dir, ignore_errors=True)
         src_dir = os.path.join(base_dir, "src")
         os.makedirs(src_dir)
         create_file((src_dir, "somefilename"), "somecontent")
-        _assert_are_the_same_file_is_raised(src_dir, src_dir)
+        self._assert_are_the_same_file_is_raised(src_dir, src_dir)
 
     @os_helper.skip_unless_symlink
     def test_copytree_to_backpointing_symlink_gives_sensible_error_message(self):
         base_dir = self.mkdtemp()
+        self.addCleanup(shutil.rmtree, base_dir, ignore_errors=True)
         src_dir = os.path.join(base_dir, "src")
         target_dir = os.path.join(base_dir, "target")
         os.makedirs(src_dir)
         os.makedirs(target_dir)
         some_file = os.path.join(src_dir, "somefilename")
         create_file(some_file, "somecontent")
         os.symlink(some_file, os.path.join(target_dir, "somefilename"))
-        _assert_are_the_same_file_is_raised(src_dir, target_dir)
+        self._assert_are_the_same_file_is_raised(src_dir, target_dir)
+
+    def _assert_are_the_same_file_is_raised(self, src_dir, target_dir):
+        try:
+            shutil.copytree(src_dir, target_dir, dirs_exist_ok=True)
+            self.fail("shutil.Error should have been raised")
+        except Error as error:
+            self.assertEqual(len(error.args[0]), 1)
+            if sys.platform == "win32":
+                self.assertIn("it is being used by another process", error.args[0][0][2])
+            else:
+                self.assertIn("are the same file", error.args[0][0][2])
 
-def _assert_are_the_same_file_is_raised(src_dir, target_dir):
-    try:
-        shutil.copytree(src_dir, target_dir, dirs_exist_ok=True)
-        raise Exception("copytree did not raise")
-    except Error as error:
-        assert len(error.args[0]) == 1
-        if sys.platform == "win32":
-            assert "it is being used by another process" in error.args[0][0][2]
-        else:
-            assert "are the same file" in error.args[0][0][2]
 
 class TestCopy(BaseTest, unittest.TestCase):
 

Misc/NEWS.d/next/Library/2024-12-28-16-25-42.gh-issue-102931.55o5kb.rst

@@ -1 +1,2 @@
-Make exception from copy_directory readable when SameFileError is raised.
+Make exception from :func:`shutil.copy_directory` readable when a
+:exc:`shutil.SameFileError` is raised.