rclone-api 1.0.14__tar.gz → 1.0.15__tar.gz

{rclone_api-1.0.14/src/rclone_api.egg-info → rclone_api-1.0.15}/PKG-INFO

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

{rclone_api-1.0.14 → rclone_api-1.0.15}/pyproject.toml

@@ -14,7 +14,7 @@ dependencies = [
     "python-dotenv>=1.0.0"
 ]
 # Change this with the version number bump.
-version = "1.0.14"
+version = "1.0.15"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api/__init__.py

@@ -2,8 +2,18 @@ from .config import Config
 from .dir import Dir
 from .dir_listing import DirListing
 from .file import File
+from .filelist import FileList
 from .rclone import Rclone
 from .remote import Remote
 from .rpath import RPath
 
-__all__ = ["Rclone", "File", "Config", "Remote", "Dir", "RPath", "DirListing"]
+__all__ = [
+    "Rclone",
+    "File",
+    "Config",
+    "Remote",
+    "Dir",
+    "RPath",
+    "DirListing",
+    "FileList",
+]

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api/exec.py

@@ -12,8 +12,8 @@ class RcloneExec:
     rclone_config: Path | Config
     rclone_exe: Path
 
-    def execute(self, cmd: list[str]) -> subprocess.CompletedProcess:
+    def execute(self, cmd: list[str], check: bool) -> subprocess.CompletedProcess:
         """Execute rclone command."""
         from rclone_api.util import rclone_execute
 
-        return rclone_execute(cmd, self.rclone_config, self.rclone_exe)
+        return rclone_execute(cmd, self.rclone_config, self.rclone_exe, check=check)

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api/file.py

@@ -31,7 +31,7 @@ class File:
         if self.path.is_dir:
             raise RuntimeError("Cannot read a directory as bytes")
 
-        result = self.path.rclone._run(["cat", self.path.path])
+        result = self.path.rclone._run(["cat", self.path.path], check=True)
         return result.stdout
 
     def to_json(self) -> dict:

rclone_api-1.0.15/src/rclone_api/filelist.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+
+from rclone_api.dir import Dir
+from rclone_api.dir_listing import DirListing
+from rclone_api.file import File
+from rclone_api.rpath import RPath
+
+
+@dataclass
+class FileList:
+    """Remote file dataclass."""
+
+    dirs: list[Dir]
+    files: list[File]
+
+    def _to_dir_list(self) -> list[RPath]:
+        pathlist: list[RPath] = []
+        for d in self.dirs:
+            pathlist.append(d.path)
+        for f in self.files:
+            pathlist.append(f.path)
+        return pathlist
+
+    def __str__(self) -> str:
+        pathlist: list[RPath] = self._to_dir_list()
+        return str(DirListing(pathlist))
+
+    def __repr__(self) -> str:
+        pathlist: list[RPath] = self._to_dir_list()
+        return repr(DirListing(pathlist))

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api/rclone.py

@@ -14,6 +14,7 @@ from rclone_api.convert import convert_to_filestr_list, convert_to_str
 from rclone_api.dir_listing import DirListing
 from rclone_api.exec import RcloneExec
 from rclone_api.file import File
+from rclone_api.filelist import FileList
 from rclone_api.remote import Remote
 from rclone_api.rpath import RPath
 from rclone_api.util import get_rclone_exe, to_path
@@ -29,8 +30,8 @@ class Rclone:
                 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 _run(self, cmd: list[str], check: bool = True) -> subprocess.CompletedProcess:
+        return self._exec.execute(cmd, check=check)
 
     def ls(
         self,
@@ -63,7 +64,7 @@ class Rclone:
         remote = path.remote if isinstance(path, Dir) else path
         assert isinstance(remote, Remote)
 
-        cp = self._run(cmd)
+        cp = self._run(cmd, check=True)
         text = cp.stdout
         parent_path: str | None = None
         if isinstance(path, Dir):
@@ -159,30 +160,36 @@ class Rclone:
                 # self._run(cmd_list)
                 executor.submit(self._run, cmd_list)
 
-    def copy(self, src: Dir, dst: Dir) -> None:
+    def copy(
+        self, src: Dir | str, dst: Dir | str, filelist: FileList | None = None
+    ) -> subprocess.CompletedProcess:
         """Copy files from source to destination.
 
         Args:
             src: Source directory
             dst: Destination directory
         """
-        src_dir = src.path.path
-        dst_dir = dst.path.path
+        # src_dir = src.path.path
+        # dst_dir = dst.path.path
+        src_dir = convert_to_str(src)
+        dst_dir = convert_to_str(dst)
         cmd_list: list[str] = ["copy", src_dir, dst_dir]
-        self._run(cmd_list)
+        return self._run(cmd_list)
 
-    def purge(self, path: Dir | str) -> None:
+    def purge(self, path: Dir | str) -> subprocess.CompletedProcess:
         """Purge a directory"""
         # path should always be a string
         path = path if isinstance(path, str) else str(path.path)
         cmd_list: list[str] = ["purge", str(path)]
-        self._run(cmd_list)
+        return self._run(cmd_list)
 
-    def deletefiles(self, files: str | File | list[str] | list[File]) -> None:
+    def deletefiles(
+        self, files: str | File | list[str] | list[File]
+    ) -> subprocess.CompletedProcess:
         """Delete a directory"""
         payload: list[str] = convert_to_filestr_list(files)
         cmd_list: list[str] = ["delete"] + payload
-        self._run(cmd_list)
+        return self._run(cmd_list)
 
     def exists(self, path: Dir | Remote | str | File) -> bool:
         """Check if a file or directory exists."""
@@ -205,10 +212,23 @@ class Rclone:
         except subprocess.CalledProcessError:
             return False
 
-    def copy_dir(self, src: str | Dir, dst: str | Dir) -> None:
+    def copy_dir(
+        self, src: str | Dir, dst: str | Dir, args: list[str] | None = None
+    ) -> subprocess.CompletedProcess:
         """Copy a directory from source to destination."""
         # convert src to str, also dst
         src = convert_to_str(src)
         dst = convert_to_str(dst)
         cmd_list: list[str] = ["copy", src, dst]
-        self._run(cmd_list)
+        if args is not None:
+            cmd_list += args
+        return self._run(cmd_list)
+
+    def copy_remote(
+        self, src: Remote, dst: Remote, args: list[str] | None = None
+    ) -> subprocess.CompletedProcess:
+        """Copy a remote to another remote."""
+        cmd_list: list[str] = ["copy", str(src), str(dst)]
+        if args is not None:
+            cmd_list += args
+        return self._run(cmd_list)

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api/util.py

@@ -75,6 +75,7 @@ def rclone_execute(
     cmd: list[str],
     rclone_conf: Path | Config,
     rclone_exe: Path,
+    check: bool,
     verbose: bool | None = None,
 ) -> subprocess.CompletedProcess:
     tempdir: TemporaryDirectory | None = None
@@ -94,7 +95,7 @@ def rclone_execute(
             cmd_str = subprocess.list2cmdline(cmd)
             print(f"Running: {cmd_str}")
         cp = subprocess.run(
-            cmd, capture_output=True, encoding="utf-8", check=False, shell=False
+            cmd, capture_output=True, encoding="utf-8", check=check, shell=False
         )
         if cp.returncode != 0:
             cmd_str = subprocess.list2cmdline(cmd)

{rclone_api-1.0.14 → rclone_api-1.0.15/src/rclone_api.egg-info}/PKG-INFO

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

{rclone_api-1.0.14 → rclone_api-1.0.15}/src/rclone_api.egg-info/SOURCES.txt

@@ -28,6 +28,7 @@ src/rclone_api/dir.py
 src/rclone_api/dir_listing.py
 src/rclone_api/exec.py
 src/rclone_api/file.py
+src/rclone_api/filelist.py
 src/rclone_api/rclone.py
 src/rclone_api/remote.py
 src/rclone_api/rpath.py