rclone-api 1.0.94__tar.gz → 1.0.98__tar.gz

{rclone_api-1.0.94 → rclone_api-1.0.98}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.94
+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.94 → rclone_api-1.0.98}/pyproject.toml

@@ -21,7 +21,7 @@ dependencies = [
 ]
 
 # Change this with the version number bump.
-version = "1.0.94"
+version = "1.0.98"
 
 [tool.setuptools]
 package-dir = {"" = "src"}

{rclone_api-1.0.94 → rclone_api-1.0.98}/src/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-1.0.98/src/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-1.0.94 → rclone_api-1.0.98}/src/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.94 → rclone_api-1.0.98}/src/rclone_api/s3/api.py

@@ -17,9 +17,10 @@ _MIN_THRESHOLD_FOR_CHUNKING = 5 * 1024 * 1024
 
 
 class S3Client:
-    def __init__(self, credentials: S3Credentials):
+    def __init__(self, credentials: S3Credentials, verbose: bool = False) -> None:
+        self.verbose = verbose
         self.credentials: S3Credentials = credentials
-        self.client: BaseClient = create_s3_client(credentials)
+        self.client: BaseClient = create_s3_client(credentials, verbose=verbose)
 
     def list_bucket_contents(self, bucket_name: str) -> None:
         list_bucket_contents(self.client, bucket_name)
@@ -83,6 +84,7 @@ class S3Client:
             provider = self.credentials.provider.value
             region_name = self.credentials.region_name
             info_json = {
+                "bucket": bucket_name,
                 "key": key,
                 "access_key_id": access_key_id[:4] + "...",
                 "secret": secret[:4] + "...",

{rclone_api-1.0.94 → rclone_api-1.0.98}/src/rclone_api/s3/create.py

@@ -6,18 +6,19 @@ from botocore.config import Config
 
 from rclone_api.s3.types import S3Credentials, S3Provider
 
+_DEFAULT_BACKBLAZE_ENDPOINT = "https://s3.us-west-002.backblazeb2.com"
+
 
 # Create a Boto3 session and S3 client, this is back blaze specific.
 # Add a function if you want to use a different S3 provider.
 # If AWS support is added in a fork then please merge it back here.
-def _create_backblaze_s3_client(creds: S3Credentials) -> BaseClient:
+def _create_backblaze_s3_client(creds: S3Credentials, verbose: bool) -> BaseClient:
     """Create and return an S3 client."""
     region_name = creds.region_name
     access_key = creds.access_key_id
     secret_key = creds.secret_access_key
     endpoint_url = creds.endpoint_url
-    region_name = region_name or "https://s3.us-west-002.backblazeb2.com"
-
+    endpoint_url = endpoint_url or _DEFAULT_BACKBLAZE_ENDPOINT
     session = boto3.session.Session()  # type: ignore
     return session.client(
         service_name="s3",
@@ -26,6 +27,7 @@ def _create_backblaze_s3_client(creds: S3Credentials) -> BaseClient:
         endpoint_url=endpoint_url,
         config=Config(
             signature_version="s3v4",
+            region_name=region_name,
             # Note that BackBlase has a boko3 bug where it doesn't support the new
             # checksum header, the following line was an attempt of fix it on the newest
             # version of boto3, but it didn't work.
@@ -34,13 +36,16 @@ def _create_backblaze_s3_client(creds: S3Credentials) -> BaseClient:
     )
 
 
-def _create_unknown_s3_client(creds: S3Credentials) -> BaseClient:
+def _create_unknown_s3_client(creds: S3Credentials, verbose: bool) -> BaseClient:
     """Create and return an S3 client."""
     access_key = creds.access_key_id
     secret_key = creds.secret_access_key
     endpoint_url = creds.endpoint_url
     if (endpoint_url is not None) and not (endpoint_url.startswith("http")):
-        warnings.warn(f"Endpoint URL is schema niaive: {endpoint_url}, assuming HTTPS")
+        if verbose:
+            warnings.warn(
+                f"Endpoint URL is schema naive: {endpoint_url}, assuming HTTPS"
+            )
         endpoint_url = f"https://{endpoint_url}"
 
     session = boto3.session.Session()  # type: ignore
@@ -60,10 +65,14 @@ def _create_unknown_s3_client(creds: S3Credentials) -> BaseClient:
     )
 
 
-def create_s3_client(credentials: S3Credentials) -> BaseClient:
+def create_s3_client(credentials: S3Credentials, verbose=False) -> BaseClient:
     """Create and return an S3 client."""
     provider = credentials.provider
     if provider == S3Provider.BACKBLAZE:
-        return _create_backblaze_s3_client(credentials)
+        if verbose:
+            print("Creating BackBlaze S3 client")
+        return _create_backblaze_s3_client(creds=credentials, verbose=verbose)
     else:
-        return _create_unknown_s3_client(credentials)
+        if verbose:
+            print("Creating generic/unknown S3 client")
+        return _create_unknown_s3_client(creds=credentials, verbose=verbose)

{rclone_api-1.0.94 → rclone_api-1.0.98}/src/rclone_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: rclone_api
-Version: 1.0.94
+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.94 → rclone_api-1.0.98}/src/rclone_api.egg-info/SOURCES.txt

@@ -50,6 +50,7 @@ src/rclone_api.egg-info/top_level.txt
 src/rclone_api/assets/example.txt
 src/rclone_api/cmd/copy_large_s3.py
 src/rclone_api/cmd/list_files.py
+src/rclone_api/experimental/flags.py
 src/rclone_api/s3/api.py
 src/rclone_api/s3/basic_ops.py
 src/rclone_api/s3/chunk_uploader.py