rclone-api 1.0.17__py2.py3-none-any.whl → 1.0.19__py2.py3-none-any.whl

rclone_api/dir.py

@@ -47,12 +47,14 @@ class Dir:
         dir = Dir(self.path)
         return self.path.rclone.ls(dir, max_depth=max_depth)
 
-    def walk(self, max_depth: int = -1) -> Generator[DirListing, None, None]:
+    def walk(
+        self, breadth_first: bool, max_depth: int = -1
+    ) -> Generator[DirListing, None, None]:
         """List files and directories in the given path."""
         from rclone_api.walk import walk
 
         assert self.path.rclone is not None
-        return walk(self, max_depth=max_depth)
+        return walk(self, breadth_first=breadth_first, max_depth=max_depth)
 
     def to_json(self) -> dict:
         """Convert the Dir to a JSON serializable dictionary."""

rclone_api/process.py

@@ -69,8 +69,10 @@ class Process:
             tmpfile = Path(self.tempdir.name) / "rclone.conf"
             tmpfile.write_text(args.rclone_conf.text, encoding="utf-8")
             rclone_conf = tmpfile
+            self.needs_cleanup = True
         else:
             rclone_conf = args.rclone_conf
+            self.needs_cleanup = False
 
         assert rclone_conf.exists()
 
@@ -85,7 +87,7 @@ class Process:
         self.process = subprocess.Popen(self.cmd, shell=False)
 
     def cleanup(self) -> None:
-        if self.tempdir:
+        if self.tempdir and self.needs_cleanup:
             try:
                 self.tempdir.cleanup()
             except Exception as e:

rclone_api/rclone.py

@@ -38,6 +38,12 @@ class Rclone:
     def _launch_process(self, cmd: list[str]) -> Process:
         return self._exec.launch_process(cmd)
 
+    def obscure(self, password: str) -> str:
+        """Obscure a password for use in rclone config files."""
+        cmd_list: list[str] = ["obscure", password]
+        cp = self._run(cmd_list)
+        return cp.stdout.strip()
+
     def ls(
         self,
         path: Dir | Remote | str,
@@ -61,8 +67,9 @@ class Rclone:
 
         cmd = ["lsjson"]
         if max_depth is not None:
-            cmd.append("--recursive")
-            if max_depth > -1:
+            if max_depth < 0:
+                cmd.append("--recursive")
+            if max_depth > 0:
                 cmd.append("--max-depth")
                 cmd.append(str(max_depth))
         cmd.append(str(path))
@@ -96,7 +103,7 @@ class Rclone:
         return out
 
     def walk(
-        self, path: Dir | Remote | str, max_depth: int = -1
+        self, path: Dir | Remote | str, max_depth: int = -1, breadth_first: bool = True
     ) -> Generator[DirListing, None, None]:
         """Walk through the given path recursively.
 
@@ -107,6 +114,7 @@ class Rclone:
         Yields:
             DirListing: Directory listing for each directory encountered
         """
+        dir_obj: Dir
         if isinstance(path, Dir):
             # Create a Remote object for the path
             remote = path.remote
@@ -126,9 +134,10 @@ class Rclone:
         elif isinstance(path, Remote):
             dir_obj = Dir(path)
         else:
+            dir_obj = Dir(path)  # shut up pyright
             assert f"Invalid type for path: {type(path)}"
 
-        yield from walk(dir_obj, max_depth=max_depth)
+        yield from walk(dir_obj, max_depth=max_depth, breadth_first=breadth_first)
 
     def copyfile(self, src: File | str, dst: File | str) -> None:
         """Copy a single file from source to destination.
@@ -239,7 +248,13 @@ class Rclone:
         return self._run(cmd_list)
 
     def mount(
-        self, src: Remote | Dir | str, outdir: Path, allow_writes=False, use_links=True
+        self,
+        src: Remote | Dir | str,
+        outdir: Path,
+        allow_writes=False,
+        use_links=True,
+        vfs_cache_mode="full",
+        other_cmds: list[str] | None = None,
     ) -> Process:
         """Mount a remote or directory to a local path.
 
@@ -266,8 +281,85 @@ class Rclone:
             cmd_list.append("--read-only")
         if use_links:
             cmd_list.append("--links")
+        if vfs_cache_mode:
+            cmd_list.append("--vfs-cache-mode")
+            cmd_list.append(vfs_cache_mode)
+        if other_cmds:
+            cmd_list += other_cmds
         proc = self._launch_process(cmd_list)
         time.sleep(2)  # give it a moment to mount
         if proc.poll() is not None:
             raise ValueError("Mount process failed to start")
         return proc
+
+    def mount_webdav(
+        self,
+        url: str,
+        outdir: Path,
+        vfs_cache_mode="full",
+        other_cmds: list[str] | None = None,
+    ) -> Process:
+        """Mount a remote or directory to a local path.
+
+        Args:
+            src: Remote or directory to mount
+            outdir: Local path to mount to
+
+        Returns:
+            CompletedProcess from the mount command execution
+
+        Raises:
+            subprocess.CalledProcessError: If the mount operation fails
+        """
+        if outdir.exists():
+            is_empty = not list(outdir.iterdir())
+            if not is_empty:
+                raise ValueError(
+                    f"Mount directory already exists and is not empty: {outdir}"
+                )
+            outdir.rmdir()
+
+        src_str = url
+        cmd_list: list[str] = ["mount", src_str, str(outdir)]
+        cmd_list.append("--vfs-cache-mode")
+        cmd_list.append(vfs_cache_mode)
+        if other_cmds:
+            cmd_list += other_cmds
+        proc = self._launch_process(cmd_list)
+        # proc = rclone_exec.launch_process(cmd_list)
+        time.sleep(2)
+        if proc.poll() is not None:
+            raise ValueError("Mount process failed to start")
+        return proc
+
+    def serve_webdav(
+        self,
+        src: Remote | Dir | str,
+        user: str,
+        password: str,
+        addr: str = "localhost:2049",
+        allow_other: bool = False,
+    ) -> Process:
+        """Serve a remote or directory via NFS.
+
+        Args:
+            src: Remote or directory to serve
+            addr: Network address and port to serve on (default: localhost:2049)
+            allow_other: Allow other users to access the share
+
+        Returns:
+            Process: The running NFS server process
+
+        Raises:
+            ValueError: If the NFS server fails to start
+        """
+        src_str = convert_to_str(src)
+        cmd_list: list[str] = ["serve", "webdav", "--addr", addr, src_str]
+        cmd_list.extend(["--user", user, "--pass", password])
+        if allow_other:
+            cmd_list.append("--allow-other")
+        proc = self._launch_process(cmd_list)
+        time.sleep(2)  # give it a moment to start
+        if proc.poll() is not None:
+            raise ValueError("NFS serve process failed to start")
+        return proc

rclone_api/walk.py

@@ -9,9 +9,11 @@ from rclone_api.remote import Remote
 _MAX_OUT_QUEUE_SIZE = 50
 
 
-def _walk_runner(
-    queue: Queue[Dir], max_depth: int, out_queue: Queue[DirListing | None]
+def _walk_runner_breadth_first(
+    dir: Dir, max_depth: int, out_queue: Queue[DirListing | None]
 ) -> None:
+    queue: Queue[Dir] = Queue()
+    queue.put(dir)
     try:
         while not queue.empty():
             current_dir = queue.get()
@@ -35,7 +37,35 @@ def _walk_runner(
         _thread.interrupt_main()
 
 
-def walk(dir: Dir | Remote, max_depth: int = -1) -> Generator[DirListing, None, None]:
+def _walk_runner_depth_first(
+    dir: Dir, max_depth: int, out_queue: Queue[DirListing | None]
+) -> None:
+    try:
+        stack = [(dir, max_depth)]
+        while stack:
+            current_dir, depth = stack.pop()
+            dirlisting = current_dir.ls()
+            if depth != 0:
+                for subdir in reversed(
+                    dirlisting.dirs
+                ):  # Process deeper directories first
+                    # stack.append((child, depth - 1 if depth > 0 else depth))
+                    next_depth = depth - 1 if depth > 0 else depth
+                    _walk_runner_depth_first(subdir, next_depth, out_queue)
+            out_queue.put(dirlisting)
+        out_queue.put(None)
+    except KeyboardInterrupt:
+        import _thread
+
+        out_queue.put(None)
+        _thread.interrupt_main()
+
+
+def walk(
+    dir: Dir | Remote,
+    breadth_first: bool,
+    max_depth: int = -1,
+) -> Generator[DirListing, None, None]:
     """Walk through the given directory recursively.
 
     Args:
@@ -49,14 +79,17 @@ def walk(dir: Dir | Remote, max_depth: int = -1) -> Generator[DirListing, None,
         # Convert Remote to Dir if needed
         if isinstance(dir, Remote):
             dir = Dir(dir)
-
-        in_queue: Queue[Dir] = Queue()
         out_queue: Queue[DirListing] = Queue(maxsize=_MAX_OUT_QUEUE_SIZE)
-        in_queue.put(dir)
+
+        strategy = (
+            _walk_runner_breadth_first if breadth_first else _walk_runner_depth_first
+        )
 
         # Start worker thread
         worker = Thread(
-            target=_walk_runner, args=(in_queue, max_depth, out_queue), daemon=True
+            target=strategy,
+            args=(dir, max_depth, out_queue),
+            daemon=True,
         )
         worker.start()
 

{rclone_api-1.0.17.dist-info → rclone_api-1.0.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.17
+Version: 1.0.19
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 Maintainer: Zachary Vorhies
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: pyright>=1.1.393
 Requires-Dist: python-dotenv>=1.0.0
 Dynamic: home-page
 Dynamic: maintainer

{rclone_api-1.0.17.dist-info → rclone_api-1.0.19.dist-info}/RECORD

@@ -2,20 +2,20 @@ rclone_api/__init__.py,sha256=UWQMbhE4WOQ3Skfb0LagFKW8PUKUGOm9_T3z--5FHiY,388
 rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
 rclone_api/config.py,sha256=tP6cU9DnCCEIRc_KP9HPur1jFLLg2QGFSxNwFm6_MVw,118
 rclone_api/convert.py,sha256=Mx9Qo7zhkOedJd8LdhPvNGHp8znJzOk4f_2KWnoGc78,1012
-rclone_api/dir.py,sha256=xUV4i9_E7QHrqHld2IPBlon1CGaAp8qQYMKfJTyVvoQ,2088
+rclone_api/dir.py,sha256=vV-bcI2ESijmwF5rPID5WO2K7soAfZa35wv4KRh_GIo,2154
 rclone_api/dir_listing.py,sha256=8t5Jx9ZVOJPqGKTJbWaES6bjgogUT2bnpbPVWwK1Fcs,1124
 rclone_api/exec.py,sha256=9qSOpZo8YRYxv3hOvNr57ApnY2KbjxwT1QNr8OgcLM4,883
 rclone_api/file.py,sha256=D02iHJW1LhfOiM_R_yPHP8_ApnDiYrkuraVcrV8-qkw,1246
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
-rclone_api/process.py,sha256=QLI-65R4Jvov9oOJSVY5UpDOS2xj6m-9YCg8upR4-0M,3560
-rclone_api/rclone.py,sha256=hvzo5zZmP5IQAtuwLcsTeeazDY0slqz76DdulV2mn3s,9640
+rclone_api/process.py,sha256=C7vdGEvIKcI4fx-Z702wK1qomzSsFpdke2SQnBHxd-Y,3660
+rclone_api/rclone.py,sha256=PTHimJPPqRe-iSqe08zv1FrFB_H2T1eD3Y0WgshEye8,12730
 rclone_api/remote.py,sha256=c9hlRKBCg1BFB9MCINaQIoCg10qyAkeqiS4brl8ce-8,343
 rclone_api/rpath.py,sha256=8ZA_1wxWtskwcy0I8V2VbjKDmzPkiWd8Q2JQSvh-sYE,2586
 rclone_api/util.py,sha256=BDRJ2MIceDoKVTjUQBwyhjbA8UwPrZ-0ZSa9xyMJd0E,3343
-rclone_api/walk.py,sha256=J78-bY2AhNpt2ICsI5LqmXRE7oC6wVDoKoicIoU6XMg,1953
+rclone_api/walk.py,sha256=kca0t1GAnF6FLclN01G8NG__Qe-ggodLtAbQSHyVPng,2968
 rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
-rclone_api-1.0.17.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.17.dist-info/METADATA,sha256=9_ahew4G4YXDjXQljGkoA8s1KZa76mPrv3TZ99c2Xo4,4421
-rclone_api-1.0.17.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
-rclone_api-1.0.17.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.17.dist-info/RECORD,,
+rclone_api-1.0.19.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.19.dist-info/METADATA,sha256=MFSLZe61zLT-ZKKoPb9UiN-r0A-ZbFzQvmo8S-FUnuc,4454
+rclone_api-1.0.19.dist-info/WHEEL,sha256=9Hm2OB-j1QcCUq9Jguht7ayGIIZBRTdOXD1qg9cCgPM,109
+rclone_api-1.0.19.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.19.dist-info/RECORD,,