rclone-api 1.0.59__tar.gz → 1.0.61__tar.gz

{rclone_api-1.0.59 → rclone_api-1.0.61}/PKG-INFO

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

{rclone_api-1.0.59 → rclone_api-1.0.61}/pyproject.toml

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

{rclone_api-1.0.59 → rclone_api-1.0.61}/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.59 → rclone_api-1.0.61}/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)
 
@@ -276,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.
@@ -286,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]
@@ -297,8 +299,8 @@ class Rclone:
         self,
         src: str,
         dst: str,
-        files: list[str],
-        check=True,
+        files: list[str] | Path,
+        check: bool | None = None,
         verbose: bool | None = None,
         checkers: int | None = None,
         transfers: int | None = None,
@@ -312,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
@@ -319,7 +322,11 @@ class Rclone:
         checkers = checkers or 1000
         transfers = transfers or 32
         verbose = get_verbose(verbose)
-        payload: list[str] = convert_to_filestr_list(files)
+        payload: list[str] = (
+            files
+            if isinstance(files, list)
+            else [f.strip() for f in files.read_text().splitlines() if f.strip()]
+        )
         if len(payload) == 0:
             return []
 
@@ -338,10 +345,26 @@ class Rclone:
         with ThreadPoolExecutor(max_workers=max_partition_workers) as executor:
             for common_prefix, files in datalists.items():
 
-                def _task(files=files) -> subprocess.CompletedProcess:
+                def _task(
+                    files: list[str] | Path = files,
+                ) -> subprocess.CompletedProcess:
                     with TemporaryDirectory() as tmpdir:
-                        include_files_txt = Path(tmpdir) / "include_files.txt"
-                        include_files_txt.write_text("\n".join(files), encoding="utf-8")
+                        filelist: list[str] = []
+                        filepath: Path
+                        if isinstance(files, list):
+                            include_files_txt = Path(tmpdir) / "include_files.txt"
+                            include_files_txt.write_text(
+                                "\n".join(files), encoding="utf-8"
+                            )
+                            filelist = list(files)
+                            filepath = Path(include_files_txt)
+                        elif isinstance(files, Path):
+                            filelist = [
+                                f.strip()
+                                for f in files.read_text().splitlines()
+                                if f.strip()
+                            ]
+                            filepath = files
                         if common_prefix:
                             src_path = f"{src}/{common_prefix}"
                             dst_path = f"{dst}/{common_prefix}"
@@ -350,8 +373,8 @@ class Rclone:
                             dst_path = dst
 
                         if verbose:
-                            nfiles = len(files)
-                            files_fqdn = [f"  {src_path}/{f}" for f in files]
+                            nfiles = len(filelist)
+                            files_fqdn = [f"  {src_path}/{f}" for f in filelist]
                             print(f"Copying {nfiles} files:")
                             chunk_size = 100
                             for i in range(0, nfiles, chunk_size):
@@ -367,7 +390,7 @@ class Rclone:
                             src_path,
                             dst_path,
                             "--files-from",
-                            str(include_files_txt),
+                            str(filepath),
                             "--checkers",
                             str(checkers),
                             "--transfers",
@@ -426,13 +449,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:
@@ -522,7 +546,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.59 → rclone_api-1.0.61}/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.59 → rclone_api-1.0.61}/src/rclone_api.egg-info/PKG-INFO

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

{rclone_api-1.0.59 → rclone_api-1.0.61}/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.59 → rclone_api-1.0.61}/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)