py-wlcli 0.8.0__py3-none-any.whl

wl_cli/commands/clean/build.py

@@ -0,0 +1,151 @@
+"""
+Build Artifacts Cleaner
+构建产物清理器
+
+This module handles cleaning of build artifacts, cache directories, logs, and virtual environments.
+此模块处理构建产物、缓存目录、日志和虚拟环境的清理。
+"""
+
+from wl_cli.commands.clean.core import remove_directories, remove_files
+from wl_cli.commands.clean.python import (
+    remove_egg_info_dirs,
+    remove_log_files,
+    remove_pycache_dirs,
+)
+from wl_cli.commands.clean.rust import remove_rust_analyzer_dirs
+from wl_cli.commands.clean.venv import (
+    remove_auto_activation_scripts,
+    remove_virtual_environments,
+)
+from wl_cli.utils.logging import log_info_pair
+
+
+def clean_build_artifacts(dry_run: bool = False, config: str | None = None) -> None:
+    """Clean build artifacts and temporary files
+    清理构建产物和临时文件
+    """
+    log_info_pair(
+        "Cleaning build artifacts and temporary files...",
+        "正在清理构建产物和临时文件...",
+    )
+
+    # Remove build directories
+    build_dirs = [
+        # Build outputs
+        "build",
+        "dist",
+        "results",
+        # Cache directories
+        ".mypy_cache",
+        ".pytest_cache",
+        ".ruff_cache",
+        ".cache",
+        # IDE and editor directories
+        ".vscode",
+        ".idea",
+        ".vs",
+        # Log and temporary directories
+        "logs",
+        "todos",
+        "tmp",
+        "temp",
+    ]
+    remove_directories(build_dirs, dry_run=dry_run)
+
+    # Remove specific files
+    files_to_remove = [
+        # Coverage files — pytest-cov 的 `Central` 控制器总以 data_suffix 写
+        # `.coverage.<host>.<pid>.<rand>`，精确匹配 ".coverage" 删不掉这些残片，
+        # 需要一并按通配清掉。
+        ".coverage",
+        ".coverage.*",
+        "coverage.xml",
+        # IDE and editor files
+        ".DS_Store",
+        "Thumbs.db",
+        # Python specific
+        "*.pyc",
+        "*.pyo",
+        "*.pyd",
+        # Build files
+        "MANIFEST",
+        "*.egg-info",
+        # Lock files
+        "Pipfile.lock",
+        "poetry.lock",
+        "requirements.txt.lock",
+    ]
+    remove_files(files_to_remove, dry_run=dry_run)
+
+    # Remove log files
+    remove_log_files(dry_run=dry_run)
+
+    # Remove pycache directories only in project directory
+    remove_pycache_dirs(dry_run=dry_run)
+
+    # Remove egg-info directories
+    remove_egg_info_dirs(dry_run=dry_run)
+
+    # Remove rust-analyzer directories
+    remove_rust_analyzer_dirs(dry_run=dry_run)
+
+    log_info_pair(
+        "Build artifacts and temporary files cleaning completed.",
+        "构建产物和临时文件清理完成。",
+    )
+
+
+def clean_venv_artifacts(dry_run: bool = False, config: str | None = None) -> None:
+    """
+    Clean virtual environment artifacts
+    清理虚拟环境产物
+    """
+    log_info_pair("Cleaning virtual environment...", "正在清理虚拟环境...")
+
+    # Remove virtual environments
+    remove_virtual_environments(dry_run=dry_run)
+
+    # Remove auto-activation scripts
+    remove_auto_activation_scripts(dry_run=dry_run)
+
+    log_info_pair("Virtual environment cleaning completed.", "虚拟环境清理完成。")
+
+
+def clean_cache_artifacts(dry_run: bool = False, config: str | None = None) -> None:
+    """
+    Clean cache directories
+    清理缓存目录
+    """
+    log_info_pair("Cleaning cache directories...", "正在清理缓存目录...")
+
+    # Remove cache directories
+    cache_dirs = [
+        ".mypy_cache",
+        ".pytest_cache",
+        ".ruff_cache",
+    ]
+    remove_directories(cache_dirs, dry_run=dry_run)
+
+    # Remove pycache directories
+    remove_pycache_dirs(dry_run=dry_run)
+
+    log_info_pair("Cache directories cleaning completed.", "缓存目录清理完成。")
+
+
+def clean_logs_artifacts(dry_run: bool = False, config: str | None = None) -> None:
+    """
+    Clean log files and directories
+    清理日志文件和目录
+    """
+    log_info_pair("Cleaning log files and directories...", "正在清理日志文件和目录...")
+
+    # Remove log directories
+    log_dirs = ["logs"]
+    remove_directories(log_dirs, dry_run=dry_run)
+
+    # Remove log files
+    remove_log_files(dry_run=dry_run)
+
+    log_info_pair(
+        "Log files and directories cleaning completed.", "日志文件和目录清理完成。"
+    )

wl_cli/commands/clean/clean.py

@@ -0,0 +1,294 @@
+"""
+Command to clean project build artifacts and dead code.
+"""
+
+import sys
+
+import click
+
+from wl_cli.commands import Command, validate_command_args
+from wl_cli.utils.logging import log_info_pair
+
+from .clean_utils import (
+    clean_all_artifacts,
+    clean_build_artifacts,
+    clean_cache_artifacts,
+    clean_lfs_artifacts,
+    clean_logs_artifacts,
+    clean_rust_artifacts,
+    clean_venv_artifacts,
+)
+
+
+class CleanCommand(Command):
+    """Command to clean project build artifacts and dead code"""
+
+    @property
+    def name(self) -> str:
+        return "clean"
+
+    @property
+    def help(self) -> str:
+        return "Clean project artifacts and dead code"
+
+    def _get_cleaning_function(self, target: str):
+        """Get the appropriate cleaning function based on target."""
+        cleaning_functions = {
+            "all": clean_all_artifacts,
+            "rust": clean_rust_artifacts,
+            "lfs": clean_lfs_artifacts,
+            "venv": clean_venv_artifacts,
+            "cache": clean_cache_artifacts,
+            "logs": clean_logs_artifacts,
+            "build": clean_build_artifacts,
+        }
+        return cleaning_functions.get(target, clean_build_artifacts)
+
+    def _get_messages(self, target: str, message_type: str):
+        """Get messages for different targets based on message type."""
+        # Define all message types as a dictionary
+        all_messages = {
+            "start": {
+                "all": (
+                    "Cleaning all project artifacts including virtual environment...",
+                    "正在清理所有项目产物，包括虚拟环境...",
+                ),
+                "rust": ("Cleaning Rust build artifacts...", "正在清理Rust构建产物..."),
+                "lfs": ("Cleaning Git LFS deployment...", "正在清理Git LFS部署..."),
+                "venv": ("Cleaning virtual environment...", "正在清理虚拟环境..."),
+                "cache": ("Cleaning cache directories...", "正在清理缓存目录..."),
+                "logs": ("Cleaning log files...", "正在清理日志文件..."),
+                "build": (
+                    "Cleaning project build artifacts...",
+                    "正在清理项目构建产物...",
+                ),
+            },
+            "success": {
+                "all": (
+                    "Complete project cleaning completed successfully!",
+                    "完整项目清理成功完成！",
+                ),
+                "rust": ("Rust cleaning completed successfully!", "Rust清理成功完成！"),
+                "lfs": (
+                    "Git LFS cleaning completed successfully!",
+                    "Git LFS清理成功完成！",
+                ),
+                "venv": (
+                    "Virtual environment cleaning completed successfully!",
+                    "虚拟环境清理成功完成！",
+                ),
+                "cache": (
+                    "Cache directories cleaning completed successfully!",
+                    "缓存目录清理成功完成！",
+                ),
+                "logs": (
+                    "Log files cleaning completed successfully!",
+                    "日志文件清理成功完成！",
+                ),
+                "build": (
+                    "Project cleaning completed successfully!",
+                    "项目清理成功完成！",
+                ),
+            },
+        }
+
+        # Get specified message type dictionary
+        message_dict = all_messages.get(message_type, {})
+
+        # Get default message
+        default_message = message_dict.get("build", ("", ""))
+
+        # Return target's message, or default if not found
+        return message_dict.get(target, default_message)
+
+    def _execute_clean_target(
+        self,
+        target: str,
+        dry_run: bool = False,
+        config: str | None = None,
+        parallel: bool = False,
+    ):
+        """Execute cleaning for a specific target."""
+        # Use simple logging instead of structured logging for user-facing messages
+        start_msg_en, start_msg_zh = self._get_messages(target, "start")
+        log_info_pair(start_msg_en, start_msg_zh)
+
+        # Log dry run mode
+        if dry_run:
+            log_info_pair(
+                "Dry run mode: No files will be deleted.",
+                "Dry run模式：不会删除任何文件。",
+            )
+
+        # Get and execute the appropriate cleaning function
+        cleaning_function = self._get_cleaning_function(target)
+        if target == "all":
+            cleaning_function(dry_run=dry_run, config=config, parallel=parallel)
+        else:
+            cleaning_function(dry_run=dry_run, config=config)
+
+        # Log success message
+        success_msg_en, success_msg_zh = self._get_messages(target, "success")
+        log_info_pair(success_msg_en, success_msg_zh)
+
+    def _execute_dead_code(
+        self,
+        dry_run: bool = False,
+        scan_only: bool = False,
+        json_output: bool = False,
+    ) -> int:
+        """Execute dead code detection and cleaning."""
+        from .dead_code.dead_code_command import DeadCodeCommand
+
+        command = DeadCodeCommand()
+        return command.run(
+            dry_run=dry_run or scan_only,
+            json=json_output,
+        )
+
+    @validate_command_args()
+    def execute(
+        self,
+        clean_action: str | None = None,
+        target: str | None = None,
+        dry_run: bool = False,
+        config: str | None = None,
+        parallel: bool = False,
+        scan_only: bool = False,
+        json: bool = False,
+        **kwargs,
+    ) -> int:
+        """
+        Clean project artifacts and dead code.
+        清理项目产物和死代码。
+
+        Returns the exit code; only the Click wrapper turns it into a
+        ``SystemExit`` (#166). ``dead-code`` passes the dead-code command's own
+        0/1 through; every other target reports 0 on success.
+        """
+        try:
+            if clean_action == "dead-code":
+                # Execute dead code command
+                return self._execute_dead_code(
+                    dry_run=dry_run,
+                    scan_only=scan_only,
+                    json_output=json,
+                )
+            elif clean_action in [
+                "build",
+                "all",
+                "rust",
+                "lfs",
+                "venv",
+                "cache",
+                "logs",
+            ]:
+                # Execute specific clean action
+                self._execute_clean_target(
+                    target=clean_action,
+                    dry_run=dry_run,
+                    config=config,
+                    parallel=parallel,
+                )
+            elif target is not None:
+                # Backward compatibility: use old positional argument
+                self._execute_clean_target(
+                    target=target,
+                    dry_run=dry_run,
+                    config=config,
+                    parallel=parallel,
+                )
+            else:
+                # Default to build
+                self._execute_clean_target(
+                    target="build",
+                    dry_run=dry_run,
+                    config=config,
+                    parallel=parallel,
+                )
+            # Artifact targets (and the legacy target branch) report success;
+            # they do not forward a deeper command's status (#166 patch 4).
+            return 0
+        except Exception as e:
+            log_info_pair(f"Error cleaning project: {e}", f"错误：清理项目失败: {e}")
+            return 1
+
+
+@click.command(name="clean")
+@click.argument(
+    "target_or_subcommand",
+    default=None,
+    required=False,
+)
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Preview files to be deleted without actually deleting them / Only scan without fixing",
+)
+@click.option(
+    "--scan-only",
+    is_flag=True,
+    help="Same as --dry-run (for dead-code)",
+)
+@click.option(
+    "--json",
+    is_flag=True,
+    help="Output JSON format (for dead-code)",
+)
+@click.option(
+    "--config",
+    type=str,
+    help="Path to custom cleaning configuration file",
+    default=None,
+)
+@click.option(
+    "--parallel",
+    is_flag=True,
+    help="Enable parallel execution for clean all (experimental)",
+)
+def clean_command(
+    target_or_subcommand: str | None,
+    dry_run: bool,
+    scan_only: bool,
+    json: bool,
+    config: str | None,
+    parallel: bool,
+) -> None:
+    """Clean project artifacts and dead code.
+
+    Targets: build, all, rust, lfs, venv, cache, logs, dead-code
+    """
+    cmd = CleanCommand()
+
+    # Check if it's a subcommand
+    if target_or_subcommand in [
+        "build",
+        "all",
+        "rust",
+        "lfs",
+        "venv",
+        "cache",
+        "logs",
+        "dead-code",
+    ]:
+        # Use as clean_action
+        exit_code = cmd.execute(
+            clean_action=target_or_subcommand,
+            dry_run=dry_run,
+            scan_only=scan_only,
+            json=json,
+            config=config,
+            parallel=parallel,
+        )
+    else:
+        # Use as target (legacy behavior)
+        exit_code = cmd.execute(
+            target=target_or_subcommand,
+            dry_run=dry_run,
+            config=config,
+            parallel=parallel,
+        )
+
+    # The implementation returns a code; only this wrapper exits (#166).
+    if exit_code:
+        sys.exit(exit_code)

wl_cli/commands/clean/clean_utils.py

@@ -0,0 +1,77 @@
+"""
+Clean Utils Module
+清理工具模块
+
+This module now serves as an entry point for the modularized cleaning functionality.
+Main functions are delegated to specialized modules for better organization.
+此模块现在作为模块化清理功能的入口点。
+主要功能委托给专门的模块以获得更好的组织结构。
+"""
+
+# Import all functions from the modularized components
+# Re-export functions for clean.py - these are used by other modules
+
+from wl_cli.commands.clean.build import (
+    clean_build_artifacts,
+    clean_cache_artifacts,
+    clean_logs_artifacts,
+    clean_venv_artifacts,
+)
+from wl_cli.commands.clean.core import remove_directories, remove_files
+from wl_cli.commands.clean.lfs import clean_lfs_artifacts
+from wl_cli.commands.clean.python import (
+    remove_egg_info_dirs,
+    remove_log_files,
+    remove_pycache_dirs,
+)
+from wl_cli.commands.clean.rust import (
+    clean_rust_artifacts as _clean_rust_artifacts,
+)
+from wl_cli.commands.clean.venv import (
+    remove_auto_activation_scripts,
+    remove_uv_lock,
+    remove_virtual_environments,
+)
+
+# Keep backward compatibility with tests that import private functions
+# 保持与导入私有函数的测试的向后兼容性
+_remove_directories = remove_directories
+_remove_files = remove_files
+_remove_log_files = remove_log_files
+_remove_pycache_dirs = remove_pycache_dirs
+_remove_egg_info_dirs = remove_egg_info_dirs
+_remove_virtual_environments = remove_virtual_environments
+_remove_auto_activation_scripts = remove_auto_activation_scripts
+_remove_uv_lock = remove_uv_lock
+
+#: Public re-export surface consumed by ``clean/clean.py`` (ruff: F401).
+__all__ = [
+    "clean_all_artifacts",
+    "clean_build_artifacts",
+    "clean_cache_artifacts",
+    "clean_lfs_artifacts",
+    "clean_logs_artifacts",
+    "clean_rust_artifacts",
+    "clean_venv_artifacts",
+]
+
+
+def clean_all_artifacts(
+    dry_run: bool = False, config: str | None = None, parallel: bool = False
+) -> None:
+    """
+    Clean all artifacts including virtual environments
+    清理所有产物，包括虚拟环境
+    """
+    clean_build_artifacts(dry_run=dry_run, config=config)
+    clean_venv_artifacts(dry_run=dry_run, config=config)
+
+
+def clean_rust_artifacts(dry_run: bool = False, config: str | None = None) -> None:
+    """
+    Clean Rust build artifacts
+    清理Rust构建产物
+    """
+    # Pass dry_run parameter to the actual implementation
+    # Note: config is reserved for future use
+    _clean_rust_artifacts(dry_run=dry_run)