rclone-api 1.0.44__tar.gz → 1.0.46__tar.gz

{rclone_api-1.0.44 → rclone_api-1.0.46}/PKG-INFO

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

{rclone_api-1.0.44 → rclone_api-1.0.46}/pyproject.toml

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

{rclone_api-1.0.44 → rclone_api-1.0.46}/src/rclone_api/__init__.py

@@ -5,7 +5,7 @@ from .dir_listing import DirListing
 from .file import File
 from .filelist import FileList
 from .process import Process
-from .rclone import Rclone
+from .rclone import Rclone, rclone_verbose
 from .remote import Remote
 from .rpath import RPath
 
@@ -21,4 +21,5 @@ __all__ = [
     "Process",
     "DiffItem",
     "DiffType",
+    "rclone_verbose",
 ]

{rclone_api-1.0.44 → rclone_api-1.0.46}/src/rclone_api/group_files.py

@@ -39,10 +39,10 @@ class TreeNode:
         self.count = 0
         self.parent = parent
 
-    def add_count(self):
+    def add_count_bubble_up(self):
         self.count += 1
         if self.parent:
-            self.parent.add_count()
+            self.parent.add_count_bubble_up()
 
     def get_path(self) -> str:
         paths_reversed: list[str] = [self.name]
@@ -85,9 +85,6 @@ def _merge(node: TreeNode, parent_path: str, out: dict[str, list[str]]) -> None:
     if node.files:
         # we saw files, to don't try to go any deeper.
         filelist = out.setdefault(parent_path, [])
-        # for file in node.files:
-        #    filelist.append(file)
-        # out[parent_path] = filelist
         paths = node.get_child_subpaths()
         for path in paths:
             filelist.append(path)
@@ -97,17 +94,11 @@ def _merge(node: TreeNode, parent_path: str, out: dict[str, list[str]]) -> None:
     n_child_nodes = len(node.child_nodes)
 
     if n_child_nodes <= 2:
-        # child = list(node.child_nodes.values())[0]
-        # _merge(child, parent_path, out)
-        # return
         for child in node.child_nodes.values():
             _merge(child, parent_path, out)
         return
 
     filelist = out.setdefault(parent_path, [])
-    # for file in node.files:
-    #    filelist.append(file)
-    # out[parent_path] = filelist
     paths = node.get_child_subpaths()
     for path in paths:
         filelist.append(path)
@@ -126,16 +117,12 @@ def _make_tree(files: list[str]) -> dict[str, TreeNode]:
             node = node.child_nodes.setdefault(parent, TreeNode(parent, parent=node))
             if is_last:
                 node.files.append(parts.name)
-                node.add_count()
+                node.add_count_bubble_up()
     return tree
 
 
-def group_files(files: list[str]) -> dict[str, list[str]]:
-    """split between filename and parent directory path"""
-    tree: dict[str, TreeNode] = _make_tree(files)
-    outpaths: dict[str, list[str]] = {}
-    for _, node in tree.items():
-        _merge(node, "", outpaths)
+#
+def _fixup_rclone_paths(outpaths: dict[str, list[str]]) -> dict[str, list[str]]:
     out: dict[str, list[str]] = {}
     for path, files in outpaths.items():
         # fixup path
@@ -145,3 +132,16 @@ def group_files(files: list[str]) -> dict[str, list[str]]:
         path = path.replace("/", ":", 1)
         out[path] = files
     return out
+
+
+def group_files(files: list[str]) -> dict[str, list[str]]:
+    """split between filename and parent directory path"""
+    tree: dict[str, TreeNode] = _make_tree(files)
+    outpaths: dict[str, list[str]] = {}
+    for _, node in tree.items():
+        _merge(node, "", outpaths)
+    out: dict[str, list[str]] = _fixup_rclone_paths(outpaths=outpaths)
+    return out
+
+
+__all__ = ["group_files"]

{rclone_api-1.0.44 → rclone_api-1.0.46}/src/rclone_api/rclone.py

@@ -2,6 +2,7 @@
 Unit test file.
 """
 
+import os
 import subprocess
 import time
 import warnings
@@ -36,6 +37,12 @@ from rclone_api.walk import walk
 EXECUTOR = ThreadPoolExecutor(16)
 
 
+def rclone_verbose(verbose: bool | None) -> bool:
+    if verbose is not None:
+        os.environ["RCLONE_API_VERBOSE"] = "1" if verbose else "0"
+    return bool(int(os.getenv("RCLONE_API_VERBOSE", "0")))
+
+
 class ModTimeStrategy(Enum):
     USE_SERVER_MODTIME = "use-server-modtime"
     NO_MODTIME = "no-modtime"
@@ -56,6 +63,13 @@ class Rclone:
     def _launch_process(self, cmd: list[str], capture: bool | None = None) -> Process:
         return self._exec.launch_process(cmd, capture=capture)
 
+    def webgui(self, other_args: list[str] | None = None) -> Process:
+        """Launch the Rclone web GUI."""
+        cmd = ["rcd", "--rc-web-gui"]
+        if other_args:
+            cmd += other_args
+        return self._launch_process(cmd, capture=False)
+
     def obscure(self, password: str) -> str:
         """Obscure a password for use in rclone config files."""
         cmd_list: list[str] = ["obscure", password]
@@ -178,6 +192,17 @@ class Rclone:
 
         yield from walk(dir_obj, max_depth=max_depth, breadth_first=breadth_first)
 
+    def cleanup(
+        self, path: str, other_args: list[str] | None = None
+    ) -> CompletedProcess:
+        """Cleanup any resources used by the Rclone instance."""
+        # rclone cleanup remote:path [flags]
+        cmd = ["cleanup", path]
+        if other_args:
+            cmd += other_args
+        out = self._run(cmd)
+        return CompletedProcess.from_subprocess(out)
+
     def copyfile(self, src: File | str, dst: File | str) -> None:
         """Copy a single file from source to destination.
 

{rclone_api-1.0.44 → rclone_api-1.0.46}/src/rclone_api.egg-info/PKG-INFO

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