bitool 0.1.2__py3-none-any.whl

bitool/__init__.py

@@ -0,0 +1,27 @@
+"""Bitool Maturin - Rust + Python 混合架构工具集."""
+
+__version__ = "0.1.2"
+__author__ = "gooker_young"
+
+
+from .cmd._scheduler import CommandScheduler
+from .consts import Constants
+from .core.app import BitoolApp
+from .core.commands import CommandCategory, CommandExecutor, CommandRegistry
+from .core.plugin import Plugin, PluginContext, PluginRegistry
+from .core.workspace import WorkspaceManager
+from .utils.profiler import profile
+
+__all__ = [
+    "BitoolApp",
+    "CommandCategory",
+    "CommandExecutor",
+    "CommandRegistry",
+    "CommandScheduler",
+    "Constants",
+    "Plugin",
+    "PluginContext",
+    "PluginRegistry",
+    "WorkspaceManager",
+    "profile",
+]

bitool/cmd/__init__.py

@@ -0,0 +1,65 @@
+from ._base import BaseCommand
+from ._condition import BuiltinConditions, Condition
+from ._scheduler import CommandResult, CommandScheduler, SchedulerMetrics
+from .env import SetEnvCommand
+from .git import GitAddCommand, GitCommitCommand, GitTagCommand
+from .io import WriteFileCommand
+from .pdf import (
+    CompressPdfCommand,
+    ImagesToPdfCommand,
+    MergePdfsCommand,
+    PdfToImagesCommand,
+    SplitPdfCommand,
+)
+from .run import (
+    RunCommand,
+    RunDAGCommands,
+    RunParallelCommands,
+    RunSequentialCommands,
+    RunShellCommand,
+)
+from .toml import (
+    ReadTomlCommand,
+    ReadTomlVersionCommand,
+    UpdateTomlVersionCommand,
+    WriteTomlCommand,
+)
+from .version import (
+    BumpFileVersionCommand,
+    BumpProjectVersionCommand,
+    ReadTextVersionCommand,
+    UpdateTextVersionCommand,
+)
+
+__all__ = [
+    "BaseCommand",
+    "BuiltinConditions",
+    "BumpFileVersionCommand",
+    "BumpProjectVersionCommand",
+    "CommandResult",
+    "CommandScheduler",
+    "CompressPdfCommand",
+    "Condition",
+    "GitAddCommand",
+    "GitCommitCommand",
+    "GitTagCommand",
+    "ImagesToPdfCommand",
+    "MergePdfsCommand",
+    "PdfToImagesCommand",
+    "PdfToTextCommand",
+    "ReadTextVersionCommand",
+    "ReadTomlCommand",
+    "ReadTomlVersionCommand",
+    "RunCommand",
+    "RunDAGCommands",
+    "RunParallelCommands",
+    "RunSequentialCommands",
+    "RunShellCommand",
+    "SchedulerMetrics",
+    "SetEnvCommand",
+    "SplitPdfCommand",
+    "UpdateTextVersionCommand",
+    "UpdateTomlVersionCommand",
+    "WriteFileCommand",
+    "WriteTomlCommand",
+]

bitool/cmd/_base.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+
+from abc import abstractmethod
+from dataclasses import dataclass, field
+from typing import Callable
+
+from bitool.cmd._condition import Condition
+from bitool.core import logger
+
+
+@dataclass
+class BaseCommand:
+    """命令基类.
+
+    提供命令的基础功能,包括条件检查、依赖管理和执行控制.
+    所有自定义命令应继承此类并实现 run 方法.
+
+    Attributes:
+        name: 命令名称,用于标识和日志输出.
+        description: 命令描述信息.
+        allow_conditions: 允许条件列表,所有条件满足时命令才会执行.
+        forbid_conditions: 禁止条件列表,任一条件满足时命令不会执行.
+        dependencies: 依赖的命令名称列表.
+    """
+
+    name: str = "base"
+    description: str = "base command"
+    allow_conditions: list[Condition | tuple[Callable[[], bool], str]] = field(
+        default_factory=list
+    )
+    forbid_conditions: list[Condition | tuple[Callable[[], bool], str]] = field(
+        default_factory=list
+    )
+    dependencies: list[str] = field(default_factory=list)
+
+    def __post_init__(self) -> None:
+        """数据类初始化后的处理.
+
+        将传入的 tuple 或 Condition 对象统一转换为 Condition 对象.
+        """
+        # 将传入的 tuple 或 Condition 对象统一转换为 Condition 对象
+        self.allow_conditions = [Condition.from_data(c) for c in self.allow_conditions]
+        self.forbid_conditions = [
+            Condition.from_data(c) for c in self.forbid_conditions
+        ]
+
+    @abstractmethod
+    def run(self) -> bool:
+        """运行命令.
+
+        Returns:
+            命令执行是否成功.
+
+        Raises:
+            NotImplementedError: 子类必须实现此方法.
+        """
+        raise NotImplementedError
+
+    def validate_and_run(self) -> bool:
+        """检查条件并运行命令.
+
+        Returns:
+            命令执行是否成功.如果条件不满足则返回 False.
+        """
+        if self.validate():
+            return self.run()
+
+        return False
+
+    def validate(self) -> bool:
+        """检查命令是否可以运行.
+
+        验证允许条件和禁止条件:
+        - 所有允许条件必须满足
+        - 任何禁止条件都不能满足
+
+        Returns:
+            是否满足执行条件.
+        """
+        allow_results = [
+            (c.func(), c.reason)
+            for c in self.allow_conditions
+            if isinstance(c, Condition)
+        ]
+        forbid_results = [
+            (c.func(), c.reason)
+            for c in self.forbid_conditions
+            if isinstance(c, Condition)
+        ]
+
+        # 检查允许条件：所有条件都必须满足
+        if not all(r for r, _ in allow_results):
+            logger.warning(
+                f"命令`{self.__class__!s}`条件不满足，跳过执行, 不满足项: {[reason for r, reason in allow_results if not r]}"
+            )
+            return False
+
+        # 检查禁止条件：任何条件都不应满足
+        if any(r for r, _ in forbid_results):
+            logger.warning(
+                f"命令`{self.__class__!s}`条件不满足，跳过执行, 禁止项: {[reason for r, reason in forbid_results if r]}"
+            )
+            return False
+
+        return True

bitool/cmd/_condition.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+from shutil import which
+from typing import Callable
+
+from bitool.consts import Constants
+
+__all__ = ["Condition"]
+
+
+@dataclass
+class Condition:
+    """命令条件类"""
+
+    func: Callable[[], bool]
+    reason: str = "未知原因"
+
+    @classmethod
+    def from_data(cls, data: tuple[Callable[[], bool], str] | Condition) -> Condition:
+        """从 tuple 或 Condition 对象创建 Condition 实例."""
+        if isinstance(data, Condition):
+            return data
+        return cls(func=data[0], reason=data[1])
+
+
+class BuiltinConditions:
+    """内置条件类"""
+
+    IS_WINDOWS = Condition(lambda: Constants.IS_WINDOWS, "当前系统是 Windows")
+    IS_UNIX = Condition(lambda: Constants.IS_UNIX, "当前系统是 Unix")
+
+    @staticmethod
+    def HAS_APP_INSTALLED(app: str) -> Condition:
+        """检查系统中是否已安装指定应用.
+
+        Args:
+            app: 应用程序名称.
+
+        Returns:
+            Condition实例.
+        """
+        return Condition(lambda: which(app) is not None, f"{app} 已安装")
+
+    @staticmethod
+    def HAS_ENTRY_IN_DIR(entry: str, directory: Path) -> Condition:
+        """检查系统路径中是否包含指定条目.
+
+        Args:
+            entry: 条目名称.
+            directory: 目录路径.
+
+        Returns:
+            Condition实例.
+        """
+        return Condition(
+            lambda: entry.lower() in [f.name.lower() for f in directory.iterdir()],
+            f"{entry} 在 {directory} 中",
+        )