add copy method to drive.py (#188)

* add copy method to drive.py

* removed kind

* moved the copy method to files.py

* add try except around the API call

* corrected some single quote in double quote

* removed newline at the end of the file

* added param to copy method

* first try on the test

* test + fix bugs on copy method

* fixed not modified file with git, so it doesn't show up on the changes

* solved some comments

- fixed style
- fixed docstring
- now the function will return the copied file
- if new_title is None the new title will be "Copy of [old-title]"

* target_folder is now optional

* edits on the copyFile tests

- now i use the ability to return the copied file directly
- adding new test to copy the file in a different folder

* clarified code a bit

* add comment

* changed description of Copy method

* runned pre-commit hook and fixed pydrive_retry

* changed SetContentString to SetContentFile

* fixed docstring

Author: simone-viozzi

pydrive2/files.py

@@ -518,6 +518,42 @@ def Delete(self, param=None):
         """
         self._FilesDelete(param=param)
 
+    @LoadAuth
+    def Copy(self, target_folder=None, new_title=None, param=None):
+        """Creates a copy of this file. Folders cannot be copied.
+
+        :param target_folder: Folder where the file will be copied.
+        :type target_folder: GoogleDriveFile, optional
+        :param new_title: Name of the new file.
+        :type new_title: str, optional
+        :param param: addition parameters to pass.
+        :type param: dict, optional
+        :raises ApiRequestError
+        :return: the copied file
+        :rtype: GoogleDriveFile
+        """
+
+        if param is None:
+            param = {}
+
+        param["fileId"] = self["id"]
+        param["supportsAllDrives"] = True
+        param["body"] = {}
+
+        if target_folder:
+            param["body"]["parents"] = [{"id": target_folder["id"]}]
+        param["body"]["title"] = new_title
+
+        new_file = None
+        try:
+            new_file = (
+                self.auth.service.files().copy(**param).execute(http=self.http)
+            )
+        except errors.HttpError as error:
+            raise ApiRequestError(error)
+
+        return GoogleDriveFile(self.auth, new_file)
+
     def InsertPermission(self, new_permission, param=None):
         """Insert a new permission. Re-fetches all permissions after call.
 

pydrive2/test/test_file.py

@@ -842,6 +842,75 @@ def test_Parallel_Insert_File_Passed_HTTP(self):
         files = self._parallel_uploader(self.FILE_UPLOAD_COUNT, 10)
         self._parallel_downloader(files, 10)
 
+    # Tests for Copy file.
+    # ====================
+
+    def test_CopyFileSameFolder(self):
+        drive = GoogleDrive(self.ga)
+
+        content = "hello world!"
+
+        # create a temp file and set it's content to a known string
+        file1 = drive.CreateFile()
+        filename = self.getTempFile("copytestfile", content=content)
+        file1["title"] = filename
+        file1.SetContentFile(filename)
+        pydrive_retry(file1.Upload)
+
+        # copy the file
+        file2 = pydrive_retry(file1.Copy, new_title="copytestfile_copy")
+
+        self.assertIsNotNone(file2)
+
+        pydrive_retry(file2.FetchContent)
+        # assert that the content of the copied file is the same as the original (file1)
+        self.assertEqual(file2.GetContentString(), content)
+
+        self.DeleteUploadedFiles(drive, [file1["id"], file2["id"]])
+
+    def test_CopyFileDifferentFolder(self):
+        drive = GoogleDrive(self.ga)
+
+        content = "hello world!"
+
+        # create a temp file and set it's content to a known string
+        file1 = drive.CreateFile()
+        filename = self.getTempFile("copytestfile", content=content)
+        file1["title"] = filename
+        file1.SetContentFile(filename)
+        pydrive_retry(file1.Upload)
+
+        # create a temp directory
+        temp_dir = pydrive_retry(
+            drive.CreateFile,
+            {
+                "title": "temp_dir",
+                "mimeType": "application/vnd.google-apps.folder",
+                "parents": [{"id": file1["parents"][0]["id"]}],
+            },
+        )
+        pydrive_retry(temp_dir.Upload)
+
+        # copy the file into the new folder
+        file2 = pydrive_retry(
+            file1.Copy, target_folder=temp_dir, new_title="copytestfile_copy"
+        )
+
+        self.assertIsNotNone(file2)
+
+        pydrive_retry(file2.FetchContent)
+        # assert that the content of the copied file is the same as the original (file1)
+        self.assertEqual(file2.GetContentString(), content)
+
+        files = pydrive_retry(
+            drive.ListFile, {"q": f"'{temp_dir['id']}' in parents"}
+        ).GetList()
+        self.assertIn("copytestfile_copy", [f["title"] for f in files])
+
+        self.DeleteUploadedFiles(
+            drive, [file1["id"], file2["id"], temp_dir["id"]]
+        )
+
     # Helper functions.
     # =================