fx-bin 2.2.2__tar.gz → 2.3.0__tar.gz

{fx_bin-2.2.2 → fx_bin-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fx-bin
-Version: 2.2.2
+Version: 2.3.0
 Summary: A common bin collection for my own usage
 Keywords: fx_bin
 Author: Frank Xu

{fx_bin-2.2.2 → fx_bin-2.3.0}/fx_bin/__init__.py

@@ -15,4 +15,4 @@ try:
     __version__ = version("fx-bin")
 except Exception:
     # Fallback version in case package is not installed
-    __version__ = "2.2.2"
+    __version__ = "2.3.0"

fx_bin-2.3.0/fx_bin/backup_utils.py

@@ -0,0 +1,123 @@
+"""Shared backup utilities for file operations.
+
+This module provides reusable backup functionality that can be used
+across different modules (replace.py, replace_functional.py, etc.).
+
+Functions follow functional patterns with IOResult for error handling.
+"""
+
+import os
+import shutil
+import stat
+
+from loguru import logger as L
+from returns.io import IOResult
+
+from fx_bin.errors import IOError as FxIOError
+from fx_bin.shared_types import FileBackup
+
+# Re-export for backward compatibility
+__all__ = ["FileBackup", "create_backup", "restore_from_backup", "cleanup_backup"]
+
+
+def create_backup(filename: str) -> IOResult[FileBackup, FxIOError]:
+    """Create a backup of the file.
+
+    Creates a backup copy of the specified file with preserved metadata.
+    The backup file is created with a ".backup" suffix.
+
+    Args:
+        filename: Path to the file to backup
+
+    Returns:
+        IOResult containing:
+            - Success: FileBackup object with backup metadata
+            - Failure: FxIOError if backup creation fails
+
+    Example:
+        >>> from fx_bin.lib import unsafe_ioresult_unwrap
+        >>> result = create_backup("/path/to/file.txt")
+        >>> backup = unsafe_ioresult_unwrap(result)
+        >>> print(backup.backup_path)
+        /path/to/file.txt.backup
+    """
+    try:
+        # Get original file stats
+        original_stat = os.stat(filename)
+        original_mode = original_stat.st_mode
+
+        # Create backup path
+        backup_path = f"{filename}.backup"
+
+        # Copy file with metadata
+        shutil.copy2(filename, backup_path)
+
+        return IOResult.from_value(
+            FileBackup(
+                original_path=filename,
+                backup_path=backup_path,
+                original_mode=original_mode,
+            )
+        )
+    except Exception as e:
+        return IOResult.from_failure(FxIOError(f"Failed to create backup: {e}"))
+
+
+def restore_from_backup(backup: FileBackup) -> IOResult[None, FxIOError]:
+    """Restore original file from backup on failure.
+
+    Restores the original file from the backup copy and restores
+    the original file permissions. Gracefully handles missing backup
+    files (already cleaned up).
+
+    Args:
+        backup: FileBackup object containing backup metadata
+
+    Returns:
+        IOResult containing:
+            - Success: None (restore succeeded or backup already cleaned up)
+            - Failure: FxIOError if restore operation fails
+
+    Example:
+        >>> backup = FileBackup(...)
+        >>> result = restore_from_backup(backup)
+    """
+    try:
+        if os.path.exists(backup.backup_path):
+            # Restore the backup
+            shutil.move(backup.backup_path, backup.original_path)
+            # Restore permissions
+            os.chmod(backup.original_path, stat.S_IMODE(backup.original_mode))
+        return IOResult.from_value(None)
+    except Exception as e:
+        return IOResult.from_failure(FxIOError(f"Failed to restore from backup: {e}"))
+
+
+def cleanup_backup(backup: FileBackup) -> IOResult[None, FxIOError]:
+    """Remove backup file after successful operation.
+
+    Cleans up the backup file after a successful operation.
+    Gracefully handles missing backup files (already cleaned up).
+    This is a non-critical operation - failures are logged but don't
+    fail the overall operation.
+
+    Args:
+        backup: FileBackup object containing backup metadata
+
+    Returns:
+        IOResult containing:
+            - Success: None (cleanup succeeded or backup already gone)
+            - Failure: Never fails - errors logged but returns Success
+
+    Example:
+        >>> backup = FileBackup(...)
+        >>> result = cleanup_backup(backup)
+    """
+    try:
+        if os.path.exists(backup.backup_path):
+            os.unlink(backup.backup_path)
+        return IOResult.from_value(None)
+    except Exception as e:
+        # Non-critical error - log but don't fail
+        L.warning(f"Could not remove backup {backup.backup_path}: {e}")
+        return IOResult.from_value(None)

{fx_bin-2.2.2 → fx_bin-2.3.0}/fx_bin/cli.py

@@ -3,7 +3,8 @@
 
 import click
 import sys
-from typing import List, Tuple, Optional
+from typing import List, Tuple, Optional, Any
+
 import importlib.metadata
 
 
@@ -41,7 +42,7 @@ COMMANDS_INFO: List[Tuple[str, str]] = [
 )
 @click.version_option(version=None, message=get_version_info())
 @click.pass_context
-def cli(ctx):
+def cli(ctx: click.Context) -> None:
     """FX - A collection of file and text utilities.
 
     Common commands:
@@ -60,7 +61,7 @@ def cli(ctx):
 
 @cli.command()
 @click.argument("paths", nargs=-1, type=click.Path(exists=True))
-def files(paths):
+def files(paths: Tuple[str, ...]) -> int:
     """Count files in directories.
 
     Examples:
@@ -88,7 +89,7 @@ def files(paths):
 
 @cli.command()
 @click.argument("paths", nargs=-1, type=click.Path(exists=True))
-def size(paths):
+def size(paths: Tuple[str, ...]) -> int:
     """Analyze file and directory sizes.
 
     Examples:
@@ -158,7 +159,9 @@ def _run_ff(
         "--exclude build --exclude '*.log'"
     ),
 )
-def ff(keyword, first, include_ignored, excludes):
+def ff(
+    keyword: str, first: bool, include_ignored: bool, excludes: Tuple[str, ...]
+) -> int:
     """Find files whose names contain KEYWORD.
 
     \b
@@ -193,7 +196,7 @@ def ff(keyword, first, include_ignored, excludes):
 
 @cli.command()
 @click.argument("keyword")
-def fff(keyword):
+def fff(keyword: str) -> int:
     """Find first file matching KEYWORD.
 
     Alias for `fx ff KEYWORD --first`. Returns only the first match
@@ -248,15 +251,15 @@ def fff(keyword):
     help="Limit the number of results returned",
 )
 def filter(
-    extension,
-    paths,
-    recursive,
-    sort_by,
-    reverse,
-    output_format,
-    show_path,
-    limit,
-):
+    extension: str,
+    paths: Tuple[str, ...],
+    recursive: bool,
+    sort_by: Optional[str],
+    reverse: bool,
+    output_format: str,
+    show_path: bool,
+    limit: Optional[int],
+) -> int:
     """Filter files by extension.
 
     \b
@@ -322,7 +325,7 @@ def filter(
 @click.argument("search_text")
 @click.argument("replace_text")
 @click.argument("filenames", nargs=-1, required=True)
-def replace(search_text, replace_text, filenames):
+def replace(search_text: str, replace_text: str, filenames: Tuple[str, ...]) -> int:
     """Replace text in files.
 
     Examples:
@@ -389,7 +392,7 @@ def backup(
     is_flag=True,
     help="Output path suitable for cd command (no extra text)",
 )
-def root(output_for_cd):
+def root(output_for_cd: bool) -> int:
     """Find Git project root directory.
 
     Searches upward from current directory to find the first directory
@@ -500,7 +503,14 @@ def realpath(path: str) -> int:
 @click.option(
     "--no-exec", is_flag=True, help="Don't start new shell, just create directory"
 )
-def today(output_for_cd, base_dir, date_format, verbose, dry_run, no_exec):
+def today(
+    output_for_cd: bool,
+    base_dir: str,
+    date_format: str,
+    verbose: bool,
+    dry_run: bool,
+    no_exec: bool,
+) -> None:
     """Create and navigate to today's workspace directory.
 
     Creates a date-organized directory (default: ~/Downloads/YYYYMMDD)
@@ -529,7 +539,7 @@ def today(output_for_cd, base_dir, date_format, verbose, dry_run, no_exec):
 
 
 @cli.command(name="list")
-def list_commands():
+def list_commands() -> int:
     """List all available fx commands."""
     click.echo("\nAvailable fx commands:\n")
 
@@ -548,7 +558,7 @@ def list_commands():
 
 @cli.command()
 @click.pass_context
-def help(ctx):
+def help(ctx: click.Context) -> int:
     """Show help information (same as fx -h).
 
     Examples:
@@ -566,7 +576,7 @@ def help(ctx):
 
 
 @cli.command()
-def version():
+def version() -> int:
     """Show version and system information.
 
     Examples:
@@ -577,7 +587,7 @@ def version():
     return 0
 
 
-def main():
+def main() -> Any:
     """Main entry point for the fx command."""
     try:
         return cli()

{fx_bin-2.2.2 → fx_bin-2.3.0}/fx_bin/common.py

@@ -4,16 +4,25 @@ import math
 import os
 from dataclasses import dataclass
 from datetime import datetime
-from enum import Enum
 from functools import total_ordering
 from typing import Any, Optional, Set, Tuple
 
-
-class EntryType(Enum):
-    """Type of filesystem entry."""
-
-    FILE = 1
-    FOLDER = 2
+# Import shared types to avoid duplication
+from fx_bin.shared_types import EntryType
+
+# Re-export for backward compatibility
+__all__ = [
+    "EntryType",
+    "SizeEntry",
+    "FileCountEntry",
+    "convert_size",
+    "format_size_aligned",
+    "generate_timestamp",
+    "get_multi_ext",
+    "get_base_name",
+    "sum_folder_size",
+    "sum_folder_files_count",
+]
 
 
 def generate_timestamp(format_str: str, now: Optional[datetime] = None) -> str: