rclone-api 1.5.13__py3-none-any.whl → 1.5.21__py3-none-any.whl

rclone_api/__init__.py

@@ -24,6 +24,7 @@ from .dir_listing import DirListing  # Directory contents representation
 from .file import File, FileItem  # File representation
 from .file_stream import FilesStream  # Streaming file listings
 from .filelist import FileList  # File list utilities
+from .fs import FSPath, RemoteFS  # Filesystem utilities
 from .http_server import HttpFetcher, HttpServer, Range  # HTTP serving capabilities
 
 # Import logging configuration utilities
@@ -119,6 +120,27 @@ class Rclone:
         """
         return self.impl.webgui(other_args=other_args)
 
+    def filesystem(self, src: str) -> RemoteFS:
+        """
+        Get a RealFS object for interacting with the local filesystem.
+
+        Returns:
+            RealFS object for local filesystem operations
+        """
+        return self.impl.filesystem(src=src)
+
+    def cwd(self, src: str) -> FSPath:
+        """
+        Get the local root path for a filesystem.
+
+        Args:
+            src: Source path for the filesystem
+
+        Returns:
+            FSPath object representing the root of the filesystem
+        """
+        return self.impl.cwd(src=src)
+
     def launch_server(
         self,
         addr: str,
@@ -841,7 +863,7 @@ class Rclone:
     def serve_http(
         self,
         src: str,
-        addr: str = "localhost:8080",
+        addr: str | None = None,
         other_args: list[str] | None = None,
     ) -> HttpServer:
         """

rclone_api/fs.py

@@ -0,0 +1,234 @@
+import abc
+import shutil
+from pathlib import Path
+
+from rclone_api.config import Config
+
+
+class FS(abc.ABC):
+    def __init__(self) -> None:
+        pass
+
+    @abc.abstractmethod
+    def copy(self, src: Path | str, dest: Path | str) -> None:
+        pass
+
+    @abc.abstractmethod
+    def read_binary(self, path: Path | str) -> bytes:
+        pass
+
+    @abc.abstractmethod
+    def exists(self, path: Path | str) -> bool:
+        pass
+
+    @abc.abstractmethod
+    def write_binary(self, path: Path | str, data: bytes) -> None:
+        pass
+
+    @abc.abstractmethod
+    def mkdir(self, path: str, parents=True, exist_ok=True) -> None:
+        pass
+
+    @abc.abstractmethod
+    def ls(self, path: Path | str) -> list[str]:
+        pass
+
+    @abc.abstractmethod
+    def cwd(self) -> "FSPath":
+        pass
+
+    @abc.abstractmethod
+    def get_path(self, path: str) -> "FSPath":
+        pass
+
+    def read_text(self, path: Path | str) -> str:
+        utf = self.read_binary(path)
+        return utf.decode("utf-8")
+
+    def write_text(self, path: Path | str, data: str, encoding: str | None) -> None:
+        encoding = encoding or "utf-8"
+        utf = data.encode(encoding)
+        self.write_binary(path, utf)
+
+
+class RealFS(FS):
+
+    @staticmethod
+    def from_path(path: Path | str) -> "FSPath":
+        path_str = Path(path).as_posix()
+        return FSPath(RealFS(), path_str)
+
+    def __init__(self) -> None:
+        super().__init__()
+
+    def ls(self, path: Path | str) -> list[str]:
+        return [str(p) for p in Path(path).iterdir()]
+
+    def cwd(self) -> "FSPath":
+        return RealFS.from_path(Path.cwd())
+
+    def copy(self, src: Path | str, dest: Path | str) -> None:
+        shutil.copy(str(src), str(dest))
+
+    def read_binary(self, path: Path | str) -> bytes:
+        with open(path, "rb") as f:
+            return f.read()
+
+    def write_binary(self, path: Path | str, data: bytes) -> None:
+        with open(path, "wb") as f:
+            f.write(data)
+
+    def exists(self, path: Path | str) -> bool:
+        return Path(path).exists()
+
+    def mkdir(self, path: str, parents=True, exist_ok=True) -> None:
+        Path(path).mkdir(parents=parents, exist_ok=exist_ok)
+
+    def get_path(self, path: str) -> "FSPath":
+        return FSPath(self, path)
+
+
+class RemoteFS(FS):
+
+    @staticmethod
+    def from_rclone_config(
+        src: str, rclone_conf: Path | Config | str | None
+    ) -> "RemoteFS":
+        if isinstance(rclone_conf, str):
+            rclone_conf = Config(text=rclone_conf)
+        if rclone_conf is None:
+            curr_dir = Path.cwd() / "rclone.conf"
+            if curr_dir.exists():
+                rclone_conf = curr_dir
+            else:
+                raise ValueError("rclone_conf not found")
+        return RemoteFS(rclone_conf, src)
+
+    def __init__(self, rclone_conf: Path | Config, src: str) -> None:
+        from rclone_api import HttpServer, Rclone
+
+        super().__init__()
+        self.src = src
+        self.rclone_conf = rclone_conf
+        self.rclone: Rclone = Rclone(rclone_conf)
+        self.server: HttpServer = self.rclone.serve_http(src=src)
+        self.shutdown = False
+
+    def root(self) -> "FSPath":
+        return FSPath(self, self.src)
+
+    def cwd(self) -> "FSPath":
+        return self.root()
+
+    def _to_str(self, path: Path | str) -> str:
+        if isinstance(path, Path):
+            return path.as_posix()
+        return path
+
+    def copy(self, src: Path | str, dest: Path | str) -> None:
+        src = self._to_str(src)
+        dest = self._to_str(dest)
+        self.rclone.copy(src, dest)
+
+    def read_binary(self, path: Path | str) -> bytes:
+        path = self._to_str(path)
+        err = self.rclone.read_bytes(path)
+        if isinstance(err, Exception):
+            raise FileNotFoundError(f"File not found: {path}")
+        return err
+
+    def write_binary(self, path: Path | str, data: bytes) -> None:
+        path = self._to_str(path)
+        self.rclone.write_bytes(data, path)
+
+    def exists(self, path: Path | str) -> bool:
+        path = self._to_str(path)
+        return self.server.exists(path)
+
+    def mkdir(self, path: str, parents=True, exist_ok=True) -> None:
+        raise NotImplementedError("RemoteFS does not support mkdir")
+
+    def is_dir(self, path: Path | str) -> bool:
+        path = self._to_str(path)
+        err = self.server.list(path)
+        return isinstance(err, list)
+
+    def is_file(self, path: Path | str) -> bool:
+        path = self._to_str(path)
+        err = self.server.list(path)
+        # Make faster.
+        return isinstance(err, Exception) and self.exists(path)
+
+    def ls(self, path: Path | str) -> list[str]:
+        path = self._to_str(path)
+        err = self.server.list(path)
+        if isinstance(err, Exception):
+            raise FileNotFoundError(f"File not found: {path}, because of {err}")
+        return err
+
+    def get_path(self, path: str) -> "FSPath":
+        return FSPath(self, path)
+
+    def dispose(self) -> None:
+        if self.shutdown:
+            return
+        self.shutdown = True
+        self.server.shutdown()
+
+    def __del__(self) -> None:
+        self.dispose()
+
+
+class FSPath:
+    def __init__(self, fs: FS, path: str) -> None:
+        self.fs = fs
+        self.path = path
+
+    def read_text(self) -> str:
+        return self.fs.read_text(self.path)
+
+    def read_binary(self) -> bytes:
+        return self.fs.read_binary(self.path)
+
+    def exists(self) -> bool:
+        return self.fs.exists(self.path)
+
+    def __str__(self) -> str:
+        return self.path
+
+    def __repr__(self) -> str:
+        return f"FSPath({self.path})"
+
+    def mkdir(self, parents=True, exist_ok=True) -> None:
+        self.fs.mkdir(self.path, parents=parents, exist_ok=exist_ok)
+
+    def write_text(self, data: str, encoding: str | None = None) -> None:
+        self.fs.write_text(self.path, data, encoding=encoding)
+
+    def rmtree(self, ignore_errors=False) -> None:
+        assert self.exists(), f"Path does not exist: {self.path}"
+        # check fs is RealFS
+        assert isinstance(self.fs, RealFS)
+        shutil.rmtree(self.path, ignore_errors=ignore_errors)
+
+    def ls(self) -> "list[FSPath]":
+        names: list[str] = self.fs.ls(self.path)
+        return [self / name for name in names]
+
+    @property
+    def name(self) -> str:
+        return Path(self.path).name
+
+    @property
+    def parent(self) -> "FSPath":
+        parent_path = Path(self.path).parent
+        parent_str = parent_path.as_posix()
+        return FSPath(self.fs, parent_str)
+
+    def __truediv__(self, other: str) -> "FSPath":
+        new_path = Path(self.path) / other
+        return FSPath(self.fs, new_path.as_posix())
+
+    # hashable
+    def __hash__(self) -> int:
+        return hash(f"{repr(self.fs)}:{self.path}")

rclone_api/http_server.py

@@ -11,6 +11,7 @@ from threading import Semaphore
 from typing import Any
 
 import httpx
+from bs4 import BeautifulSoup
 
 from rclone_api.file_part import FilePart
 from rclone_api.process import Process
@@ -23,6 +24,25 @@ _PUT_WARNED = False
 _range = range
 
 
+def _parse_files(html: str) -> list[str]:
+    soup = BeautifulSoup(html, "html.parser")
+    files = []
+    # Find each table row with class "file"
+    for tr in soup.find_all("tr", class_="file"):
+        name_span = tr.find("span", class_="name")  # type: ignore
+        if not name_span:
+            continue
+        a_tag = name_span.find("a")  # type: ignore
+        if not a_tag:
+            continue
+        # Get the text from the <a> tag
+        file_name = a_tag.get_text(strip=True)  # type: ignore
+        # Skip directories (they end with a slash)
+        if not file_name.endswith("/"):
+            files.append(file_name)
+    return files
+
+
 class HttpServer:
     """HTTP server configuration."""
 
@@ -103,6 +123,24 @@ class HttpServer:
             warnings.warn(f"Failed to remove {path} from {self.url}: {e}")
             return e
 
+        # curl "http://localhost:5572/?list"
+
+    def list(self, path: str) -> list[str] | Exception:
+        """List files on the server."""
+
+        try:
+            assert self.process is not None
+            url = self.url
+            if path:
+                url += f"/{path}"
+            url += "/?list"
+            response = httpx.get(url)
+            response.raise_for_status()
+            return _parse_files(response.content.decode())
+        except Exception as e:
+            warnings.warn(f"Failed to list files on {self.url}: {e}")
+            return e
+
     def download(
         self, path: str, dst: Path, range: Range | None = None
     ) -> Path | Exception:

rclone_api/rclone_impl.py

@@ -26,6 +26,7 @@ from rclone_api.dir_listing import DirListing
 from rclone_api.exec import RcloneExec
 from rclone_api.file import File
 from rclone_api.file_stream import FilesStream
+from rclone_api.fs import FSPath, RemoteFS
 from rclone_api.group_files import group_files
 from rclone_api.http_server import HttpServer
 from rclone_api.mount import Mount
@@ -103,6 +104,12 @@ class RcloneImpl:
             cmd += other_args
         return self._launch_process(cmd, capture=False)
 
+    def filesystem(self, src: str) -> RemoteFS:
+        return RemoteFS(self.config, src)
+
+    def cwd(self, src: str) -> FSPath:
+        return self.filesystem(src).cwd()
+
     def launch_server(
         self,
         addr: str,

{rclone_api-1.5.13.dist-info → rclone_api-1.5.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rclone_api
-Version: 1.5.13
+Version: 1.5.21
 Summary: rclone api in python
 Home-page: https://github.com/zackees/rclone-api
 License: BSD 3-Clause License
@@ -19,6 +19,7 @@ Requires-Dist: psycopg2-binary>=2.9.10
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: download>=0.3.5
 Requires-Dist: appdirs>=1.4.4
+Requires-Dist: beautifulsoup4>=4.13.3
 Dynamic: home-page
 Dynamic: license-file
 
@@ -42,6 +43,10 @@ This library was built out of necessity to transfer large amounts of AI training
 
 You can have [rclone](https://rclone.org/) in your path or else the api will download it.
 
+## VFS
+
+There is a virtual file system called `FSPath` which emulates common operators for `pathlib.Path`. You can get an instance of an `FSPath` from an `Rclone` instance using the `rclone.cwd("src:path/to")` function.
+
 # Install
 
 `pip install rclone-api`
@@ -102,6 +107,71 @@ def test_ls_glob_png(self) -> None:
 ```python
 
 from rclone_api import Rclone
+"""
+Rclone API - Python interface for the Rclone command-line tool.
+
+This package provides a high-level API for interacting with Rclone,
+allowing file operations across various cloud storage providers.
+The API wraps the rclone command-line tool, providing a Pythonic interface
+for common operations like copying, listing, and managing remote storage.
+"""
+
+# Import core components and utilities
+from datetime import datetime
+from pathlib import Path
+from typing import Generator
+
+# Import logging utilities
+from rclone_api import log
+
+# Import data structures and models
+from .completed_process import CompletedProcess
+from .config import Config, Parsed, Section  # Configuration handling
+from .diff import DiffItem, DiffOption, DiffType  # File comparison utilities
+from .dir import Dir  # Directory representation
+from .dir_listing import DirListing  # Directory contents representation
+from .file import File, FileItem  # File representation
+from .file_stream import FilesStream  # Streaming file listings
+from .filelist import FileList  # File list utilities
+from .fs import FSPath, RemoteFS  # Filesystem utilities
+from .http_server import HttpFetcher, HttpServer, Range  # HTTP serving capabilities
+
+# Import logging configuration utilities
+from .log import configure_logging, setup_default_logging
+from .mount import Mount  # Mount remote filesystems
+from .process import Process  # Process management
+from .remote import Remote  # Remote storage representation
+from .rpath import RPath  # Remote path utilities
+from .s3.types import MultiUploadResult  # S3-specific types
+from .types import (  # Common types
+    ListingOption,
+    Order,
+    PartInfo,
+    SizeResult,
+    SizeSuffix,
+)
+
+# Set up default logging configuration when the package is imported
+setup_default_logging()
+
+
+def rclone_verbose(val: bool | None) -> bool:
+    """
+    Get or set the global verbosity setting for rclone operations.
+
+    Controls whether rclone commands will produce detailed output.
+    When enabled, commands will show more information about their operation.
+
+    Args:
+        val: If provided, sets the verbosity level. If None, returns the current setting.
+
+    Returns:
+        The current verbosity setting after any change.
+    """
+    from rclone_api.rclone_impl import rclone_verbose as _rclone_verbose
+
+    return _rclone_verbose(val)
+
 
 class Rclone:
     """
@@ -159,6 +229,27 @@ class Rclone:
         """
         return self.impl.webgui(other_args=other_args)
 
+    def filesystem(self, src: str) -> RemoteFS:
+        """
+        Get a RealFS object for interacting with the local filesystem.
+
+        Returns:
+            RealFS object for local filesystem operations
+        """
+        return self.impl.filesystem(src=src)
+
+    def cwd(self, src: str) -> FSPath:
+        """
+        Get the local root path for a filesystem.
+
+        Args:
+            src: Source path for the filesystem
+
+        Returns:
+            FSPath object representing the root of the filesystem
+        """
+        return self.impl.cwd(src=src)
+
     def launch_server(
         self,
         addr: str,
@@ -881,7 +972,7 @@ class Rclone:
     def serve_http(
         self,
         src: str,
-        addr: str = "localhost:8080",
+        addr: str | None = None,
         other_args: list[str] | None = None,
     ) -> HttpServer:
         """
@@ -902,7 +993,9 @@ class Rclone:
         Returns:
             HttpServer object with methods for accessing the served content
         """
-        return self.impl.serve_http(src=src, addr=addr, other_args=other_args)
+        return self.impl.serve_http(
+            src=src, cache_mode="minimal", addr=addr, other_args=other_args
+        )
 
     def size_files(
         self,
@@ -952,6 +1045,43 @@ class Rclone:
             SizeSuffix object representing the file size, or Exception if an error occurred
         """
         return self.impl.size_file(src=src)
+
+
+# Export public API components
+__all__ = [
+    # Main classes
+    "Rclone",  # Primary interface
+    "File",  # File representation
+    "Config",  # Configuration handling
+    "Remote",  # Remote storage
+    "Dir",  # Directory representation
+    "RPath",  # Remote path utilities
+    "DirListing",  # Directory listing
+    "FileList",  # File list
+    "FileItem",  # File item
+    "Process",  # Process management
+    "DiffItem",  # Difference item
+    "DiffType",  # Difference type
+    # Functions
+    "rclone_verbose",  # Verbosity control
+    # Data classes and enums
+    "CompletedProcess",  # Process result
+    "DiffOption",  # Difference options
+    "ListingOption",  # Listing options
+    "Order",  # Sorting order
+    "SizeResult",  # Size result
+    "Parsed",  # Parsed configuration
+    "Section",  # Configuration section
+    "MultiUploadResult",  # S3 upload result
+    "SizeSuffix",  # Size with suffix
+    # Utilities
+    "configure_logging",  # Logging configuration
+    "log",  # Logging utilities
+    "HttpServer",  # HTTP server
+    "Range",  # HTTP range
+    "HttpFetcher",  # HTTP fetcher
+    "PartInfo",  # Part information for uploads
+]
 ```
 
 

{rclone_api-1.5.13.dist-info → rclone_api-1.5.21.dist-info}/RECORD

@@ -1,4 +1,4 @@
-rclone_api/__init__.py,sha256=nUDuo5YZQZybVsd0fiExyDPOOwxwZGSrD8Sx6Asb57U,32426
+rclone_api/__init__.py,sha256=2B3NUnmPmEfV3f6hLKqMxioJIIB4Ry7jxpPjvA1JxLo,33064
 rclone_api/cli.py,sha256=dibfAZIh0kXWsBbfp3onKLjyZXo54mTzDjUdzJlDlWo,231
 rclone_api/completed_process.py,sha256=_IZ8IWK7DM1_tsbDEkH6wPZ-bbcrgf7A7smls854pmg,1775
 rclone_api/config.py,sha256=f6jEAxVorGFr31oHfcsu5AJTtOJj2wR5tTSsbGGZuIw,2558
@@ -13,14 +13,15 @@ rclone_api/file_item.py,sha256=cH-AQYsxedhNPp4c8NHY1ad4Z7St4yf_VGbmiGD59no,1770
 rclone_api/file_part.py,sha256=i6ByS5_sae8Eba-4imBVTxd-xKC8ExWy7NR8QGr0ors,6155
 rclone_api/file_stream.py,sha256=_W3qnwCuigqA0hzXl2q5pAxSZDRaUSwet4BkT0lpnzs,1431
 rclone_api/filelist.py,sha256=xbiusvNgaB_b_kQOZoHMJJxn6TWGtPrWd2J042BI28o,767
+rclone_api/fs.py,sha256=2UM0-iphSDC8peovirW3pHMV5goghZtYkx4EIoAdxns,6761
 rclone_api/group_files.py,sha256=H92xPW9lQnbNw5KbtZCl00bD6iRh9yRbCuxku4j_3dg,8036
-rclone_api/http_server.py,sha256=p1_S9VAViVvGif6NA_rxrDgMqnOmPTxJaHQ7B43FK70,10431
+rclone_api/http_server.py,sha256=ZdL-rGaq0zIjcaIiRIbPBQ4OIWZ7dCu71aq0nRlKtY4,11686
 rclone_api/install.py,sha256=Xb1BRn8rQcSpSd4dzmvIOELP2zM2DytUeIZ6jzv738A,2893
 rclone_api/log.py,sha256=VZHM7pNSXip2ZLBKMP7M1u-rp_F7zoafFDuR8CPUoKI,1271
 rclone_api/mount.py,sha256=LZqEhuKZunbWVqmsOIqkkCotaxWJpdFRS1InXveoU5E,1428
 rclone_api/mount_util.py,sha256=jqhJEVTHV6c6lOOzUYb4FLMbqDMHdz7-QRcdH-IobFc,10154
 rclone_api/process.py,sha256=MeWiN-TrrN0HmtWexBPxGwf84z6f-_E5yaXE-YtLYpY,5879
-rclone_api/rclone_impl.py,sha256=STHQ_hT0chyp2yj3Cp-Vd0xXc1Pdpo3p9J3bTQEm0XE,46531
+rclone_api/rclone_impl.py,sha256=tIoNJtjMYIKTp9SVpH878pd7tFW3v1APO4FuU2RnJTk,46747
 rclone_api/remote.py,sha256=mTgMTQTwxUmbLjTpr-AGTId2ycXKI9mLX5L7PPpDIoc,520
 rclone_api/rpath.py,sha256=Y1JjQWcie39EgQrq-UtbfDz5yDLCwwfu27W7AQXllSE,2860
 rclone_api/scan_missing_folders.py,sha256=-8NCwpCaHeHrX-IepCoAEsX1rl8S-GOCxcIhTr_w3gA,4747
@@ -53,9 +54,9 @@ rclone_api/s3/multipart/upload_parts_inline.py,sha256=V7syKjFyVIe4U9Ahl5XgqVTzt9
 rclone_api/s3/multipart/upload_parts_resumable.py,sha256=6-nlMclS8jyVvMvFbQDcZOX9MY1WbCcKA_s9bwuYxnk,9793
 rclone_api/s3/multipart/upload_parts_server_side_merge.py,sha256=Fp2pdrs5dONQI9LkfNolgAGj1-Z2V1SsRd0r0sreuXI,18040
 rclone_api/s3/multipart/upload_state.py,sha256=f-Aq2NqtAaMUMhYitlICSNIxCKurWAl2gDEUVizLIqw,6019
-rclone_api-1.5.13.dist-info/licenses/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
-rclone_api-1.5.13.dist-info/METADATA,sha256=GZbzZ8SIa3OXE_8lB_hGrK0y10KHCG5jUkn2sjPPQE0,32657
-rclone_api-1.5.13.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-rclone_api-1.5.13.dist-info/entry_points.txt,sha256=fJteOlYVwgX3UbNuL9jJ0zUTuX2O79JFAeNgK7Sw7EQ,255
-rclone_api-1.5.13.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
-rclone_api-1.5.13.dist-info/RECORD,,
+rclone_api-1.5.21.dist-info/licenses/LICENSE,sha256=b6pOoifSXiUaz_lDS84vWlG3fr4yUKwB8fzkrH9R8bQ,1064
+rclone_api-1.5.21.dist-info/METADATA,sha256=ZbT2xwQPsbd2isP_btzLGa4nxpgRdkGaf_UemDMRgX4,37155
+rclone_api-1.5.21.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+rclone_api-1.5.21.dist-info/entry_points.txt,sha256=fJteOlYVwgX3UbNuL9jJ0zUTuX2O79JFAeNgK7Sw7EQ,255
+rclone_api-1.5.21.dist-info/top_level.txt,sha256=EvZ7uuruUpe9RiUyEp25d1Keq7PWYNT0O_-mr8FCG5g,11
+rclone_api-1.5.21.dist-info/RECORD,,