rclone-api 1.0.95__py2.py3-none-any.whl → 1.0.98__py2.py3-none-any.whl

rclone_api/cmd/copy_large_s3.py

@@ -16,6 +16,7 @@ class Args:
     read_concurrent_chunks: int
     retries: int
     save_state_json: Path
+    verbose: bool
 
 
 def list_files(rclone: Rclone, path: str):
@@ -29,6 +30,7 @@ def _parse_args() -> Args:
     parser = argparse.ArgumentParser(description="List files in a remote path.")
     parser.add_argument("src", help="File to copy")
     parser.add_argument("dst", help="Destination file")
+    parser.add_argument("-v", "--verbose", help="Verbose output", action="store_true")
     parser.add_argument(
         "--config", help="Path to rclone config file", type=Path, required=True
     )
@@ -58,6 +60,7 @@ def _parse_args() -> Args:
         read_concurrent_chunks=args.read_concurrent_chunks,
         retries=args.retries,
         save_state_json=args.resumable_json,
+        verbose=args.verbose,
     )
     return out
 
@@ -73,6 +76,7 @@ def main() -> int:
         concurrent_chunks=args.read_concurrent_chunks,
         retries=args.retries,
         save_state_json=args.save_state_json,
+        verbose=args.verbose,
     )
     print(rslt)
     return 0

rclone_api/experimental/flags.py

@@ -0,0 +1,93 @@
+from dataclasses import dataclass, field
+
+
+@dataclass
+class CopyFlags:
+    check_first: bool = False
+    checksum: bool = False
+    ignore_existing: bool = False
+    ignore_times: bool = False
+    immutable: bool = False
+    inplace: bool = False
+    links: bool = False
+    metadata: bool = False
+
+
+@dataclass
+class SyncFlags:
+    backup_dir: str | None = None
+    delete_after: bool = False
+    delete_before: bool = False
+    delete_during: bool = False
+    ignore_errors: bool = False
+    track_renames: bool = False
+
+
+@dataclass
+class ImportantFlags:
+    dry_run: bool = False
+    interactive: bool = False
+    verbose: int = 0  # 0 = default, 1 = -v, 2 = -vv, etc.
+
+
+@dataclass
+class NetworkingFlags:
+    bwlimit: str | None = None
+    timeout: str | None = "5m0s"
+    tpslimit: float | None = None
+    user_agent: str | None = "rclone/v1.69.1"
+
+
+@dataclass
+class PerformanceFlags:
+    buffer_size: str | None = "16MiB"
+    checkers: int = 8
+    transfers: int = 4
+
+
+@dataclass
+class ConfigFlags:
+    config: str | None = None
+    ask_password: bool = True
+    auto_confirm: bool = False
+
+
+@dataclass
+class DebuggingFlags:
+    cpuprofile: str | None = None
+    memprofile: str | None = None
+
+
+@dataclass
+class FilterFlags:
+    exclude: list[str] = field(default_factory=list)
+    include: list[str] = field(default_factory=list)
+    max_age: str | None = None
+    min_size: str | None = None
+
+
+@dataclass
+class ListingFlags:
+    fast_list: bool = False
+
+
+@dataclass
+class LoggingFlags:
+    log_file: str | None = None
+    log_level: str = "NOTICE"  # Options: DEBUG, INFO, NOTICE, ERROR
+    stats: str | None = "1m0s"
+    progress: bool = False
+
+
+@dataclass
+class Flags:
+    copy: CopyFlags | None = None
+    sync: SyncFlags | None = None
+    important: ImportantFlags | None = None
+    networking: NetworkingFlags | None = None
+    performance: PerformanceFlags | None = None
+    config: ConfigFlags | None = None
+    debugging: DebuggingFlags | None = None
+    filter: FilterFlags | None = None
+    listing: ListingFlags | None = None
+    logging: LoggingFlags | None = None

rclone_api/rclone.py

@@ -678,6 +678,7 @@ class Rclone:
         * 1024,  # This setting will scale the performance of the upload
         concurrent_chunks: int = 4,  # This setting will scale the performance of the upload
         retries: int = 3,
+        verbose: bool | None = None,
         max_chunks_before_suspension: int | None = None,
         mount_path: Path | None = None,
     ) -> MultiUploadResult:
@@ -710,6 +711,7 @@ class Rclone:
             mount_path,
             use_links=True,
             vfs_cache_mode="minimal",
+            verbose=verbose,
             other_args=other_args,
         ):
             # raise NotImplementedError("Not implemented yet")
@@ -743,7 +745,15 @@ class Rclone:
                     raise ValueError(f"Remote {remote} is not an S3 remote")
                 return S3Provider.S3.value
 
-            provider: str = get_provider_str() or S3Provider.S3.value
+            provider: str
+            if provided_provider_str := get_provider_str():
+                if verbose:
+                    print(f"Using provided provider: {provided_provider_str}")
+                provider = provided_provider_str
+            else:
+                if verbose:
+                    print(f"Using default provider: {S3Provider.S3.value}")
+                provider = S3Provider.S3.value
             provider_enum = S3Provider.from_str(provider)
 
             s3_creds: S3Credentials = S3Credentials(
@@ -820,6 +830,7 @@ class Rclone:
         allow_writes: bool | None = False,
         use_links: bool | None = None,
         vfs_cache_mode: str | None = None,
+        verbose: bool | None = None,
         other_args: list[str] | None = None,
     ) -> Process:
         """Mount a remote or directory to a local path.
@@ -836,6 +847,7 @@ class Rclone:
         """
         allow_writes = allow_writes or False
         use_links = use_links or True
+        verbose = get_verbose(verbose)
         vfs_cache_mode = vfs_cache_mode or "full"
         if outdir.exists():
             is_empty = not list(outdir.iterdir())
@@ -860,6 +872,8 @@ class Rclone:
         if vfs_cache_mode:
             cmd_list.append("--vfs-cache-mode")
             cmd_list.append(vfs_cache_mode)
+        if verbose:
+            cmd_list.append("-vvvv")
         if other_args:
             cmd_list += other_args
         proc = self._launch_process(cmd_list)
@@ -874,16 +888,19 @@ class Rclone:
         allow_writes: bool | None = None,
         use_links: bool | None = None,
         vfs_cache_mode: str | None = None,
+        verbose: bool | None = None,
         other_args: list[str] | None = None,
     ) -> Generator[Process, None, None]:
         """Like mount, but can be used in a context manager."""
         error_happened = False
+        verbose = get_verbose(verbose)
         proc = self.mount(
             src,
             outdir,
             allow_writes=allow_writes,
             use_links=use_links,
             vfs_cache_mode=vfs_cache_mode,
+            verbose=verbose,
             other_args=other_args,
         )
         try:
@@ -902,19 +919,32 @@ class Rclone:
                 if outdir.exists():
                     print(f"{outdir} mount still exists, attempting to remove")
                     if not _IS_WINDOWS:
-                        # attempt
-                        os.system(f"fusermount -u {outdir}")
-                        os.system(f"umount {outdir}")
+                        def exec(cmd: str) -> int:
+                            if verbose:
+                                print(f"Executing: {cmd}")
+                            rtn = os.system(cmd)
+                            if rtn != 0 and verbose:
+                                print(f"Failed to execute: {cmd}")
+                            return rtn
+
+                        exec(f"fusermount -u {outdir}")
+                        exec(f"umount {outdir}")
                         time.sleep(2)
                         if outdir.exists():
-                            is_empty = not list(outdir.iterdir())
-                            if not is_empty:
-                                warnings.warn(f"Failed to unmount {outdir}")
-                            else:
-                                try:
-                                    outdir.rmdir()
-                                except Exception as e:
-                                    warnings.warn(f"Failed to remove {outdir}: {e}")
+                            is_empty = True
+                            try:
+                                is_empty = not list(outdir.iterdir())
+                                if not is_empty:
+                                    warnings.warn(f"Failed to unmount {outdir}")
+                                else:
+                                    try:
+                                        outdir.rmdir()
+                                    except Exception as e:
+                                        warnings.warn(f"Failed to remove {outdir}: {e}")
+                            except Exception as e:
+                                warnings.warn(
+                                    f"Failed during mount cleanup of {outdir}: because {e}"
+                                )
 
     @deprecated("mount")
     def mount_webdav(

{rclone_api-1.0.95.dist-info → rclone_api-1.0.98.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.95
+Version: 1.0.98
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 License: BSD 3-Clause License

{rclone_api-1.0.95.dist-info → rclone_api-1.0.98.dist-info}/RECORD

@@ -12,7 +12,7 @@ rclone_api/file.py,sha256=EP5yT2dZ0H2p7CY5n0y5k5pHhIliV25pm8KOwBklUTk,1863
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
 rclone_api/group_files.py,sha256=H92xPW9lQnbNw5KbtZCl00bD6iRh9yRbCuxku4j_3dg,8036
 rclone_api/process.py,sha256=RrMfTe0bndmJ6gBK67ioqNvCstJ8aTC8RlGX1XBLlcw,4191
-rclone_api/rclone.py,sha256=tXVZv9N83DVVxVwevOo7FyzHCuUGjWx_KP51VwQ0QIY,42246
+rclone_api/rclone.py,sha256=eSQNNKS8tO0WHvbMKT_Ov1IIhUxsUy8L0KTOoPpVW-Y,43539
 rclone_api/remote.py,sha256=O9WDUFQy9f6oT1HdUbTixK2eg0xtBBm8k4Xl6aa6K00,431
 rclone_api/rpath.py,sha256=8ZA_1wxWtskwcy0I8V2VbjKDmzPkiWd8Q2JQSvh-sYE,2586
 rclone_api/scan_missing_folders.py,sha256=Kulca2Q6WZodt00ATFHkmqqInuoPvBkhTcS9703y6po,4740
@@ -20,16 +20,17 @@ rclone_api/types.py,sha256=NC3e78aXCx-sEQ-FqEaC9KzaJDdJhJrKa4Nwum_-Db0,563
 rclone_api/util.py,sha256=efck9W0rw5wfeRI35iiEz4dy2cMkNpVXrQ9zzynkBks,5185
 rclone_api/walk.py,sha256=-54NVE8EJcCstwDoaC_UtHm73R2HrZwVwQmsnv55xNU,3369
 rclone_api/assets/example.txt,sha256=lTBovRjiz0_TgtAtbA1C5hNi2ffbqnNPqkKg6UiKCT8,54
-rclone_api/cmd/copy_large_s3.py,sha256=FPU0S1Y9pApVLmWcdMT_3llywjEtOtwobXTnMXE-FhY,2690
+rclone_api/cmd/copy_large_s3.py,sha256=33KFvCrh5uk-rdRtkREdEs2WNwxGgTdCAWDLCE4dm0A,2855
 rclone_api/cmd/list_files.py,sha256=x8FHODEilwKqwdiU1jdkeJbLwOqUkUQuDWPo2u_zpf0,741
+rclone_api/experimental/flags.py,sha256=7sJyRU1vh5DgSdpFiv0gom2Aaw1-OP2v4PL5OXEruUo,2083
 rclone_api/s3/api.py,sha256=VstlaEnBjO2JDQuCRLdTfUGvQLbfshlXXhAzimFv4Vc,3763
 rclone_api/s3/basic_ops.py,sha256=hK3366xhVEzEcjz9Gk_8lFx6MRceAk72cax6mUrr6ko,2104
 rclone_api/s3/chunk_uploader.py,sha256=Wcm4h_A6ORaJvT9P9qSeknbJYch22RKZ4FGo1iePlAw,17385
 rclone_api/s3/create.py,sha256=SK3IGHZwsSkoG4Zb4NCphcVg9_f7VifDKng-tExMS2s,3088
 rclone_api/s3/types.py,sha256=81_3jwg6MGIxC-GxL-6zANzKO6au9C0BWvAqRyODxOM,1361
-rclone_api-1.0.95.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.0.95.dist-info/METADATA,sha256=0nmqVVyNS1ZG1FOKQ1HAsH1gg0h2MgTwXFSlUIERGL4,4479
-rclone_api-1.0.95.dist-info/WHEEL,sha256=rF4EZyR2XVS6irmOHQIJx2SUqXLZKRMUrjsg8UwN-XQ,109
-rclone_api-1.0.95.dist-info/entry_points.txt,sha256=6eNqTRXKhVf8CpWNjXiOa_0Du9tHiW_HD2iQSXRsUg8,132
-rclone_api-1.0.95.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.0.95.dist-info/RECORD,,
+rclone_api-1.0.98.dist-info/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.0.98.dist-info/METADATA,sha256=N3rINQp548v5kGCXCnQnS36fdiQME8ifJk4gAv2GaGU,4479
+rclone_api-1.0.98.dist-info/WHEEL,sha256=rF4EZyR2XVS6irmOHQIJx2SUqXLZKRMUrjsg8UwN-XQ,109
+rclone_api-1.0.98.dist-info/entry_points.txt,sha256=6eNqTRXKhVf8CpWNjXiOa_0Du9tHiW_HD2iQSXRsUg8,132
+rclone_api-1.0.98.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.0.98.dist-info/RECORD,,