rclone-api 1.1.28__tar.gz → 1.1.30__tar.gz

{rclone_api-1.1.28 → rclone_api-1.1.30}/PKG-INFO

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

{rclone_api-1.1.28 → rclone_api-1.1.30}/pyproject.toml

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

{rclone_api-1.1.28 → rclone_api-1.1.30}/src/rclone_api/rclone.py

@@ -691,7 +691,7 @@ class Rclone:
         from rclone_api.util import S3PathInfo, random_str, split_s3_path
 
         other_args: list[str] = ["--no-modtime", "--vfs-read-wait", "1s"]
-        chunk_size = chunk_size or SizeSuffix("128M")
+        chunk_size = chunk_size or SizeSuffix("64M")
         unit_chunk_size = chunk_size / read_threads
         vfs_read_chunk_size = unit_chunk_size
         vfs_read_chunk_size_limit = chunk_size
@@ -726,8 +726,6 @@ class Rclone:
             verbose=False,
             other_args=other_args,
         ):
-            # raise NotImplementedError("Not implemented yet")
-
             path_info: S3PathInfo = split_s3_path(dst)
             remote = path_info.remote
             bucket_name = path_info.bucket
@@ -813,6 +811,59 @@ class Rclone:
             )
             return out
 
+    def copy_bytes(
+        self,
+        src: str,
+        offset: int,
+        length: int,
+        transfers: int = 16,
+        outfile: (
+            Path | None
+        ) = None,  # If supplied then bytes are written to this file and success returns bytes(0)
+    ) -> bytes | Exception:
+        """Copy bytes from a file to another file."""
+        from rclone_api.util import random_str
+
+        tmp_mnt = Path("tmp_mnt") / random_str(12)
+        src_parent_path = Path(src).parent.as_posix()
+        src_file = Path(src).name
+        other_args: list[str] = ["--no-modtime", "--vfs-read-wait", "1s"]
+        unit_chunk_size = length
+        vfs_read_chunk_size = unit_chunk_size
+        vfs_read_chunk_size_limit = length
+        vfs_read_chunk_streams = transfers
+        vfs_disk_space_total_size = length
+        other_args += ["--vfs-read-chunk-size", str(vfs_read_chunk_size)]
+        other_args += ["--vfs-read-chunk-size-limit", str(vfs_read_chunk_size_limit)]
+        other_args += ["--vfs-read-chunk-streams", str(vfs_read_chunk_streams)]
+        other_args += ["--vfs-disk-space-total-size", str(vfs_disk_space_total_size)]
+        other_args += ["--read-only"]
+        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=False,
+                vfs_cache_mode="minimal",
+                other_args=other_args,
+            ):
+                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
     ) -> CompletedProcess:

{rclone_api-1.1.28 → rclone_api-1.1.30}/src/rclone_api.egg-info/PKG-INFO

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

{rclone_api-1.1.28 → rclone_api-1.1.30}/src/rclone_api.egg-info/SOURCES.txt

@@ -62,6 +62,7 @@ src/rclone_api/s3/types.py
 src/rclone_api/s3/upload_file_multipart.py
 tests/test_cmd_list_files.py
 tests/test_copy.py
+tests/test_copy_bytes.py
 tests/test_copy_file_resumable_s3.py
 tests/test_copy_files.py
 tests/test_diff.py

rclone_api-1.1.30/tests/test_copy_bytes.py

@@ -0,0 +1,97 @@
+"""
+Unit test file.
+"""
+
+import os
+import tempfile
+import unittest
+from pathlib import Path
+
+from dotenv import load_dotenv
+
+from rclone_api import Config, Rclone
+
+load_dotenv()
+
+BUCKET_NAME = os.getenv("BUCKET_NAME")  # Default if not in .env
+
+
+def _generate_rclone_config() -> Config:
+
+    # BUCKET_NAME = os.getenv("BUCKET_NAME", "TorrentBooks")  # Default if not in .env
+
+    # Load additional environment variables
+    BUCKET_KEY_SECRET = os.getenv("BUCKET_KEY_SECRET")
+    BUCKET_KEY_PUBLIC = os.getenv("BUCKET_KEY_PUBLIC")
+    # BUCKET_URL = os.getenv("BUCKET_URL")
+    BUCKET_URL = "sfo3.digitaloceanspaces.com"
+
+    config_text = f"""
+[dst]
+type = s3
+provider = DigitalOcean
+access_key_id = {BUCKET_KEY_PUBLIC}
+secret_access_key = {BUCKET_KEY_SECRET}
+endpoint = {BUCKET_URL}
+"""
+
+    out = Config(config_text)
+    return out
+
+
+class RcloneCopyBytesTester(unittest.TestCase):
+    """Test rclone functionality."""
+
+    def setUp(self) -> None:
+        """Check if all required environment variables are set before running tests."""
+        required_vars = [
+            "BUCKET_NAME",
+            "BUCKET_KEY_SECRET",
+            "BUCKET_KEY_PUBLIC",
+            "BUCKET_URL",
+        ]
+        missing = [var for var in required_vars if not os.getenv(var)]
+        if missing:
+            self.skipTest(
+                f"Missing required environment variables: {', '.join(missing)}"
+            )
+        os.environ["RCLONE_API_VERBOSE"] = "1"
+
+    def test_copy_bytes(self) -> None:
+        rclone = Rclone(_generate_rclone_config())
+        bytes_or_err: bytes | Exception = rclone.copy_bytes(
+            src="dst:rclone-api-unit-test/zachs_video/breaking_ai_mind.mp4",
+            offset=0,
+            length=1024 * 1024,
+        )
+        if isinstance(bytes_or_err, Exception):
+            print(bytes_or_err)
+            self.fail(f"Error: {bytes_or_err}")
+        assert isinstance(bytes_or_err, bytes)
+        self.assertEqual(
+            len(bytes_or_err), 1024 * 1024
+        )  # , f"Length: {len(bytes_or_err)}"
+
+    def test_copy_bytes_to_temp_file(self) -> None:
+
+        with tempfile.TemporaryDirectory() as tmpdir:
+            tmp = Path(tmpdir) / "tmp.mp4"
+            rclone = Rclone(_generate_rclone_config())
+            bytes_or_err: bytes | Exception = rclone.copy_bytes(
+                src="dst:rclone-api-unit-test/zachs_video/breaking_ai_mind.mp4",
+                offset=0,
+                length=1024 * 1024,
+                outfile=tmp,
+            )
+            if isinstance(bytes_or_err, Exception):
+                print(bytes_or_err)
+                self.fail(f"Error: {bytes_or_err}")
+            assert isinstance(bytes_or_err, bytes)
+            self.assertEqual(len(bytes_or_err), 0)
+            self.assertTrue(tmp.exists())
+            tmp_size = tmp.stat().st_size
+            self.assertEqual(tmp_size, 1024 * 1024)
+
+
+if __name__ == "__main__":
+    unittest.main()