rclone-api 1.0.34__tar.gz → 1.0.36__tar.gz

{rclone_api-1.0.34 → rclone_api-1.0.36}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.34
+Version: 1.0.36
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies
@@ -127,7 +127,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.36}/README.md

@@ -110,7 +110,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.36}/pyproject.toml

@@ -15,7 +15,7 @@ dependencies = [
     "python-dotenv>=1.0.0",
 ]
 # Change this with the version number bump.
-version = "1.0.34"
+version = "1.0.36"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

rclone_api-1.0.36/src/rclone_api/deprecated.py

@@ -0,0 +1,24 @@
+import functools
+import warnings
+
+
+def deprecated(new_func_name: str):
+    """Decorator to mark functions as deprecated.
+
+    Args:
+        new_func_name: The name of the function that should be used instead.
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                f"{func.__name__}() is deprecated; use {new_func_name}() instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator

{rclone_api-1.0.34 → rclone_api-1.0.36}/src/rclone_api/rclone.py

@@ -5,7 +5,6 @@ Unit test file.
 import subprocess
 import time
 import warnings
-from concurrent.futures import ThreadPoolExecutor
 from enum import Enum
 from fnmatch import fnmatch
 from pathlib import Path
@@ -15,6 +14,7 @@ from typing import Generator
 from rclone_api import Dir
 from rclone_api.config import Config
 from rclone_api.convert import convert_to_filestr_list, convert_to_str
+from rclone_api.deprecated import deprecated
 from rclone_api.diff import DiffItem, diff_stream_from_running_process
 from rclone_api.dir_listing import DirListing
 from rclone_api.exec import RcloneExec
@@ -22,7 +22,7 @@ from rclone_api.file import File
 from rclone_api.process import Process
 from rclone_api.remote import Remote
 from rclone_api.rpath import RPath
-from rclone_api.util import get_rclone_exe, to_path, wait_for_mount
+from rclone_api.util import get_rclone_exe, partition_files, to_path, wait_for_mount
 from rclone_api.walk import walk
 
 
@@ -183,7 +183,7 @@ class Rclone:
         cmd_list: list[str] = ["copyto", src, dst]
         self._run(cmd_list)
 
-    def copyfiles(self, filelist: dict[File, File] | dict[str, str]) -> None:
+    def copy_to(self, src: File | str, dst: File | str) -> None:
         """Copy multiple files from source to destination.
 
         Warning - slow.
@@ -191,17 +191,48 @@ class Rclone:
         Args:
             payload: Dictionary of source and destination file paths
         """
-        str_dict: dict[str, str] = {}
-        for src, dst in filelist.items():
-            src = src if isinstance(src, str) else str(src.path)
-            dst = dst if isinstance(dst, str) else str(dst.path)
-            str_dict[src] = dst
-
-        with ThreadPoolExecutor(max_workers=64) as executor:
-            for src, dst in str_dict.items():  # warning - slow
-                cmd_list: list[str] = ["copyto", src, dst]
-                # self._run(cmd_list)
-                executor.submit(self._run, cmd_list)
+        src = str(src)
+        dst = str(dst)
+        cmd_list: list[str] = ["copyto", src, dst]
+        self._run(cmd_list)
+
+    def copyfiles(self, files: str | File | list[str] | list[File]) -> None:
+        """Copy multiple files from source to destination.
+
+        Warning - slow.
+
+        Args:
+            payload: Dictionary of source and destination file paths
+        """
+        payload: list[str] = convert_to_filestr_list(files)
+        if len(payload) == 0:
+            return
+
+        datalists: dict[str, list[str]] = partition_files(payload)
+        out: subprocess.CompletedProcess | None = None
+
+        for remote, files in datalists.items():
+            with TemporaryDirectory() as tmpdir:
+                include_files_txt = Path(tmpdir) / "include_files.txt"
+                include_files_txt.write_text("\n".join(files), encoding="utf-8")
+
+                print(include_files_txt)
+                cmd_list: list[str] = [
+                    "delete",
+                    remote,
+                    "--files-from",
+                    str(include_files_txt),
+                    "--checkers",
+                    "1000",
+                    "--transfers",
+                    "1000",
+                ]
+                out = self._run(cmd_list)
+                if out.returncode != 0:
+                    print(out)
+                    raise ValueError(f"Error deleting files: {out.stderr}")
+
+        assert out is not None
 
     def copy(self, src: Dir | str, dst: Dir | str) -> subprocess.CompletedProcess:
         """Copy files from source to destination.
@@ -224,7 +255,7 @@ class Rclone:
         cmd_list: list[str] = ["purge", str(path)]
         return self._run(cmd_list)
 
-    def deletefiles(
+    def delete_files(
         self, files: str | File | list[str] | list[File]
     ) -> subprocess.CompletedProcess:
         """Delete a directory"""
@@ -237,19 +268,7 @@ class Rclone:
                 stderr="",
             )
 
-        datalists: dict[str, list[str]] = {}
-
-        for f in payload:
-            remote, path = f.split(":", 1)
-            if "/" in path:
-                bucket, path = path.split("/", 1)
-                remote = f"{remote}:{bucket}"
-            else:
-                remote = f"{remote}:"
-            if remote not in datalists:
-                datalists[remote] = []
-            datalists[remote].append(path)
-
+        datalists: dict[str, list[str]] = partition_files(payload)
         out: subprocess.CompletedProcess | None = None
 
         for remote, files in datalists.items():
@@ -276,13 +295,20 @@ class Rclone:
         assert out is not None
         return out
 
+    @deprecated("delete_files")
+    def deletefiles(
+        self, files: str | File | list[str] | list[File]
+    ) -> subprocess.CompletedProcess:
+        return self.delete_files(files)
+
     def exists(self, path: Dir | Remote | str | File) -> bool:
         """Check if a file or directory exists."""
         arg: str = convert_to_str(path)
         assert isinstance(arg, str)
         try:
-            self.ls(arg)
-            return True
+            dir_listing = self.ls(arg)
+            # print(dir_listing)
+            return len(dir_listing.dirs) > 0 or len(dir_listing.files) > 0
         except subprocess.CalledProcessError:
             return False
 

{rclone_api-1.0.34 → rclone_api-1.0.36}/src/rclone_api/util.py

@@ -129,3 +129,18 @@ def wait_for_mount(path: Path, mount_process: Any, timeout: int = 60) -> None:
         if path.exists():
             return
     raise TimeoutError(f"Path {path} did not exist after {timeout} seconds")
+
+
+def partition_files(files: list[str]) -> dict[str, list[str]]:
+    datalists: dict[str, list[str]] = {}
+    for f in files:
+        remote, path = f.split(":", 1)
+        if "/" in path:
+            bucket, path = path.split("/", 1)
+            remote = f"{remote}:{bucket}"
+        else:
+            remote = f"{remote}:"
+        if remote not in datalists:
+            datalists[remote] = []
+        datalists[remote].append(path)
+    return datalists

{rclone_api-1.0.34 → rclone_api-1.0.36}/src/rclone_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.34
+Version: 1.0.36
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies
@@ -127,7 +127,7 @@ if listing.files:
 # Delete a File
 print("\n=== Deleting a File ===")
 file_to_delete = f"dst:{BUCKET_NAME}/zachs_video/sample.png_copy"
-rclone.deletefiles([file_to_delete])
+rclone.delete_files([file_to_delete])
 print(f"Deleted {file_to_delete}")
 
 # Walk Through a Directory

{rclone_api-1.0.34 → rclone_api-1.0.36}/src/rclone_api.egg-info/SOURCES.txt

@@ -24,6 +24,7 @@ src/rclone_api/__init__.py
 src/rclone_api/cli.py
 src/rclone_api/config.py
 src/rclone_api/convert.py
+src/rclone_api/deprecated.py
 src/rclone_api/diff.py
 src/rclone_api/dir.py
 src/rclone_api/dir_listing.py

{rclone_api-1.0.34 → rclone_api-1.0.36}/tests/test_copy.py

@@ -71,7 +71,7 @@ class RcloneCopyTests(unittest.TestCase):
         listing = rclone.ls(f"dst:{BUCKET_NAME}/zachs_video/", glob=f"*{new_name}")
         self.assertEqual(len(listing.files), 1)
         self.assertEqual(listing.dirs, [])
-        rclone.deletefiles([new_path])
+        rclone.delete_files([new_path])
         print("done")
 
     def test_copyfiles(self) -> None:
@@ -83,22 +83,17 @@ class RcloneCopyTests(unittest.TestCase):
         first_file = str(listing.files[0])
         dest_file = first_file + "_copy"
 
-        # Copy the files to the same location with different names
-        filelist: dict[str, str] = {
-            first_file: dest_file,
-        }
-        # warning slow.
-        rclone.copyfiles(filelist)
-
-        delete_list: list[str] = []
-        for _, dst in filelist.items():
-            delete_list.append(dst)
+        # Copy the file to the same location with different names
+        rclone.copy_to(first_file, dest_file)
 
         # now test that the new file exists
         exists = rclone.exists(dest_file)
         self.assertTrue(exists)
 
-        rclone.deletefiles(delete_list)
+        rclone.delete_files(dest_file)
+        print(f"Checking that {dest_file} was deleted")
+        deleted = rclone.exists(dest_file)
+        self.assertFalse(deleted)
         print("done")