sy-python 0.1.1__cp38-abi3-manylinux_2_28_aarch64.whl → 0.2.1__cp38-abi3-manylinux_2_28_aarch64.whl

{sy_python-0.1.1.dist-info → sy_python-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sy-python
-Version: 0.1.1
+Version: 0.2.1
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License

sy_python-0.2.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+sy_python-0.2.1.dist-info/METADATA,sha256=KvuM3uRtUZgqT4OXQYfNjNhpWfjqXhSaPWuxG3IDjLw,1286
+sy_python-0.2.1.dist-info/WHEEL,sha256=TbOEPJcLRdoLQex6HY6MJy-GFvwdI5JUNazV49lxV2I,108
+sy_python-0.2.1.dist-info/entry_points.txt,sha256=NPHeXCspWz0vGpS57shSO3ezGr5DOiByIM4ytzH_sJc,64
+sypy/__init__.py,sha256=kUQ1kbnGgG15AhivJcHMjdIDjB0e8KD7za5xz4etnGg,2988
+sypy/__main__.py,sha256=K9CZ6AJGxOFYSkuWRmvpm2bynZu1Ws_qDie_IPO8cjg,411
+sypy/_sypy.abi3.so,sha256=JC3LTfXpMfCujuqZLRz_Fs6pQlTu1b09HQv11kjAJ3U,23846232
+sypy/_sypy.pyi,sha256=w12Ij8XV6p2f_XytXr-Wfk4YTwVWQSsEAPez3UWdUcs,13815
+sypy/ls_types.py,sha256=PIm8Q9jEo-b5OaGxpJ4mcTgG4Dn4uXQHFvT9ARbiu7M,1299
+sypy/py.typed,sha256=qww23I-O7yv_Kf5Wu2UW3r8K1Vd12UDESBl5tmzRSI0,60
+sy_python-0.2.1.dist-info/RECORD,,

sypy/__init__.py

@@ -32,15 +32,51 @@ Example:
     >>> s3 = sypy.S3Config(..., client_options=options)
     >>> stats = sypy.sync("/local/", "s3://bucket/", s3=s3, parallel=100)
 
+        # Dry-run with typed summary
+    >>> stats = sypy.sync("/source", "/dest", dry_run=True)
+    >>> summary = stats.dry_run_summary
+    >>> print(f"Would create {summary['would_create']['count']} files")
+
 """
 
+from typing import TypedDict
+
+
+class DryRunChange(TypedDict):
+    """Details about changes that would be made"""
+
+    count: int
+    bytes: int
+
+
+class DryRunSummary(TypedDict):
+    """Summary of what would happen in a dry-run"""
+
+    would_create: DryRunChange
+    would_update: DryRunChange
+    would_delete: DryRunChange
+    total_files: int
+    total_bytes: int
+
+
+# Import TypedDict for ls functionality
 from sypy._sypy import (
+    # Dry-run classes
+    ChangeAction,
     # Client options
     CloudClientOptions,
+    DirectoryChange,
+    DryRunDetails,
+    FileChange,
     # Config classes
     GcsConfig,
+    # List classes
+    ListEntry,
+    # Progress classes
+    ProgressSnapshot,
     S3Config,
     SshConfig,
+    SymlinkChange,
     # Classes
     SyncError,
     SyncOptions,
@@ -48,23 +84,39 @@ from sypy._sypy import (
     SyncStats,
     # Version
     __version__,
+    # Functions
+    ls,
     # CLI functions
     main,
-    # Functions
     parse_path,
     run_daemon,
     run_server,
     sync,
     sync_with_options,
 )
+from sypy.ls_types import ListEntryDict
 
 __all__ = [
+    # Dry-run classes
+    "ChangeAction",
     # Client options
     "CloudClientOptions",
+    "DirectoryChange",
+    # TypedDicts
+    "DryRunChange",
+    "DryRunDetails",
+    "DryRunSummary",
+    "FileChange",
     # Config classes
     "GcsConfig",
+    # List classes
+    "ListEntry",
+    "ListEntryDict",
+    # Progress classes
+    "ProgressSnapshot",
     "S3Config",
     "SshConfig",
+    "SymlinkChange",
     # Classes
     "SyncError",
     "SyncOptions",
@@ -72,9 +124,10 @@ __all__ = [
     "SyncStats",
     # Version
     "__version__",
+    # Functions
+    "ls",
     # CLI functions
     "main",
-    # Functions
     "parse_path",
     "run_daemon",
     "run_server",

sypy/_sypy.pyi

@@ -197,6 +197,57 @@ class SyncStats:
     def success(self) -> bool: ...
     @property
     def transfer_rate(self) -> float: ...
+    @property
+    def dry_run_summary(self) -> dict[str, dict[str, int] | int]: ...
+
+class ProgressSnapshot:
+    total_bytes: int
+    """Estimated total bytes to process (may be 0 if unknown)."""
+
+    bytes: int
+    """Bytes completed so far."""
+
+    bytes_per_sec: int
+    """Instantaneous speed in bytes per second."""
+
+    transfers: int
+    """Number of transfers (files) completed."""
+
+    total_transfers: int
+    """Total number of transfers planned."""
+
+    active_transfers: int
+    """Number of currently active (in-flight) transfers."""
+
+    percentage: float | None
+    """Percentage complete (0.0 to 100.0), None if total_bytes is 0/unknown."""
+
+    elapsed_secs: float
+    """Elapsed time in seconds since sync started."""
+
+    @property
+    def transferring(self) -> list[str]: ...
+    """List of currently transferring file paths."""
+
+    @property
+    def current_file(self) -> str | None: ...
+    """Current file being transferred (first in transferring list), or None."""
+
+    @property
+    def speed_human(self) -> str: ...
+    """Speed as a human-readable string (e.g., "10.5 MB/s")."""
+
+    @property
+    def bytes_human(self) -> str: ...
+    """Bytes as a human-readable string (e.g., "1.5 GB")."""
+
+    @property
+    def total_bytes_human(self) -> str: ...
+    """Total bytes as a human-readable string (e.g., "10.2 GB")."""
+
+    @property
+    def eta_secs(self) -> float | None: ...
+    """Estimated time remaining in seconds, or None if unknown."""
 
 class SyncPath:
     def __init__(self, path: str) -> None: ...
@@ -367,15 +418,12 @@ class SyncOptions:
     ) -> None: ...
 
 # Type alias for progress callback
-type ProgressCallback = Callable[[int, int, str, str], None]
+type ProgressCallback = Callable[[ProgressSnapshot], None]
 """
 Progress callback function signature.
 
 Args:
-    current: Current progress count
-    total: Total count
-    path: Current file path
-    action: Current action ("scanning", "creating", "updating", etc.)
+    snapshot: ProgressSnapshot describing current sync state
 """
 
 def sync(
@@ -395,6 +443,7 @@ def sync(
     max_size: str | None = None,
     bwlimit: str | None = None,
     progress_callback: ProgressCallback | None = None,
+    progress_frequency_ms: int = 1000,
     daemon_auto: bool = False,
     resume: bool = True,
     ignore_times: bool = False,
@@ -418,9 +467,54 @@ def sync_with_options(
     dest: str,
     options: SyncOptions,
     progress_callback: ProgressCallback | None = None,
+    progress_frequency_ms: int = 1000,
 ) -> SyncStats: ...
 def parse_path(path: str) -> SyncPath: ...
 
+class ListEntry:
+    path: str
+    """Relative path of the entry."""
+
+    size: int
+    """File size in bytes (0 for directories)."""
+
+    mod_time: str
+    """Modification time in RFC3339 format."""
+
+    is_dir: bool
+    """Whether this is a directory."""
+
+    entry_type: str
+    """Entry type: "file", "directory", or "symlink"."""
+
+    mime_type: str | None
+    """MIME type (inferred from extension)."""
+
+    symlink_target: str | None
+    """Symlink target path (if this is a symlink)."""
+
+    is_sparse: bool | None
+    """Whether this is a sparse file."""
+
+    allocated_size: int | None
+    """Actual allocated size on disk (may differ from size for sparse files)."""
+
+    inode: int | None
+    """Inode number (Unix only)."""
+
+    num_links: int | None
+    """Number of hard links to this file."""
+
+    def to_dict(self) -> dict[str, str | int | bool | None]: ...
+
+def ls(
+    path: str,
+    recursive: bool = False,
+    max_depth: int | None = None,
+    files_only: bool = False,
+    dirs_only: bool = False,
+) -> list[ListEntry]: ...
+
 # CLI functions
 def main(args: list[str] | None = None) -> int: ...
 def run_server(path: str) -> None: ...

sypy/ls_types.py

@@ -0,0 +1,55 @@
+"""
+TypedDict definitions for sy-ls functionality.
+
+This module provides TypedDict types for type-safe usage of the ls() function
+and ListEntry objects.
+"""
+
+from typing import TypedDict
+
+
+class ListEntryDict(TypedDict, total=False):
+    """
+    TypedDict representing a directory listing entry.
+
+    All fields are required except those marked Optional.
+    Use this for type hints when calling entry.to_dict().
+
+    Example:
+        >>> entries = sypy.ls("/path")
+        >>> dicts: list[ListEntryDict] = [e.to_dict() for e in entries]
+
+    """
+
+    path: str
+    """Relative path of the entry."""
+
+    size: int
+    """File size in bytes (0 for directories)."""
+
+    mod_time: str
+    """Modification time in RFC3339 format."""
+
+    is_dir: bool
+    """Whether this is a directory."""
+
+    entry_type: str
+    """Entry type: "file", "directory", or "symlink"."""
+
+    mime_type: str | None
+    """MIME type (inferred from extension)."""
+
+    symlink_target: str | None
+    """Symlink target path (if this is a symlink)."""
+
+    is_sparse: bool | None
+    """Whether this is a sparse file."""
+
+    allocated_size: int | None
+    """Actual allocated size on disk."""
+
+    inode: int | None
+    """Inode number (Unix only)."""
+
+    num_links: int | None
+    """Number of hard links to this file."""

sy_python-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-sy_python-0.1.1.dist-info/METADATA,sha256=JKVKjYrA-sy0rbnpAf74BcGXNbNpoJzD3y_RqFE-ovY,1286
-sy_python-0.1.1.dist-info/WHEEL,sha256=TbOEPJcLRdoLQex6HY6MJy-GFvwdI5JUNazV49lxV2I,108
-sy_python-0.1.1.dist-info/entry_points.txt,sha256=NPHeXCspWz0vGpS57shSO3ezGr5DOiByIM4ytzH_sJc,64
-sypy/__init__.py,sha256=woMOP3zuYbOdeV5FjQ0pVCwu_gc594E8l_PUzC3w3ec,1831
-sypy/__main__.py,sha256=K9CZ6AJGxOFYSkuWRmvpm2bynZu1Ws_qDie_IPO8cjg,411
-sypy/_sypy.abi3.so,sha256=z9t88NHyetrc2SLEpt2BAIKSTWsUtPAC78WdiuzWWV4,23402576
-sypy/_sypy.pyi,sha256=hw0YHmaKn7Aw2Dmg0RpaAPnKxk7sz2jRUwwDitb3eNc,11313
-sypy/py.typed,sha256=qww23I-O7yv_Kf5Wu2UW3r8K1Vd12UDESBl5tmzRSI0,60
-sy_python-0.1.1.dist-info/RECORD,,