rclone-api 1.0.3__py2.py3-none-any.whl → 1.0.5__py2.py3-none-any.whl

rclone_api/__init__.py

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

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_listing.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+
+from rclone_api.dir import Dir
+from rclone_api.file import File
+
+
+@dataclass
+class DirListing:
+    """Remote file dataclass."""
+
+    dirs: list[Dir]
+    files: list[File]

rclone_api/rclone.py

@@ -5,8 +5,12 @@ Unit test file.
 import subprocess
 from pathlib import Path
 
+from rclone_api.dir import Dir
+from rclone_api.dir_listing import DirListing
+from rclone_api.file import File
+from rclone_api.remote import Remote
 from rclone_api.rpath import RPath
-from rclone_api.types import Config, RcloneExec, Remote
+from rclone_api.types import Config, RcloneExec
 from rclone_api.util import get_rclone_exe
 
 
@@ -22,7 +26,7 @@ class Rclone:
     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]:
+    def ls(self, path: str | Remote, max_depth: int = 0) -> DirListing:
         """List files in the given path.
 
         Args:
@@ -39,10 +43,12 @@ class Rclone:
 
         cp = self._run(cmd)
         text = cp.stdout
-        out: list[RPath] = RPath.from_json_str(text)
-        for o in out:
+        paths: list[RPath] = RPath.from_json_str(text)
+        for o in paths:
             o.set_rclone(self)
-        return out
+        dirs: list[Dir] = [Dir(o) for o in paths if o.is_dir]
+        files: list[File] = [File(o) for o in paths if not o.is_dir]
+        return DirListing(dirs=dirs, files=files)
 
     def listremotes(self) -> list[Remote]:
         cmd = ["listremotes"]

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

@@ -1,5 +1,4 @@
 import json
-from pathlib import Path
 from typing import Any
 
 
@@ -73,41 +72,6 @@ class RPath:
             # "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.3.dist-info → rclone_api-1.0.5.dist-info}/METADATA

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

rclone_api-1.0.5.dist-info/RECORD

@@ -0,0 +1,17 @@
+rclone_api/__init__.py,sha256=YH7KQaPwUiJWJiRf0NRKD7XHhMXsxWdXDjt9WLSwdjA,265
+rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
+rclone_api/config.py,sha256=UujjDNcpwgipgdyFPMhC3zikvlsrurUvvZiwXm5NlPg,471
+rclone_api/dir.py,sha256=H83MhwabdxjBiT_3IHvAgo9taeXq6ZhOKIrpFOZwHnY,896
+rclone_api/dir_listing.py,sha256=N2tEcAx721r1HlV0Cax-sutkLJMW4AAofZMVA-Z_aQQ,206
+rclone_api/file.py,sha256=409neYPfCUKQX2w7Uw7_D0wR2PtH42srNe9u_nnOLxM,925
+rclone_api/rclone.py,sha256=J7pFhe4mHaN415yFP2k_9jr9UnrEiq3lDaKhefepVfA,2053
+rclone_api/remote.py,sha256=RSD-X2jCnm_hq7K6ovJ_0ugM1OpI0vpECIHHEz16-Fs,173
+rclone_api/rpath.py,sha256=_k59z-O75hAhpPyUSH4glPEoiYtIS3RUQb7ltU9Ianw,2009
+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.5.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.5.dist-info/METADATA,sha256=hq4p_iOF7VcpnDFFBcQU1G_ANEn4Ui0ei0RAjyTwCLQ,1244
+rclone_api-1.0.5.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.5.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.5.dist-info/RECORD,,

rclone_api-1.0.3.dist-info/RECORD

@@ -1,14 +0,0 @@
-rclone_api/__init__.py,sha256=ygZEO9GcF4UfdIDIinrfL2ExoWe3pWwKYIL8COeswe4,196
-rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
-rclone_api/dir.py,sha256=H83MhwabdxjBiT_3IHvAgo9taeXq6ZhOKIrpFOZwHnY,896
-rclone_api/file.py,sha256=409neYPfCUKQX2w7Uw7_D0wR2PtH42srNe9u_nnOLxM,925
-rclone_api/rclone.py,sha256=YlaWsWg-vtbqAOp1QbfZCIQ0KwfT3fkZQ3lZVR1nNmw,1743
-rclone_api/rpath.py,sha256=UQ08-crLe4t4IK1UCqijGybByj4vzRMY0vD7b5xYzMo,3237
-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.3.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.3.dist-info/METADATA,sha256=s-dUfLdnZCfaXSouGP_XypTADEUPub24idrl79fo21w,1244
-rclone_api-1.0.3.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.3.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.3.dist-info/RECORD,,