rclone-api 1.0.58__tar.gz → 1.0.60__tar.gz

{rclone_api-1.0.58 → rclone_api-1.0.60}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.58
+Version: 1.0.60
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies

{rclone_api-1.0.58 → rclone_api-1.0.60}/pyproject.toml

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

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api/diff.py

@@ -1,3 +1,4 @@
+import warnings
 from dataclasses import dataclass
 from enum import Enum
 from queue import Queue
@@ -104,9 +105,9 @@ def _async_diff_stream_from_running_process(
         _thread.interrupt_main()
     if count == 0 and check:
         first_lines_str = "\n".join(first_few_lines)
-        raise ValueError(
-            f"No output from rclone check, first few lines: {first_lines_str}"
-        )
+        warning_msg = f"No output from rclone check, first few lines: {first_lines_str}"
+        warnings.warn(warning_msg)
+        raise ValueError(warning_msg)
 
 
 def diff_stream_from_running_process(

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api/dir.py

@@ -41,11 +41,11 @@ class Dir:
         # self.path.set_rclone(self.path.remote.rclone)
         assert self.path.rclone is not None
 
-    def ls(self, max_depth: int = 0) -> DirListing:
+    def ls(self, max_depth: int = 0, reverse: bool = False) -> DirListing:
         """List files and directories in the given path."""
         assert self.path.rclone is not None
         dir = Dir(self.path)
-        return self.path.rclone.ls(dir, max_depth=max_depth)
+        return self.path.rclone.ls(dir, max_depth=max_depth, reverse=reverse)
 
     def walk(
         self, breadth_first: bool, max_depth: int = -1

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api/rclone.py

@@ -27,6 +27,7 @@ from rclone_api.process import Process
 from rclone_api.remote import Remote
 from rclone_api.rpath import RPath
 from rclone_api.util import (
+    get_check,
     get_rclone_exe,
     get_verbose,
     to_path,
@@ -56,7 +57,7 @@ class Rclone:
         self._exec = RcloneExec(rclone_conf, get_rclone_exe(rclone_exe))
 
     def _run(
-        self, cmd: list[str], check: bool = True, capture: bool | None = None
+        self, cmd: list[str], check: bool = False, capture: bool | None = None
     ) -> subprocess.CompletedProcess:
         return self._exec.execute(cmd, check=check, capture=capture)
 
@@ -72,7 +73,7 @@ class Rclone:
 
     def launch_server(
         self,
-        addr: str | None = None,
+        addr: str,
         user: str | None = None,
         password: str | None = None,
         other_args: list[str] | None = None,
@@ -122,6 +123,7 @@ class Rclone:
         path: Dir | Remote | str,
         max_depth: int | None = None,
         glob: str | None = None,
+        reverse: bool = False,
     ) -> DirListing:
         """List files in the given path.
 
@@ -162,6 +164,9 @@ class Rclone:
         # do we have a glob pattern?
         if glob is not None:
             paths = [p for p in paths if fnmatch(p.path, glob)]
+
+        if reverse:
+            paths.reverse()
         return DirListing(paths)
 
     def listremotes(self) -> list[Remote]:
@@ -175,9 +180,21 @@ class Rclone:
         out = [Remote(name=t, rclone=self) for t in tmp]
         return out
 
-    def diff(self, src: str, dst: str) -> Generator[DiffItem, None, None]:
+    def diff(
+        self,
+        src: str,
+        dst: str,
+        min_size: (
+            str | None
+        ) = None,  # e. g. "1MB" - see rclone documentation: https://rclone.org/commands/rclone_check/
+        max_size: (
+            str | None
+        ) = None,  # e. g. "1GB" - see rclone documentation: https://rclone.org/commands/rclone_check/
+        other_args: list[str] | None = None,
+    ) -> Generator[DiffItem, None, None]:
         """Be extra careful with the src and dst values. If you are off by one
         parent directory, you will get a huge amount of false diffs."""
+        other_args = other_args or []
         cmd = [
             "check",
             src,
@@ -189,6 +206,12 @@ class Rclone:
             "--combined",
             "-",
         ]
+        if min_size:
+            cmd += ["--min-size", min_size]
+        if max_size:
+            cmd += ["--max-size", max_size]
+        if other_args:
+            cmd += other_args
         proc = self._launch_process(cmd, capture=True)
         item: DiffItem
         for item in diff_stream_from_running_process(proc, src_slug=src, dst_slug=dst):
@@ -197,7 +220,11 @@ class Rclone:
             yield item
 
     def walk(
-        self, path: Dir | Remote | str, max_depth: int = -1, breadth_first: bool = True
+        self,
+        path: Dir | Remote | str,
+        max_depth: int = -1,
+        breadth_first: bool = True,
+        reverse: bool = False,
     ) -> Generator[DirListing, None, None]:
         """Walk through the given path recursively.
 
@@ -231,7 +258,9 @@ class Rclone:
             dir_obj = Dir(path)  # shut up pyright
             assert f"Invalid type for path: {type(path)}"
 
-        yield from walk(dir_obj, max_depth=max_depth, breadth_first=breadth_first)
+        yield from walk(
+            dir_obj, max_depth=max_depth, breadth_first=breadth_first, reverse=reverse
+        )
 
     def cleanup(
         self, path: str, other_args: list[str] | None = None
@@ -248,7 +277,7 @@ class Rclone:
         self,
         src: File | str,
         dst: File | str,
-        check=True,
+        check: bool | None = None,
         other_args: list[str] | None = None,
     ) -> None:
         """Copy multiple files from source to destination.
@@ -258,6 +287,7 @@ class Rclone:
         Args:
             payload: Dictionary of source and destination file paths
         """
+        check = get_check(check)
         src = src if isinstance(src, str) else str(src.path)
         dst = dst if isinstance(dst, str) else str(dst.path)
         cmd_list: list[str] = ["copyto", src, dst]
@@ -270,7 +300,7 @@ class Rclone:
         src: str,
         dst: str,
         files: list[str],
-        check=True,
+        check: bool | None = None,
         verbose: bool | None = None,
         checkers: int | None = None,
         transfers: int | None = None,
@@ -284,6 +314,7 @@ class Rclone:
         Args:
             payload: Dictionary of source and destination file paths
         """
+        check = get_check(check)
         max_partition_workers = max_partition_workers or 1
         low_level_retries = low_level_retries or 10
         retries = retries or 3
@@ -398,13 +429,14 @@ class Rclone:
     def delete_files(
         self,
         files: str | File | list[str] | list[File],
-        check=True,
+        check: bool | None = None,
         rmdirs=False,
         verbose: bool | None = None,
         max_partition_workers: int | None = None,
         other_args: list[str] | None = None,
     ) -> CompletedProcess:
         """Delete a directory"""
+        check = get_check(check)
         verbose = get_verbose(verbose)
         payload: list[str] = convert_to_filestr_list(files)
         if len(payload) == 0:
@@ -494,7 +526,7 @@ class Rclone:
         dst = convert_to_str(dst)
         cmd_list: list[str] = ["check", str(src), str(dst)]
         try:
-            self._run(cmd_list)
+            self._run(cmd_list, check=True)
             return True
         except subprocess.CalledProcessError:
             return False

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api/util.py

@@ -63,6 +63,13 @@ def get_verbose(verbose: bool | None) -> bool:
     return bool(int(os.getenv("RCLONE_API_VERBOSE", "0")))
 
 
+def get_check(check: bool | None) -> bool:
+    if check is not None:
+        return check
+    # get it from the environment
+    return bool(int(os.getenv("RCLONE_API_CHECK", "1")))
+
+
 def get_rclone_exe(rclone_exe: Path | None) -> Path:
     if rclone_exe is None:
 

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api/walk.py

@@ -10,14 +10,17 @@ _MAX_OUT_QUEUE_SIZE = 50
 
 
 def _walk_runner_breadth_first(
-    dir: Dir, max_depth: int, out_queue: Queue[DirListing | None]
+    dir: Dir,
+    max_depth: int,
+    out_queue: Queue[DirListing | None],
+    reverse: bool = False,
 ) -> None:
     queue: Queue[Dir] = Queue()
     queue.put(dir)
     try:
         while not queue.empty():
             current_dir = queue.get()
-            dirlisting = current_dir.ls()
+            dirlisting = current_dir.ls(max_depth=0, reverse=reverse)
             out_queue.put(dirlisting)
             dirs = dirlisting.dirs
 
@@ -38,20 +41,22 @@ def _walk_runner_breadth_first(
 
 
 def _walk_runner_depth_first(
-    dir: Dir, max_depth: int, out_queue: Queue[DirListing | None]
+    dir: Dir, max_depth: int, out_queue: Queue[DirListing | None], reverse=False
 ) -> None:
     try:
         stack = [(dir, max_depth)]
         while stack:
             current_dir, depth = stack.pop()
             dirlisting = current_dir.ls()
+            if reverse:
+                dirlisting.dirs.reverse()
             if depth != 0:
-                for subdir in reversed(
-                    dirlisting.dirs
-                ):  # Process deeper directories first
+                for subdir in dirlisting.dirs:  # Process deeper directories first
                     # stack.append((child, depth - 1 if depth > 0 else depth))
                     next_depth = depth - 1 if depth > 0 else depth
-                    _walk_runner_depth_first(subdir, next_depth, out_queue)
+                    _walk_runner_depth_first(
+                        subdir, next_depth, out_queue, reverse=reverse
+                    )
             out_queue.put(dirlisting)
         out_queue.put(None)
     except KeyboardInterrupt:
@@ -65,6 +70,7 @@ def walk(
     dir: Dir | Remote,
     breadth_first: bool,
     max_depth: int = -1,
+    reverse: bool = False,
 ) -> Generator[DirListing, None, None]:
     """Walk through the given directory recursively.
 
@@ -88,7 +94,7 @@ def walk(
         # Start worker thread
         worker = Thread(
             target=strategy,
-            args=(dir, max_depth, out_queue),
+            args=(dir, max_depth, out_queue, reverse),
             daemon=True,
         )
         worker.start()

{rclone_api-1.0.58 → rclone_api-1.0.60}/src/rclone_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.58
+Version: 1.0.60
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies

{rclone_api-1.0.58 → rclone_api-1.0.60}/tests/test_diff.py

@@ -70,18 +70,6 @@ class RcloneDiffTests(unittest.TestCase):
         msg = "\n".join([str(item) for item in all])
         print(msg)
 
-        all.clear()
-        for item in rclone.diff(
-            "dst:rclone-api-unit-test/test", "dst:rclone-api-unit-test/test"
-        ):
-            self.assertEqual(item.type, DiffType.EQUAL)
-            print(item)
-            all.append(item)
-
-        msg = "\n".join([str(item) for item in all])
-        print(msg)
-        print("done")
-
 
 if __name__ == "__main__":
     unittest.main()

{rclone_api-1.0.58 → rclone_api-1.0.60}/tests/test_is_synced.py

@@ -62,6 +62,7 @@ class RcloneIsSyncedTests(unittest.TestCase):
         listing: DirListing = rclone.ls(path)
         self.assertGreater(len(listing.dirs), 0)
         src_dir = listing.dirs[0]
+        src_dir = src_dir
         dst_dir = f"dst:{BUCKET_NAME}/test"
         rclone.purge(dst_dir)
         is_synced = rclone.is_synced(src_dir, dst_dir)