Add missing support for os.renames

- fixes #714

Author: mrbean-bremen

CHANGES.md

@@ -21,7 +21,7 @@ The released versions correspond to PyPi releases.
   is of type `byte`; the call itself does nothing as before 
 * do not skip filesystem modules by name to allow using own modules with 
   the same name (see [#707](../../issues/707))
-
+* add missing support for `os.renames` (see [#714](../../issues/714))
 
 ## [Version 4.6.3](https://pypi.python.org/pypi/pyfakefs/4.6.3) (2022-07-20)
 Another patch release that fixes a regression in version 4.6.

pyfakefs/fake_filesystem.py

@@ -4477,6 +4477,32 @@ def rename(self, src: AnyStr, dst: AnyStr, *,
         dst = self._path_with_dir_fd(dst, self.rename, dst_dir_fd)
         self.filesystem.rename(src, dst)
 
+    def renames(self, old: AnyStr, new: AnyStr):
+        """Fakes `os.renames`, documentation taken from there.
+
+        Super-rename; create directories as necessary and delete any left
+        empty.  Works like rename, except creation of any intermediate
+        directories needed to make the new pathname good is attempted
+        first.  After the rename, directories corresponding to rightmost
+        path segments of the old name will be pruned until either the
+        whole path is consumed or a nonempty directory is found.
+
+        Note: this function can fail with the new directory structure made
+        if you lack permissions needed to unlink the leaf directory or
+        file.
+
+        """
+        head, tail = self.filesystem.splitpath(new)
+        if head and tail and not self.filesystem.exists(head):
+            self.makedirs(head)
+        self.rename(old, new)
+        head, tail = self.filesystem.splitpath(old)
+        if head and tail:
+            try:
+                self.removedirs(head)
+            except OSError:
+                pass
+
     def replace(self, src: AnyStr, dst: AnyStr, *,
                 src_dir_fd: Optional[int] = None,
                 dst_dir_fd: Optional[int] = None) -> None:

pyfakefs/tests/fake_os_test.py

@@ -3328,6 +3328,28 @@ def test_rename_symlink_to_other_case_works_in_windows(self):
         self.os.rename(path0, path1)
         self.assertEqual(['Beta'], sorted(self.os.listdir(path0)))
 
+    def test_renames_creates_missing_dirs(self):
+        old_path = self.make_path("foo.txt")
+        self.create_file(old_path)
+        new_path = self.make_path("new", "dir", "bar.txt")
+        self.os.renames(old_path, new_path)
+        self.assertTrue(self.os.path.exists(new_path))
+        self.assertFalse(self.os.path.exists(old_path))
+
+    def test_renames_removes_empty_dirs(self):
+        old_base_path = self.make_path("old")
+        old_path = self.make_path("old", "dir1", "dir2", "foo.txt")
+        other_file = self.os.path.join(old_base_path, "foo.png")
+        self.create_file(old_path)
+        self.create_file(other_file)
+        new_path = self.make_path("new", "bar.txt")
+        self.os.renames(old_path, new_path)
+        self.assertTrue(self.os.path.exists(new_path))
+        self.assertFalse(self.os.path.exists(old_path))
+        self.assertTrue(self.os.path.exists(old_base_path))
+        removed_path = self.os.path.join(old_base_path, "dir1")
+        self.assertFalse(self.os.path.exists(removed_path))
+
     def test_stat_with_mixed_case(self):
         # Regression test for #310
         self.skip_if_symlink_not_supported()