shipcli 0.0.1__py3-none-any.whl

shipcli/commands/upgrade.py

@@ -0,0 +1,83 @@
+"""shipcli upgrade 子命令。
+
+升级 shipcli 自身：
+- 默认从 PyPI 拉发布版（`pip install --upgrade shipcli`）。
+- `--local <path>` 从本地项目的 build 产物装：`--version X` 指定版本，缺省取最新。
+"""
+
+from __future__ import annotations
+
+import subprocess
+import sys
+from pathlib import Path
+from typing import Any
+
+from shipcli.console import Console
+from shipcli.installer import latest_product_version
+
+
+PACKAGE_NAME = "shipcli"
+
+
+def run_upgrade(args: Any, console: Console) -> int:
+    """升级 shipcli 自身：默认 PyPI，--local 走本地 build 产物。"""
+    try:
+        if args.local:
+            version = _upgrade_from_local(Path(args.local).resolve(), args.version)
+        else:
+            version = _upgrade_from_pypi(args.version)
+    except Exception as exc:  # noqa: BLE001 - CLI 统一兜底输出错误信息
+        console.print(f"错误: {exc}")
+        return 1
+    console.print(f"升级完成：{version}")
+    console.print("此命令只管 shipcli 自己；项目 CLI（如 demo-cli）用其自带命令升级。")
+    return 0
+
+
+def _upgrade_from_pypi(version: str | None) -> str:
+    """从 PyPI 升级到最新或指定发布版本。"""
+    spec = [PACKAGE_NAME, "--upgrade"] if version is None else [f"{PACKAGE_NAME}=={version}"]
+    subprocess.run(
+        [sys.executable, "-m", "pip", "install", *spec, "--disable-pip-version-check"],
+        check=True,
+    )
+    return version or _installed_version() or "latest"
+
+
+def _upgrade_from_local(project_root: Path, version: str | None) -> str:
+    """从本地项目的 build 产物升级；version 缺省时取最新版本。"""
+    resolved = version or latest_product_version(project_root)
+    wheel = _find_local_wheel(project_root, resolved)
+    subprocess.run(
+        [sys.executable, "-m", "pip", "install", "--force-reinstall", str(wheel), "--disable-pip-version-check"],
+        check=True,
+    )
+    return resolved
+
+
+def _find_local_wheel(project_root: Path, version: str) -> Path:
+    """定位本地某版本 build 产物中的 wheel 文件。"""
+    from shipcli.config import load_config
+
+    config = load_config(project_root)
+    dist_dir = project_root / config["build_root"] / "dist" / version / "dist"
+    wheels = sorted(dist_dir.glob("*.whl")) if dist_dir.is_dir() else []
+    if not wheels:
+        raise FileNotFoundError(
+            f"未找到本地 {version} 的 wheel：{dist_dir}，请先执行 `shipcli build`"
+        )
+    return wheels[0]
+
+
+def _installed_version() -> str | None:
+    """读取当前已安装的 shipcli 版本号；失败时返回 None。"""
+    result = subprocess.run(
+        [sys.executable, "-m", "pip", "show", PACKAGE_NAME, "--disable-pip-version-check"],
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+    for line in result.stdout.splitlines():
+        if line.startswith("Version:"):
+            return line.split(":", 1)[1].strip()
+    return None

shipcli/config.py

@@ -0,0 +1,35 @@
+"""shipcli 构建配置读取。"""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import TypedDict
+
+
+class BuildConfig(TypedDict):
+    """`build.config.json` 的字段结构。"""
+
+    app_name: str
+    entry: str
+    build_root: str
+    version: str
+    build: int
+
+
+def config_path(project_root: Path) -> Path:
+    """返回项目根目录下的构建配置路径。"""
+    return project_root / "build.config.json"
+
+
+def load_config(project_root: Path) -> BuildConfig:
+    """读取项目构建配置。"""
+    path = config_path(project_root)
+    data = json.loads(path.read_text(encoding="utf-8"))
+    return BuildConfig(
+        app_name=data["app_name"],
+        entry=data["entry"],
+        build_root=data.get("build_root", ".build"),
+        version=data["version"],
+        build=int(data["build"]),
+    )

shipcli/console.py

@@ -0,0 +1,33 @@
+"""shipcli 终端 I/O 抽象。"""
+
+from __future__ import annotations
+
+from typing import List
+
+
+class Console:
+    """终端 I/O 基类。"""
+
+    def print(self, message: str = "") -> None:  # noqa: A003
+        """输出一行到终端。"""
+        raise NotImplementedError
+
+
+class TerminalConsole(Console):
+    """默认终端输出实现。"""
+
+    def print(self, message: str = "") -> None:
+        """把文本打印到标准输出。"""
+        print(message)
+
+
+class FakeConsole(Console):
+    """测试桩，记录输出内容。"""
+
+    def __init__(self) -> None:
+        """初始化测试输出缓冲区。"""
+        self.stdout: List[str] = []
+
+    def print(self, message: str = "") -> None:
+        """追加一条输出，供测试断言。"""
+        self.stdout.append(message)

shipcli/installer.py

@@ -0,0 +1,209 @@
+"""shipcli 纯 Python 安装、升级与卸载流程。"""
+
+from __future__ import annotations
+
+import json
+import os
+import shutil
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any
+
+from shipcli.config import load_config
+
+
+@dataclass(frozen=True)
+class InstallPlan:
+    """描述一次安装的目标位置。"""
+
+    app_name: str
+    install_dir: Path
+    exec_path: Path
+    current_dir: Path
+    link_dir: Path
+    link_path: Path
+    build_dist_dir: Path
+    entry_path: Path
+
+
+def read_install_metadata(install_dir: Path) -> dict[str, Any]:
+    """读取安装元信息；不存在或解析失败时返回空字典。"""
+    path = install_dir / "VERSION.installed"
+    if not path.is_file():
+        return {}
+    try:
+        data = json.loads(path.read_text(encoding="utf-8"))
+    except (OSError, json.JSONDecodeError):
+        return {}
+    return data if isinstance(data, dict) else {}
+
+
+def build_install_plan(project_root: Path) -> InstallPlan:
+    """根据项目配置生成安装计划。"""
+    config = load_config(project_root)
+    app_name = config["app_name"]
+    install_dir = Path.home() / f".{app_name}-cli"
+    link_dir = Path("/usr/local/bin") if os.access("/usr/local/bin", os.W_OK) else Path.home() / ".local" / "bin"
+    return InstallPlan(
+        app_name=app_name,
+        install_dir=install_dir,
+        exec_path=install_dir / app_name,
+        current_dir=install_dir / "current",
+        link_dir=link_dir,
+        link_path=link_dir / app_name,
+        build_dist_dir=project_root / config["build_root"] / "dist",
+        entry_path=project_root / config["entry"],
+    )
+
+
+def source_module_name(entry: str) -> str | None:
+    """把 `pkg/__main__.py` 转成 `pkg`，其余入口返回 `None`。"""
+    if entry.endswith("/__main__.py"):
+        return entry[: -len("/__main__.py")].replace("/", ".")
+    return None
+
+
+def install_project(project_root: Path, version: str | None = None) -> InstallPlan:
+    """安装源码入口或指定版本产物，并创建稳定符号链接。"""
+    plan = build_install_plan(project_root)
+    plan.install_dir.mkdir(parents=True, exist_ok=True)
+    plan.link_dir.mkdir(parents=True, exist_ok=True)
+    if version:
+        _install_product(plan, version)
+    else:
+        _install_source(project_root, plan)
+    if plan.link_path.exists() or plan.link_path.is_symlink():
+        plan.link_path.unlink()
+    plan.link_path.symlink_to(plan.exec_path)
+    return plan
+
+
+def _install_source(project_root: Path, plan: InstallPlan) -> None:
+    """安装源码入口包装脚本。"""
+    config = load_config(project_root)
+    module_name = source_module_name(config["entry"])
+    if not plan.entry_path.is_file():
+        raise FileNotFoundError(f"源码入口不存在：{config['entry']}")
+    if module_name:
+        body = _python_wrapper(
+            (
+                "import os, subprocess, sys\n"
+                f'os.chdir({project_root.as_posix()!r})\n'
+                f"raise SystemExit(subprocess.call([sys.executable, '-m', {module_name!r}, *sys.argv[1:]]))\n"
+            )
+        )
+    else:
+        body = _python_wrapper(
+            (
+                "import os, subprocess, sys\n"
+                f'os.chdir({project_root.as_posix()!r})\n'
+                f"raise SystemExit(subprocess.call([sys.executable, {str(plan.entry_path)!r}, *sys.argv[1:]]))\n"
+            )
+        )
+    plan.exec_path.write_text(body, encoding="utf-8")
+    plan.exec_path.chmod(0o755)
+    if plan.current_dir.exists():
+        shutil.rmtree(plan.current_dir)
+    _write_metadata(plan, installed_from="source", install_mode="source")
+
+
+def _install_product(plan: InstallPlan, version: str) -> None:
+    """安装指定版本的本地 wheel 产物。"""
+    dist_dir = plan.build_dist_dir / version / "dist"
+    wheels = sorted(dist_dir.glob("*.whl")) if dist_dir.is_dir() else []
+    if not wheels:
+        raise FileNotFoundError(
+            f"指定版本产物不存在：{dist_dir}，请先执行 `shipcli build`"
+        )
+
+    import subprocess
+    import sys
+
+    subprocess.run(
+        [sys.executable, "-m", "pip", "install", "--force-reinstall", str(wheels[0]), "--disable-pip-version-check"],
+        check=True,
+    )
+
+    if plan.current_dir.exists():
+        shutil.rmtree(plan.current_dir)
+    body = _python_wrapper(
+        f"import subprocess, sys\nraise SystemExit(subprocess.call([sys.executable, '-m', {plan.app_name!r}, *sys.argv[1:]]))\n"
+    )
+    plan.exec_path.write_text(body, encoding="utf-8")
+    plan.exec_path.chmod(0o755)
+    _write_metadata(plan, installed_from=version, install_mode="wheel")
+
+
+def _python_wrapper(body: str) -> str:
+    """生成稳定的 Python 包装脚本内容。"""
+    return "#!/usr/bin/env python3\n" + body
+
+
+def _write_metadata(plan: InstallPlan, installed_from: str, install_mode: str) -> None:
+    """写入安装元信息，供后续 upgrade 等命令复用。"""
+    metadata = {
+        "installed_from": installed_from,
+        "build_dist_dir": str(plan.build_dist_dir),
+        "install_mode": install_mode,
+        "app_name": plan.app_name,
+    }
+    (plan.install_dir / "VERSION.installed").write_text(
+        json.dumps(metadata, ensure_ascii=False, indent=2) + "\n",
+        encoding="utf-8",
+    )
+
+
+def latest_product_version(project_root: Path) -> str:
+    """返回构建目录中最新的可安装产物版本（按 wheel/sdist 目录判断）。"""
+    plan = build_install_plan(project_root)
+    dist = plan.build_dist_dir
+    if not dist.is_dir():
+        raise FileNotFoundError(f"构建产物目录不存在：{dist}")
+    candidates = []
+    for sub in dist.iterdir():
+        if not sub.is_dir():
+            continue
+        # 方向 A：产物是 wheel/sdist，放在版本目录下的 dist/ 里。
+        if (sub / "dist").is_dir() and any((sub / "dist").glob("*.whl")):
+            candidates.append(sub.name)
+    if not candidates:
+        raise FileNotFoundError(f"未找到可安装产物：{dist}")
+    candidates.sort(key=_version_sort_key)
+    return candidates[-1]
+
+
+def upgrade_project(project_root: Path, version: str | None = None) -> tuple[InstallPlan, str]:
+    """升级当前项目的本地安装到最新或指定版本。"""
+    target_version = version or latest_product_version(project_root)
+    plan = install_project(project_root, version=target_version)
+    return plan, target_version
+
+
+def uninstall_project(project_root: Path) -> InstallPlan:
+    """卸载当前项目的本地安装与符号链接。"""
+    plan = build_install_plan(project_root)
+    if plan.link_path.exists() or plan.link_path.is_symlink():
+        plan.link_path.unlink()
+    if plan.install_dir.exists():
+        shutil.rmtree(plan.install_dir)
+    return plan
+
+
+def _version_sort_key(version_str: str) -> tuple[int, int, int, int, int]:
+    """给 release/dev 版本字符串生成排序键（兼容 `.devN` 与 `-devN`）。"""
+    dev = 0
+    base = version_str
+    for sep in (".dev", "-dev"):
+        if sep in base:
+            base, dev_part = base.split(sep, 1)
+            dev = int(dev_part)
+            break
+    # dev 标记 0 表示 dev 版（排序靠后于 release？不：dev 应低于同版本 release）。
+    segments = base.split(".")
+    if len(segments) != 3 or not all(seg.isdigit() for seg in segments):
+        # 非标准三段版本：退化为按字符串排，确保不抛异常。
+        return (0, 0, 0, 0, 0)
+    major, minor, patch = (int(seg) for seg in segments)
+    # release（dev==0 且无 dev 标记）排在 dev 之上：用 is_release 区分。
+    is_release = 0 if (".dev" in version_str or "-dev" in version_str) else 1
+    return (major, minor, patch, is_release, dev)