bitool 0.1.2__py3-none-any.whl

bitool/scripts/pymake.py

@@ -0,0 +1,345 @@
+"""Python构建工具模块.
+
+完全替代传统的 Makefile, 提供更好的跨平台兼容性和 Python 生态集成.
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from bitool.cmd import BuiltinConditions, CommandScheduler, RunCommand
+from bitool.consts import Constants
+from bitool.core import ConfigMixin, logger
+
+
+class PyMakeConfig(ConfigMixin):
+    """PyMake 配置类."""
+
+    # 项目根目录
+    PROJECT_ROOT = Path(__file__).parent.parent.parent.parent
+    CORE_DIR = PROJECT_ROOT / "bitool-core"
+    BUILD_TIMEOUT = 600
+
+    # Python 构建
+    BUILD_TOOL = "uv"
+    BUILD_COMMAND = [BUILD_TOOL, "build"]  # noqa: RUF012
+
+    # Rust 构建 (maturin)
+    MATURIN_TOOL = "maturin"
+    MATURIN_BUILD_COMMAND = ["maturin", "build", "-r"]  # noqa: RUF012
+    MATURIN_DEV_COMMAND = ["maturin", "develop"]  # noqa: RUF012
+    MATURIN_BUILD_OPTIONS_WIN7 = [  # noqa: RUF012
+        "--target",
+        "x86_64-win7-windows-msvc",
+        "-Zbuild-std",
+        "-i",
+        "python3.8",
+    ]
+
+    # 文档
+    DOC_BUILD_TOOL = "sphinx-build"
+    DOC_BUILD_COMMAND = ["sphinx-build", "-b", "html", "docs", "docs/_build"]  # noqa: RUF012
+
+    # 清理
+    DIRS_TO_IGNORE: list[str] = [".venv"]  # noqa: RUF012
+    PYTHON_BUILD_DIRS = ["dist", "build", "*.egg-info", "src/*.egg-info"]  # noqa: RUF012
+
+
+conf = PyMakeConfig()
+
+# 命令条件判断
+_MATURIN_CONDITION = BuiltinConditions.HAS_APP_INSTALLED(conf.MATURIN_TOOL)
+_PYTEST_CONDITION = BuiltinConditions.HAS_APP_INSTALLED("pytest")
+_UV_CONDITION = BuiltinConditions.HAS_APP_INSTALLED(conf.BUILD_TOOL)
+_RUFF_CONDITION = BuiltinConditions.HAS_APP_INSTALLED("ruff")
+_GIT_CONDITION = BuiltinConditions.HAS_APP_INSTALLED("git")
+
+
+def _get_maturin_build_command() -> list[str]:
+    """获取 maturin 构建命令（根据平台自动添加参数）.
+
+    Returns
+    -------
+    list[str]
+        完整的 maturin 构建命令列表.
+    """
+    base_cmd = conf.MATURIN_BUILD_COMMAND.copy()
+    if Constants.IS_WINDOWS:
+        base_cmd.extend(conf.MATURIN_BUILD_OPTIONS_WIN7)
+    return base_cmd
+
+
+def create_scheduler_map() -> dict[str, CommandScheduler]:
+    """创建命令调度器映射.
+
+    Returns
+    -------
+    dict[str, CommandScheduler]
+        操作名称到命令调度器的映射字典.
+    """
+    return {
+        # === 构建命令 ===
+        # 构建 Python 包
+        "b": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=conf.BUILD_COMMAND,
+                    allow_conditions=[_UV_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                )
+            ]
+        ),
+        # 构建 Rust 核心模块
+        "bc": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=_get_maturin_build_command(),
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                )
+            ]
+        ),
+        # 构建双包（先 Rust 后 Python）
+        "ba": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=_get_maturin_build_command(),
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                ),
+                RunCommand(
+                    cmd=conf.BUILD_COMMAND,
+                    allow_conditions=[_UV_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                ),
+            ]
+        ),
+        # === 安装命令（开发模式） ===
+        # 安装 Rust 核心模块
+        "ic": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=conf.MATURIN_DEV_COMMAND,
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                )
+            ]
+        ),
+        # 安装 Python 主包
+        "ip": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["uv", "pip", "install", "-e", "."],
+                    allow_conditions=[_UV_CONDITION],
+                )
+            ]
+        ),
+        # 安装双包（开发模式）
+        "ia": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=conf.MATURIN_DEV_COMMAND,
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                ),
+                RunCommand(
+                    cmd=["uv", "pip", "install", "-e", "."],
+                    allow_conditions=[_UV_CONDITION],
+                ),
+            ]
+        ),
+        # === 清理命令 ===
+        # 清理 Python 构建产物
+        "cp": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["rm", "-rf", *conf.PYTHON_BUILD_DIRS],
+                    allow_conditions=[_GIT_CONDITION],  # 使用 git clean 更安全
+                )
+            ]
+        ),
+        # 清理 Rust 构建产物
+        "cc": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["cargo", "clean"],
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],  # 有 maturin 说明有 cargo
+                )
+            ]
+        ),
+        # 清理所有构建产物
+        "ca": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["cargo", "clean"],
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                ),
+                RunCommand(
+                    cmd=["git", "clean", "-xfd", "-e", *conf.DIRS_TO_IGNORE],
+                    allow_conditions=[_GIT_CONDITION],
+                ),
+            ]
+        ),
+        # === 开发工具 ===
+        # 运行测试
+        "t": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["pytest", "-n", "8"], allow_conditions=[_PYTEST_CONDITION]
+                )
+            ]
+        ),
+        # 运行测试并生成覆盖率报告
+        "tc": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["pytest", "--cov", "-n", "8"],
+                    allow_conditions=[_PYTEST_CONDITION],
+                )
+            ]
+        ),
+        # 代码格式化与检查
+        "lint": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["ruff", "format", "src/bitool"],
+                    allow_conditions=[_RUFF_CONDITION],
+                ),
+                RunCommand(
+                    cmd=["ruff", "check", "--fix", "--unsafe-fixes", "src/bitool"],
+                    allow_conditions=[_RUFF_CONDITION],
+                ),
+            ]
+        ),
+        # 类型检查
+        "typecheck": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=["ty", "check", "src/bitool"],
+                    allow_conditions=[BuiltinConditions.HAS_APP_INSTALLED("ty")],
+                )
+            ]
+        ),
+        # 构建文档
+        "doc": CommandScheduler(
+            commands=[
+                RunCommand(
+                    cmd=conf.DOC_BUILD_COMMAND,
+                    allow_conditions=[
+                        BuiltinConditions.HAS_APP_INSTALLED(conf.DOC_BUILD_TOOL)
+                    ],
+                )
+            ]
+        ),
+        # 发布到 PyPI（先发布 Rust 核心模块，再发布 Python 主包）
+        "pb": CommandScheduler(
+            commands=[
+                # 发布 Rust 核心模块
+                RunCommand(
+                    cmd=["maturin", "publish", "-r"],
+                    cwd=conf.CORE_DIR,
+                    allow_conditions=[_MATURIN_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                ),
+                # 发布 Python 主包
+                RunCommand(
+                    cmd=["uv", "publish"],
+                    allow_conditions=[_UV_CONDITION],
+                    timeout=conf.BUILD_TIMEOUT,
+                ),
+            ]
+        ),
+    }
+
+
+OPTIONS: list[str] = list(create_scheduler_map().keys())
+
+
+def show_help() -> str:
+    """显示帮助信息."""
+    help_text = """
+╔══════════════════════════════════════════════════════════╗
+║                  Bitool PyMake 构建工具                  ║
+╚══════════════════════════════════════════════════════════╝
+
+🔨 构建命令:
+  pymake b    - 构建 Python 主包 (uv build)
+  pymake bc   - 构建 Rust 核心模块 (maturin build)
+  pymake ba   - 构建所有包 (先 Rust 后 Python)
+
+📦 安装命令 (开发模式):
+  pymake ic   - 安装 Rust 核心模块 (maturin develop)
+  pymake ip   - 安装 Python 主包 (uv pip install -e .)
+  pymake ia   - 安装所有包 (开发模式，推荐)
+
+🧹 清理命令:
+  pymake cp   - 清理 Python 构建产物
+  pymake cc   - 清理 Rust 构建产物 (cargo clean)
+  pymake ca   - 清理所有构建产物
+
+🛠️  开发工具:
+  pymake t      - 运行测试 (pytest)
+  pymake tc     - 运行测试并生成覆盖率报告
+  pymake lint   - 代码格式化与检查 (ruff)
+  pymake typecheck - 类型检查 (ty)
+  pymake doc    - 构建文档 (sphinx)
+
+📦 发布命令:
+  pymake pb   - 发布到 PyPI (先 Rust 后 Python)
+
+💡 常用工作流:
+  1. 初始化开发环境: pymake ia
+  2. 日常开发: pymake lint && pymake t
+  3. 构建发布包: pymake ba
+  4. 发布到 PyPI: pymake pb
+  5. 清理重新开始: pymake ca && pymake ia
+
+📝 示例:
+  pymake ba          # 构建所有包
+  pymake ia          # 安装开发环境
+  pymake t           # 运行测试
+  pymake lint        # 格式化代码
+  pymake ca          # 清理所有构建产物
+"""
+    return help_text
+
+
+def parse_args() -> tuple[argparse.ArgumentParser, argparse.Namespace]:
+    """解析命令行参数.
+
+    Returns
+    -------
+    argparse.Namespace
+        解析后的命令行参数对象.
+    """
+    parser = argparse.ArgumentParser(
+        description="Bitool PyMake - Python构建工具（支持双包构建）",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog=show_help(),
+    )
+    parser.add_argument(
+        "action",
+        nargs="?",
+        type=str,
+        help="要执行的操作, 可选值: " + ", ".join(OPTIONS),
+    )
+    return parser, parser.parse_args()
+
+
+def main() -> None:
+    """主函数, 执行Python构建工具命令."""
+    parser, args = parse_args()
+
+    scheduler: CommandScheduler | None = create_scheduler_map().get(args.action, None)
+    if not scheduler:
+        logger.error(f"无效的操作: {args.action}")
+        parser.print_help(sys.stderr)
+        sys.exit(1)
+
+    scheduler.run()