rclone-api 1.1.44__tar.gz → 1.1.46__tar.gz

{rclone_api-1.1.44 → rclone_api-1.1.46}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.1.44
+Version: 1.1.46
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 License: BSD 3-Clause License

{rclone_api-1.1.44 → rclone_api-1.1.46}/pyproject.toml

@@ -23,7 +23,7 @@ dependencies = [
 ]
 
 # Change this with the version number bump.
-version = "1.1.44"
+version = "1.1.46"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

{rclone_api-1.1.44 → rclone_api-1.1.46}/src/rclone_api/mount.py

@@ -1,5 +1,6 @@
 import os
 import platform
+import shutil
 import subprocess
 import time
 import warnings
@@ -19,6 +20,8 @@ class Mount:
     mount_path: Path
     process: Process
     read_only: bool
+    cache_dir: Path | None = None
+    cache_dir_delete_on_exit: bool | None = None
     _closed: bool = False
 
     def __post_init__(self):
@@ -31,7 +34,15 @@ class Mount:
         if self._closed:
             return
         self._closed = True
-        clean_mount(self, verbose=False)
+        clean_mount(self, verbose=False, wait=wait)
+        if self.cache_dir and self.cache_dir_delete_on_exit:
+            _cache_dir_delete_on_exit(self.cache_dir)
+
+    def __enter__(self) -> "Mount":
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback) -> None:
+        self.close(wait=True)
 
     def __del__(self):
         self.close(wait=False)
@@ -173,3 +184,11 @@ def clean_mount(mount: Mount | Path, verbose: bool = False, wait=True) -> None:
     else:
         if verbose:
             print(f"{mount_path} successfully cleaned up.")
+
+
+def _cache_dir_delete_on_exit(cache_dir: Path) -> None:
+    if cache_dir.exists():
+        try:
+            shutil.rmtree(cache_dir)
+        except Exception as e:
+            warnings.warn(f"Error removing cache directory {cache_dir}: {e}")

{rclone_api-1.1.44 → rclone_api-1.1.46}/src/rclone_api/profile/mount_copy_bytes.py

@@ -3,6 +3,7 @@ Unit test file.
 """
 
 import os
+import shutil
 import time
 from dataclasses import dataclass
 from pathlib import Path
@@ -103,10 +104,11 @@ def _init() -> None:
     os.environ["RCLONE_API_VERBOSE"] = "1"
 
 
-def _run_profile(rclone: Rclone, src_file: str, transfers: int, size: int) -> None:
-    mount_log = (
-        Path("logs") / "mount" / f"mount_{SizeSuffix(size)}_threads_{transfers}.log"
-    )
+def _run_profile(
+    rclone: Rclone, src_file: str, transfers: int, size: int, log_dir: Path
+) -> None:
+
+    mount_log = log_dir / f"mount_{SizeSuffix(size)}_threads_{transfers}.log"
     print("\n\n")
     print("#" * 80)
     print(f"# Started test download of {SizeSuffix(size)} with {transfers} transfers")
@@ -177,10 +179,18 @@ def test_profile_copy_bytes() -> None:
     # sftp mount
     src_file = "src:aa_misc_data/aa_misc_data/world_lending_library_2024_11.tar.zst"
 
+    mount_root_path = Path("logs") / "mount"
+    if mount_root_path.exists():
+        shutil.rmtree(mount_root_path)
+
     for size in sizes:
         for transfers in transfer_list:
             _run_profile(
-                rclone=rclone, src_file=src_file, transfers=transfers, size=size
+                rclone=rclone,
+                src_file=src_file,
+                transfers=transfers,
+                size=size,
+                log_dir=mount_root_path,
             )
     print("done")
 

{rclone_api-1.1.44 → rclone_api-1.1.46}/src/rclone_api/rclone.py

@@ -852,30 +852,35 @@ class Rclone:
         if direct_io:
             other_args += ["--direct-io"]
 
-        try:
-            # use scoped mount to do the read, then write the bytes to the destination
-            with self.scoped_mount(
-                src_parent_path,
-                tmp_mnt,
-                use_links=True,
-                verbose=mount_log is not None,
-                vfs_cache_mode="minimal",
-                other_args=other_args,
-                log=mount_log,
-            ):
-                src_file_mnt = tmp_mnt / src_file
-                with open(src_file_mnt, "rb") as f:
-                    f.seek(offset)
-                    data = f.read(length)
-                    if outfile is None:
-                        return data
-                    with open(outfile, "wb") as out:
-                        out.write(data)
-                        del data
-                    return bytes(0)
-
-        except Exception as e:
-            return e
+        with TemporaryDirectory() as tmpdir:
+            cache_dir = Path(tmpdir) / "cache"
+            other_args += ["--cache-dir", str(cache_dir.absolute())]
+            try:
+                # use scoped mount to do the read, then write the bytes to the destination
+                with self.scoped_mount(
+                    src_parent_path,
+                    tmp_mnt,
+                    use_links=True,
+                    verbose=mount_log is not None,
+                    vfs_cache_mode="minimal",
+                    other_args=other_args,
+                    log=mount_log,
+                    cache_dir=cache_dir,
+                    cache_dir_delete_on_exit=True,
+                ):
+                    src_file_mnt = tmp_mnt / src_file
+                    with open(src_file_mnt, "rb") as f:
+                        f.seek(offset)
+                        data = f.read(length)
+                        if outfile is None:
+                            return data
+                        with open(outfile, "wb") as out:
+                            out.write(data)
+                            del data
+                        return bytes(0)
+
+            except Exception as e:
+                return e
 
     def copy_dir(
         self, src: str | Dir, dst: str | Dir, args: list[str] | None = None
@@ -909,6 +914,8 @@ class Rclone:
         use_links: bool | None = None,
         vfs_cache_mode: str | None = None,
         verbose: bool | None = None,
+        cache_dir: Path | None = None,
+        cache_dir_delete_on_exit: bool | None = None,
         log: Path | None = None,
         other_args: list[str] | None = None,
     ) -> Mount:
@@ -931,6 +938,7 @@ class Rclone:
         vfs_cache_mode = vfs_cache_mode or "full"
         clean_mount(outdir, verbose=verbose)
         prepare_mount(outdir, verbose=verbose)
+        debug_fuse = log is not None
         src_str = convert_to_str(src)
         cmd_list: list[str] = ["mount", src_str, str(outdir)]
         if not allow_writes:
@@ -940,13 +948,24 @@ class Rclone:
         if vfs_cache_mode:
             cmd_list.append("--vfs-cache-mode")
             cmd_list.append(vfs_cache_mode)
+        if cache_dir:
+            cmd_list.append("--cache-dir")
+            cmd_list.append(str(cache_dir.absolute()))
+        if debug_fuse:
+            cmd_list.append("--debug-fuse")
         if verbose:
             cmd_list.append("-vvvv")
         if other_args:
             cmd_list += other_args
         proc = self._launch_process(cmd_list, log=log)
-        mount_read_only = "--read-only" in cmd_list  # hint to allow fast teardown
-        mount: Mount = Mount(mount_path=outdir, process=proc, read_only=mount_read_only)
+        mount_read_only = not allow_writes
+        mount: Mount = Mount(
+            mount_path=outdir,
+            process=proc,
+            read_only=mount_read_only,
+            cache_dir=cache_dir,
+            cache_dir_delete_on_exit=cache_dir_delete_on_exit,
+        )
         return mount
 
     @contextmanager
@@ -959,11 +978,12 @@ class Rclone:
         vfs_cache_mode: str | None = None,
         verbose: bool | None = None,
         log: Path | None = None,
+        cache_dir: Path | None = None,
+        cache_dir_delete_on_exit: bool | None = None,
         other_args: list[str] | None = None,
     ) -> Generator[Mount, None, None]:
         """Like mount, but can be used in a context manager."""
         error_happened = False
-        verbose = get_verbose(verbose)
         mount: Mount = self.mount(
             src,
             outdir,
@@ -971,6 +991,8 @@ class Rclone:
             use_links=use_links,
             vfs_cache_mode=vfs_cache_mode,
             verbose=verbose,
+            cache_dir=cache_dir,
+            cache_dir_delete_on_exit=cache_dir_delete_on_exit,
             log=log,
             other_args=other_args,
         )
@@ -982,7 +1004,7 @@ class Rclone:
             warnings.warn(f"Error in scoped_mount: {e}\n\nStack Trace:\n{stack_trace}")
             raise
         finally:
-            if not error_happened:
+            if not error_happened or (not allow_writes):
                 mount.close()
 
     # Settings optimized for s3.

{rclone_api-1.1.44 → rclone_api-1.1.46}/src/rclone_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.1.44
+Version: 1.1.46
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 License: BSD 3-Clause License