rclone-api 1.0.2__py2.py3-none-any.whl → 1.0.4__py2.py3-none-any.whl

rclone_api/__init__.py

@@ -1,4 +1,8 @@
-from .rclone import File, Rclone
-from .types import Config, Remote
+from .dir import Dir
+from .file import File
+from .rclone import Rclone
+from .remote import Remote
+from .rpath import RPath
+from .types import Config
 
-__all__ = ["Rclone", "File", "Config", "Remote"]
+__all__ = ["Rclone", "File", "Config", "Remote", "Dir", "RPath"]

rclone_api/config.py

@@ -0,0 +1,19 @@
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+
+from rclone_api.types import Config
+
+
+@dataclass
+class RcloneExec:
+    """Rclone execution dataclass."""
+
+    rclone_config: Path | Config
+    rclone_exe: Path
+
+    def execute(self, cmd: list[str]) -> subprocess.CompletedProcess:
+        """Execute rclone command."""
+        from rclone_api.util import rclone_execute
+
+        return rclone_execute(cmd, self.rclone_config, self.rclone_exe)

rclone_api/dir.py

@@ -0,0 +1,27 @@
+from rclone_api.file import File
+from rclone_api.rpath import RPath
+
+
+class Dir:
+    """Remote file dataclass."""
+
+    def __init__(self, path: RPath) -> None:
+        self.path = path
+
+    def ls(self) -> tuple[list["Dir"], list[File]]:
+        """List files and directories in the given path."""
+        cmd = ["lsjson", "--files-only", "--dirs-only", "--json", str(self.path)]
+        assert self.path.rclone is not None
+        cp = self.path.rclone._run(cmd)
+        text = cp.stdout
+        tmp: list[RPath] = RPath.from_json_str(text)
+        for t in tmp:
+            t.set_rclone(self.path.rclone)
+        # dirs = [o for o in out if o.is_dir]
+        # files = [o for o in out if not o.is_dir]
+        dirs = [Dir(p) for p in tmp if p.is_dir]
+        files = [File(p) for p in tmp if not p.is_dir]
+        return dirs, files
+
+    def __str__(self) -> str:
+        return str(self.path)

rclone_api/file.py

@@ -1,77 +1,35 @@
-import json
-from typing import Any
-
-
-class File:
-    """Remote file dataclass."""
-
-    def __init__(
-        self,
-        path: str,
-        name: str,
-        size: int,
-        mime_type: str,
-        mod_time: str,
-        is_dir: bool,
-    ) -> None:
-        from rclone_api.rclone import Rclone
-
-        self.path = path
-        self.name = name
-        self.size = size
-        self.mime_type = mime_type
-        self.mod_time = mod_time
-        self.is_dir = is_dir
-        self.rclone: Rclone | None = None
-
-    def set_rclone(self, rclone: Any) -> None:
-        """Set the rclone object."""
-        from rclone_api.rclone import Rclone
-
-        assert isinstance(rclone, Rclone)
-        self.rclone = rclone
-
-    @staticmethod
-    def from_dict(data: dict) -> "File":
-        """Create a File from a dictionary."""
-        return File(
-            data["Path"],
-            data["Name"],
-            data["Size"],
-            data["MimeType"],
-            data["ModTime"],
-            data["IsDir"],
-            # data["IsBucket"],
-        )
-
-    @staticmethod
-    def from_array(data: list[dict]) -> list["File"]:
-        """Create a File from a dictionary."""
-        out: list[File] = []
-        for d in data:
-            file: File = File.from_dict(d)
-            out.append(file)
-        return out
-
-    @staticmethod
-    def from_json_str(json_str: str) -> list["File"]:
-        """Create a File from a JSON string."""
-        json_obj = json.loads(json_str)
-        if isinstance(json_obj, dict):
-            return [File.from_dict(json_obj)]
-        return File.from_array(json_obj)
-
-    def to_json(self) -> dict:
-        return {
-            "Path": self.path,
-            "Name": self.name,
-            "Size": self.size,
-            "MimeType": self.mime_type,
-            "ModTime": self.mod_time,
-            "IsDir": self.is_dir,
-            # "IsBucket": self.is_bucket,
-        }
-
-    def __str__(self) -> str:
-        out = self.to_json()
-        return json.dumps(out)
+import json
+
+from rclone_api.rpath import RPath
+
+
+class File:
+    """Remote file dataclass."""
+
+    def __init__(
+        self,
+        path: RPath,
+    ) -> None:
+        self.path = path
+
+    def read_text(self) -> str:
+        """Read the file contents as bytes.
+
+        Returns:
+            bytes: The file contents
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.path.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.path.is_dir:
+            raise RuntimeError("Cannot read a directory as bytes")
+
+        result = self.path.rclone._run(["cat", self.path.path])
+        return result.stdout
+
+    def __str__(self) -> str:
+        out = self.path.to_json()
+        return json.dumps(out)

rclone_api/rclone.py

@@ -1,43 +1,57 @@
-"""
-Unit test file.
-"""
-
-import subprocess
-from pathlib import Path
-
-from rclone_api.file import File
-from rclone_api.types import Config, RcloneExec, Remote
-from rclone_api.util import get_rclone_exe
-
-
-class Rclone:
-    def __init__(
-        self, rclone_conf: Path | Config, rclone_exe: Path | None = None
-    ) -> None:
-        if isinstance(rclone_conf, Path):
-            if not rclone_conf.exists():
-                raise ValueError(f"Rclone config file not found: {rclone_conf}")
-        self._exec = RcloneExec(rclone_conf, get_rclone_exe(rclone_exe))
-
-    def _run(self, cmd: list[str]) -> subprocess.CompletedProcess:
-        return self._exec.execute(cmd)
-
-    def ls(self, path: str | Remote) -> list[File]:
-        cmd = ["lsjson", str(path)]
-        cp = self._run(cmd)
-        text = cp.stdout
-        out: list[File] = File.from_json_str(text)
-        for o in out:
-            o.set_rclone(self)
-        return out
-
-    def listremotes(self) -> list[Remote]:
-        cmd = ["listremotes"]
-        cp = self._run(cmd)
-        text: str = cp.stdout
-        tmp = text.splitlines()
-        tmp = [t.strip() for t in tmp]
-        # strip out ":" from the end
-        tmp = [t.replace(":", "") for t in tmp]
-        out = [Remote(name=t) for t in tmp]
-        return out
+"""
+Unit test file.
+"""
+
+import subprocess
+from pathlib import Path
+
+from rclone_api.remote import Remote
+from rclone_api.rpath import RPath
+from rclone_api.types import Config, RcloneExec
+from rclone_api.util import get_rclone_exe
+
+
+class Rclone:
+    def __init__(
+        self, rclone_conf: Path | Config, rclone_exe: Path | None = None
+    ) -> None:
+        if isinstance(rclone_conf, Path):
+            if not rclone_conf.exists():
+                raise ValueError(f"Rclone config file not found: {rclone_conf}")
+        self._exec = RcloneExec(rclone_conf, get_rclone_exe(rclone_exe))
+
+    def _run(self, cmd: list[str]) -> subprocess.CompletedProcess:
+        return self._exec.execute(cmd)
+
+    def ls(self, path: str | Remote, max_depth: int = 0) -> list[RPath]:
+        """List files in the given path.
+
+        Args:
+            path: Remote path or Remote object to list
+            max_depth: Maximum recursion depth (0 means no recursion)
+
+        Returns:
+            List of File objects found at the path
+        """
+        cmd = ["lsjson"]
+        if max_depth > 0:
+            cmd.extend(["--recursive", "--max-depth", str(max_depth)])
+        cmd.append(str(path))
+
+        cp = self._run(cmd)
+        text = cp.stdout
+        out: list[RPath] = RPath.from_json_str(text)
+        for o in out:
+            o.set_rclone(self)
+        return out
+
+    def listremotes(self) -> list[Remote]:
+        cmd = ["listremotes"]
+        cp = self._run(cmd)
+        text: str = cp.stdout
+        tmp = text.splitlines()
+        tmp = [t.strip() for t in tmp]
+        # strip out ":" from the end
+        tmp = [t.replace(":", "") for t in tmp]
+        out = [Remote(name=t) for t in tmp]
+        return out

rclone_api/remote.py

@@ -0,0 +1,8 @@
+class Remote:
+    """Remote dataclass."""
+
+    def __init__(self, name: str) -> None:
+        self.name = name
+
+    def __str__(self) -> str:
+        return f"{self.name}:"

rclone_api/rpath.py

@@ -0,0 +1,113 @@
+import json
+from pathlib import Path
+from typing import Any
+
+
+class RPath:
+    """Remote file dataclass."""
+
+    def __init__(
+        self,
+        path: str,
+        name: str,
+        size: int,
+        mime_type: str,
+        mod_time: str,
+        is_dir: bool,
+    ) -> None:
+        from rclone_api.rclone import Rclone
+
+        self.path = path
+        self.name = name
+        self.size = size
+        self.mime_type = mime_type
+        self.mod_time = mod_time
+        self.is_dir = is_dir
+        self.rclone: Rclone | None = None
+
+    def set_rclone(self, rclone: Any) -> None:
+        """Set the rclone object."""
+        from rclone_api.rclone import Rclone
+
+        assert isinstance(rclone, Rclone)
+        self.rclone = rclone
+
+    @staticmethod
+    def from_dict(data: dict) -> "RPath":
+        """Create a File from a dictionary."""
+        return RPath(
+            data["Path"],
+            data["Name"],
+            data["Size"],
+            data["MimeType"],
+            data["ModTime"],
+            data["IsDir"],
+            # data["IsBucket"],
+        )
+
+    @staticmethod
+    def from_array(data: list[dict]) -> list["RPath"]:
+        """Create a File from a dictionary."""
+        out: list[RPath] = []
+        for d in data:
+            file: RPath = RPath.from_dict(d)
+            out.append(file)
+        return out
+
+    @staticmethod
+    def from_json_str(json_str: str) -> list["RPath"]:
+        """Create a File from a JSON string."""
+        json_obj = json.loads(json_str)
+        if isinstance(json_obj, dict):
+            return [RPath.from_dict(json_obj)]
+        return RPath.from_array(json_obj)
+
+    def to_json(self) -> dict:
+        return {
+            "Path": self.path,
+            "Name": self.name,
+            "Size": self.size,
+            "MimeType": self.mime_type,
+            "ModTime": self.mod_time,
+            "IsDir": self.is_dir,
+            # "IsBucket": self.is_bucket,
+        }
+
+    def read_text(self) -> str:
+        """Read the file contents as bytes.
+
+        Returns:
+            bytes: The file contents
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.is_dir:
+            raise RuntimeError("Cannot read a directory as bytes")
+
+        result = self.rclone._run(["cat", self.path])
+        return result.stdout
+
+    def read(self, dest: Path) -> None:
+        """Copy the remote file to a local destination path.
+
+        Args:
+            dest: Local destination path where the file will be copied
+
+        Raises:
+            RuntimeError: If no rclone instance is associated with this file
+            RuntimeError: If the path represents a directory
+        """
+        if self.rclone is None:
+            raise RuntimeError("No rclone instance associated with this file")
+        if self.is_dir:
+            raise RuntimeError("Cannot read a directory as a file")
+
+        self.rclone._run(["copyto", self.path, str(dest)])
+
+    def __str__(self) -> str:
+        out = self.to_json()
+        return json.dumps(out)

rclone_api/types.py

@@ -22,13 +22,3 @@ class RcloneExec:
         from rclone_api.util import rclone_execute
 
         return rclone_execute(cmd, self.rclone_config, self.rclone_exe)
-
-
-class Remote:
-    """Remote dataclass."""
-
-    def __init__(self, name: str) -> None:
-        self.name = name
-
-    def __str__(self) -> str:
-        return f"{self.name}:"

{rclone_api-1.0.2.dist-info → rclone_api-1.0.4.dist-info}/METADATA

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

rclone_api-1.0.4.dist-info/RECORD

@@ -0,0 +1,16 @@
+rclone_api/__init__.py,sha256=VPzZJdb7ZzYjUHV2cZc2rE6MMu_EI8KZn31b4FJSLZo,215
+rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
+rclone_api/config.py,sha256=UujjDNcpwgipgdyFPMhC3zikvlsrurUvvZiwXm5NlPg,471
+rclone_api/dir.py,sha256=H83MhwabdxjBiT_3IHvAgo9taeXq6ZhOKIrpFOZwHnY,896
+rclone_api/file.py,sha256=409neYPfCUKQX2w7Uw7_D0wR2PtH42srNe9u_nnOLxM,925
+rclone_api/rclone.py,sha256=-c9cskRzGT1t5uQjGg8T9puRAGeQqH9vt1sy5o0Cl_U,1773
+rclone_api/remote.py,sha256=RSD-X2jCnm_hq7K6ovJ_0ugM1OpI0vpECIHHEz16-Fs,173
+rclone_api/rpath.py,sha256=UQ08-crLe4t4IK1UCqijGybByj4vzRMY0vD7b5xYzMo,3237
+rclone_api/types.py,sha256=Yp15HrjwZonSQhE323R0WP7fA4NWqKjAfM7z3OwHpWI,518
+rclone_api/util.py,sha256=EXnijLLdFHqwoZvHrZdqeM8r6T7ad9-pN7qBN1b0I_g,1465
+rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
+rclone_api-1.0.4.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.4.dist-info/METADATA,sha256=5cimbaT1kOtrJwOmPl0ZlHWFtcukf6pf2O6a7nCmRjk,1244
+rclone_api-1.0.4.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.4.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.4.dist-info/RECORD,,

rclone_api-1.0.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-rclone_api/__init__.py,sha256=be1jguNsC4mSSJRrHeCJoC0rN8OnI4kEVpZmmKlq-1w,117
-rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
-rclone_api/file.py,sha256=7XirDJx3k37EBX78j_Y13rCs2lnGB8ID7A-s5kztQ2E,1999
-rclone_api/rclone.py,sha256=KXnIPbl-tvj8ZiG3HVhahCbZdPHEJG-5tbrN7eazX_g,1283
-rclone_api/types.py,sha256=I_7WSHF0INm-XA7jEWMsFiGkpXPNmij6B5exsFUKggI,693
-rclone_api/util.py,sha256=EXnijLLdFHqwoZvHrZdqeM8r6T7ad9-pN7qBN1b0I_g,1465
-rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
-rclone_api-1.0.2.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.2.dist-info/METADATA,sha256=4sPbtb1DX5n0gQaDoPDLHELayret5vUzeWl902l_lWE,1244
-rclone_api-1.0.2.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.2.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.2.dist-info/RECORD,,