Added ResourcePath.copytree (#106)

Author: Thom1729

st3/sublime_lib/resource_path.py

@@ -2,6 +2,7 @@
 
 import posixpath
 from collections import OrderedDict
+import os
 
 from .vendor.pathlib.pathlib import Path
 from ._util.glob import get_glob_matcher
@@ -432,6 +433,7 @@ def copy(self, target, exist_ok=True):
         and `exist_ok` is ``True`` (the default),
         it will be silently replaced.
 
+        :raise FileNotFoundError: if there is no resource at this path.
         :raise IsADirectoryError: if `target` is a directory.
         :raise FileExistsError: if `target` is a file and `exist_ok` is ``False``.
         """
@@ -443,3 +445,25 @@ def copy(self, target, exist_ok=True):
         data = self.read_bytes()
         with open(str(target), mode + 'b') as file:
             file.write(data)
+
+    def copytree(self, target, exist_ok=False):
+        """
+        Copy all resources beneath this path into a directory tree rooted at `target`.
+
+        All missing parent directories of `target` will be created.
+
+        If `exist_ok` is ``False`` (the default),
+        then `target` must not already exist.
+        If `exist_ok` is ``True``,
+        then existing files under `target` will be overwritten.
+
+        :raise FileExistsError: if `target` already exists and `exist_ok` is ``False``.
+        """
+        target = Path(target)
+
+        os.makedirs(str(target), exist_ok=exist_ok)
+
+        for resource in self.rglob('*'):
+            file_path = target.joinpath(*resource.relative_to(self))
+            os.makedirs(str(file_path.parent), exist_ok=True)
+            resource.copy(file_path)

tests/test_resource_path.py

@@ -247,3 +247,64 @@ def test_copy_directory_error(self):
                 source.copy(destination)
 
             self.assertTrue(destination.is_dir())
+
+    def test_copytree(self):
+        with tempfile.TemporaryDirectory() as directory:
+            source = ResourcePath("Packages/test_package")
+            destination = Path(directory) / 'tree'
+
+            source.copytree(destination)
+
+            self.assertEqual(
+                {
+                    path.relative_to(destination).parts
+                    for path in destination.rglob('*')
+                    if path.is_file()
+                },
+                {
+                    path.relative_to(source)
+                    for path in source.rglob('*')
+                }
+            )
+
+    def test_copytree_exists_error(self):
+        with tempfile.TemporaryDirectory() as directory:
+            source = ResourcePath("Packages/test_package")
+            destination = Path(directory) / 'tree'
+            destination.mkdir()
+
+            with self.assertRaises(FileExistsError):
+                source.copytree(destination)
+
+    def test_copytree_exists(self):
+        with tempfile.TemporaryDirectory() as directory:
+            source = ResourcePath("Packages/test_package")
+            destination = Path(directory) / 'tree'
+            destination.mkdir()
+
+            helloworld_file = destination / 'helloworld.txt'
+
+            with open(str(helloworld_file), 'w') as file:
+                file.write("Nothing to see here.\n")
+
+            source.copytree(destination, exist_ok=True)
+
+            self.assertEqual(
+                {
+                    path.relative_to(destination).parts
+                    for path in destination.rglob('*')
+                    if path.is_file()
+                },
+                {
+                    path.relative_to(source)
+                    for path in source.rglob('*')
+                }
+            )
+
+            with open(str(helloworld_file)) as file:
+                helloworld_contents = file.read()
+
+            self.assertEqual(
+                helloworld_contents,
+                (source / 'helloworld.txt').read_text()
+            )