rclone-api 1.1.45__py2.py3-none-any.whl → 1.1.47__py2.py3-none-any.whl

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):
@@ -32,6 +35,8 @@ class Mount:
             return
         self._closed = True
         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
@@ -179,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/profile/mount_copy_bytes.py

@@ -2,6 +2,7 @@
 Unit test file.
 """
 
+import argparse
 import os
 import shutil
 import time
@@ -14,6 +15,11 @@ from dotenv import load_dotenv
 from rclone_api import Config, Rclone, SizeSuffix
 
 
+@dataclass
+class Args:
+    direct_io: bool
+
+
 @dataclass
 class Credentials:
     BUCKET_KEY_SECRET: str
@@ -105,7 +111,12 @@ def _init() -> None:
 
 
 def _run_profile(
-    rclone: Rclone, src_file: str, transfers: int, size: int, log_dir: Path
+    rclone: Rclone,
+    src_file: str,
+    transfers: int,
+    size: int,
+    log_dir: Path,
+    direct_io: bool = True,
 ) -> None:
 
     mount_log = log_dir / f"mount_{SizeSuffix(size)}_threads_{transfers}.log"
@@ -119,7 +130,7 @@ def _run_profile(
         src=src_file,
         offset=0,
         length=size,
-        direct_io=True,
+        direct_io=direct_io,
         transfers=transfers,
         mount_log=mount_log,
     )
@@ -154,7 +165,7 @@ def _run_profile(
     print(f"Time: {diff:.1f} seconds")
 
 
-def test_profile_copy_bytes() -> None:
+def test_profile_copy_bytes(args: Args) -> None:
     print("Running test_profile_copy_bytes")
     config, creds = _generate_rclone_config()
     print("Config:")
@@ -179,7 +190,7 @@ 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"
+    mount_root_path = Path("rclone_logs") / "mount"
     if mount_root_path.exists():
         shutil.rmtree(mount_root_path)
 
@@ -190,15 +201,24 @@ def test_profile_copy_bytes() -> None:
                 src_file=src_file,
                 transfers=transfers,
                 size=size,
+                direct_io=args.direct_io,
                 log_dir=mount_root_path,
             )
     print("done")
 
 
+def _parse_args() -> Args:
+    parser = argparse.ArgumentParser(description="Profile copy_bytes")
+    parser.add_argument("--direct-io", help="Use direct IO", action="store_true")
+    args = parser.parse_args()
+    return Args(direct_io=args.direct_io)
+
+
 def main() -> None:
     """Main entry point."""
     _init()
-    test_profile_copy_bytes()
+    args = _parse_args()
+    test_profile_copy_bytes(args)
 
 
 if __name__ == "__main__":

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:
@@ -941,6 +948,9 @@ 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:
@@ -949,7 +959,13 @@ class Rclone:
             cmd_list += other_args
         proc = self._launch_process(cmd_list, log=log)
         mount_read_only = not allow_writes
-        mount: Mount = Mount(mount_path=outdir, process=proc, read_only=mount_read_only)
+        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
@@ -962,6 +978,8 @@ 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."""
@@ -973,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,
         )

{rclone_api-1.1.45.dist-info → rclone_api-1.1.47.dist-info}/METADATA

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

{rclone_api-1.1.45.dist-info → rclone_api-1.1.47.dist-info}/RECORD

@@ -11,9 +11,9 @@ rclone_api/exec.py,sha256=Pd7pUBd8ib5MzqvMybG2DQISPRbDRu20VjVRL2mLAVY,1076
 rclone_api/file.py,sha256=EP5yT2dZ0H2p7CY5n0y5k5pHhIliV25pm8KOwBklUTk,1863
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
 rclone_api/group_files.py,sha256=H92xPW9lQnbNw5KbtZCl00bD6iRh9yRbCuxku4j_3dg,8036
-rclone_api/mount.py,sha256=RgzGfJakHxgiTsLu0bFX4ZYIzr4GAdIH8CMlz-M-hsY,6267
+rclone_api/mount.py,sha256=_19IXIm3PHoXc78dIvFwkVT7QKp7Z0ian_bbhqF5Uq0,6723
 rclone_api/process.py,sha256=rBj_S86jC6nqCYop-jq8r9eMSteKeObxUrJMgH8LZvI,5084
-rclone_api/rclone.py,sha256=-cMgLNykn4JFP83-sFeVWArFl28173LXgdWvpPr0_rE,42933
+rclone_api/rclone.py,sha256=ODHPq1OKKzOUgi7QPDc1UZHZLSoG9SkxnT1MXpoggx4,43823
 rclone_api/remote.py,sha256=O9WDUFQy9f6oT1HdUbTixK2eg0xtBBm8k4Xl6aa6K00,431
 rclone_api/rpath.py,sha256=8ZA_1wxWtskwcy0I8V2VbjKDmzPkiWd8Q2JQSvh-sYE,2586
 rclone_api/scan_missing_folders.py,sha256=Kulca2Q6WZodt00ATFHkmqqInuoPvBkhTcS9703y6po,4740
@@ -25,7 +25,7 @@ rclone_api/cmd/copy_large_s3.py,sha256=-rfedi-ZzPUdCSP8ai9LRL0y1xVkvN-viQQlk8HVU
 rclone_api/cmd/list_files.py,sha256=x8FHODEilwKqwdiU1jdkeJbLwOqUkUQuDWPo2u_zpf0,741
 rclone_api/experimental/flags.py,sha256=qCVD--fSTmzlk9hloRLr0q9elzAOFzPsvVpKM3aB1Mk,2739
 rclone_api/experimental/flags_base.py,sha256=ajU_czkTcAxXYU-SlmiCfHY7aCQGHvpCLqJ-Z8uZLk0,2102
-rclone_api/profile/mount_copy_bytes.py,sha256=6hJJ7jo8brFzq-t96JCjQeCIYnzYT1Km9vRL1jbUyLo,5897
+rclone_api/profile/mount_copy_bytes.py,sha256=Jc7AKjX37W6S7ramFFKdcA0l6oeuK2mJi00w50rERew,6351
 rclone_api/s3/api.py,sha256=qxtRDUpHYqJ7StJRtP8U_PbF_BvYRg705568SyvF-R0,3770
 rclone_api/s3/basic_ops.py,sha256=hK3366xhVEzEcjz9Gk_8lFx6MRceAk72cax6mUrr6ko,2104
 rclone_api/s3/chunk_file.py,sha256=D6wM9Nuu73LNGC8JCCfevqjF3qdZ21mQxYQClFLZLMU,3726
@@ -33,9 +33,9 @@ rclone_api/s3/chunk_types.py,sha256=LbXayXY1KgVU1LkdbASD_BQ7TpVpwVnzMjtz--8LBaE,
 rclone_api/s3/create.py,sha256=wgfkapv_j904CfKuWyiBIWJVxfAx_ftemFSUV14aT68,3149
 rclone_api/s3/types.py,sha256=yBnJ38Tjk6RlydJ-sqZ7DSfyFloy8KDYJ0mv3vlOzLE,1388
 rclone_api/s3/upload_file_multipart.py,sha256=y9azNAU8QH5Ovwz33V2HZwNmJdlFjJg-jrXLZ1gtMds,10364
-rclone_api-1.1.45.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.1.45.dist-info/METADATA,sha256=ZLx1uXz3hoeN194vwCxzj98SdfbBtdfRAeDtMKqafE0,4537
-rclone_api-1.1.45.dist-info/WHEEL,sha256=rF4EZyR2XVS6irmOHQIJx2SUqXLZKRMUrjsg8UwN-XQ,109
-rclone_api-1.1.45.dist-info/entry_points.txt,sha256=TV8kwP3FRzYwUEr0RLC7aJh0W03SAefIJNXTJ-FdMIQ,200
-rclone_api-1.1.45.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.1.45.dist-info/RECORD,,
+rclone_api-1.1.47.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.1.47.dist-info/METADATA,sha256=M-oXvo69uIDQy-0571dGJTfxay9-gTq3x3Q8ZNS2rRo,4537
+rclone_api-1.1.47.dist-info/WHEEL,sha256=rF4EZyR2XVS6irmOHQIJx2SUqXLZKRMUrjsg8UwN-XQ,109
+rclone_api-1.1.47.dist-info/entry_points.txt,sha256=TV8kwP3FRzYwUEr0RLC7aJh0W03SAefIJNXTJ-FdMIQ,200
+rclone_api-1.1.47.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.1.47.dist-info/RECORD,,