bitool 0.1.2__py3-none-any.whl

bitool/cmd/env.py

@@ -0,0 +1,454 @@
+"""环境变量操作模块, 提供用户友好的环境变量配置接口."""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from pathlib import Path
+
+from ..consts import Constants
+from ..core import logger
+from ..utils.executor import execute
+from ._base import BaseCommand
+
+
+@dataclass
+class _EnvironmentVar:
+    """环境变量数据类"""
+
+    name: str
+    value: str
+
+
+__all__ = [
+    "ExportEnvCommand",
+    "GetEnvCommand",
+    "ImportEnvCommand",
+    "ListEnvCommand",
+    "SetEnvCommand",
+    "UnsetEnvCommand",
+]
+
+
+class GetEnvCommand(BaseCommand):
+    """获取环境变量命令"""
+
+    name = "getenv"
+    description = "获取环境变量值"
+
+    def __init__(self, name: str, default: str | None = None) -> None:
+        super().__init__()
+        self.name_val: str = name
+        self.default: str | None = default
+        self.value: str | None = None
+
+    def run(self) -> bool:
+        """获取环境变量值"""
+        self.value = os.environ.get(self.name_val, self.default)
+        if self.value is not None:
+            logger.info(f"环境变量 {self.name_val}={self.value}")
+        else:
+            logger.warning(f"环境变量 {self.name_val} 未设置")
+        return self.value is not None
+
+
+class UnsetEnvCommand(BaseCommand):
+    """删除环境变量命令"""
+
+    name = "unsetenv"
+    description = "删除环境变量"
+
+    def __init__(self, name: str) -> None:
+        super().__init__()
+        self.name = name
+
+    def run(self) -> bool:
+        """删除环境变量"""
+        if self.name in os.environ:
+            del os.environ[self.name]
+            logger.info(f"已删除环境变量: {self.name}")
+            return True
+        else:
+            logger.warning(f"环境变量 {self.name} 不存在")
+            return False
+
+
+class ListEnvCommand(BaseCommand):
+    """列出环境变量命令"""
+
+    name = "listenv"
+    description = "列出环境变量"
+
+    def __init__(self, pattern: str | None = None) -> None:
+        super().__init__()
+        self.pattern: str | None = pattern
+        self.envs: dict[str, str] = {}
+
+    def run(self) -> bool:
+        """列出环境变量"""
+        self.envs = dict(os.environ)
+        if self.pattern:
+            self.envs = {
+                k: v for k, v in self.envs.items() if self.pattern.lower() in k.lower()
+            }
+
+        if self.envs:
+            logger.info(f"找到 {len(self.envs)} 个环境变量")
+            for key, value in self.envs.items():
+                logger.info(f"  {key}={value}")
+        else:
+            logger.warning("未找到匹配的环境变量")
+        return len(self.envs) > 0
+
+
+class ExportEnvCommand(BaseCommand):
+    """导出环境变量命令"""
+
+    name = "exportenv"
+    description = "导出环境变量到文件"
+
+    def __init__(self, filepath: str, shell_type: str = "bash") -> None:
+        super().__init__()
+        self.filepath: str = filepath
+        self.shell_type: str = shell_type
+
+    def run(self) -> bool:
+        """导出环境变量到文件"""
+
+        from bitool.cmd.io import WriteFileCommand
+
+        # 生成环境变量脚本内容
+        filepath_path = Path(self.filepath)
+        lines: list[str] = []
+        if self.shell_type == "cmd":
+            lines.append("@echo off")
+            lines.append(":: 环境变量配置脚本")
+            for key, value in os.environ.items():
+                lines.append(f"set {key}={value}")
+        elif self.shell_type == "powershell":
+            lines.append("# 环境变量配置脚本 (PowerShell)")
+            for key, value in os.environ.items():
+                lines.append(f'$env:{key}="{value}"')
+        else:  # bash/sh 脚本
+            lines.append("#!/bin/bash")
+            lines.append("# 环境变量配置脚本")
+            for key, value in os.environ.items():
+                lines.append(f'export {key}="{value}"')
+
+        content = "\n".join(lines) + "\n"
+
+        # 使用 WriteFileCommand 写入文件
+        write_cmd = WriteFileCommand(
+            filepath=filepath_path, content=content, overwrite=True, backup=False
+        )
+        return write_cmd.run()
+
+
+class ImportEnvCommand(BaseCommand):
+    """导入环境变量命令"""
+
+    name = "importenv"
+    description = "从文件导入环境变量"
+
+    def __init__(self, filepath: str) -> None:
+        super().__init__()
+        self.filepath: str = filepath
+        self.count: int = 0
+
+    def run(self) -> bool:
+        """从文件导入环境变量"""
+        filepath_path = Path(self.filepath)
+        if not filepath_path.exists():
+            logger.error(f"文件不存在: {self.filepath}")
+            return False
+
+        try:
+            count = 0
+            with filepath_path.open("r", encoding="utf-8") as f:
+                for line in f:
+                    line = line.strip()
+                    # 跳过注释和空行
+                    if not line or line.startswith("#") or line.startswith("@"):
+                        continue
+
+                    # 解析 export VAR=value (bash)
+                    if line.startswith("export "):
+                        line = line[7:]  # 移除 "export "
+                        if "=" in line:
+                            key, value = line.split("=", 1)
+                            # 移除引号
+                            value = value.strip("'\"")
+                            os.environ[key] = value
+                            count += 1
+
+                    # 解析 set VAR=value (cmd)
+                    elif line.startswith("set "):
+                        line = line[4:]  # 移除 "set "
+                        if "=" in line:
+                            key, value = line.split("=", 1)
+                            os.environ[key] = value
+                            count += 1
+
+                    # 解析 $env:VAR="value" (powershell)
+                    elif line.startswith("$env:"):
+                        line = line[5:]  # 移除 "$env:"
+                        if "=" in line:
+                            key, value = line.split("=", 1)
+                            # 移除引号
+                            value = value.strip("'\"")
+                            os.environ[key] = value
+                            count += 1
+
+            self.count = count
+            logger.info(f"从文件导入了 {count} 个环境变量: {self.filepath}")
+        except Exception as e:  # noqa: BLE001
+            logger.error(f"导入环境变量失败: {e}")
+            return False
+        else:
+            return count > 0
+
+
+class SetEnvCommand(BaseCommand):
+    """设置环境变量命令"""
+
+    name = "setenv"
+    description = "设置环境变量"
+
+    def __init__(self, envs: list[tuple[str, str]]) -> None:
+        super().__init__()
+
+        self.envs: list[_EnvironmentVar] = [
+            _EnvironmentVar(name, value) for name, value in envs
+        ]
+
+    def run(self) -> bool:
+        """设置环境变量"""
+        if not self.envs:
+            logger.warning("未提供环境变量对")
+            return False
+
+        if Constants.IS_WINDOWS:
+            for env_var in self.envs:
+                execute(["setx", env_var.name, env_var.value])
+        else:
+            bashrc_path = os.path.expanduser("~/.bashrc")
+            # 读取现有的 bashrc 内容
+            existing_lines = []
+            if os.path.exists(bashrc_path):
+                with open(bashrc_path, encoding="utf-8") as f:
+                    existing_lines = f.readlines()
+
+            # 追踪需要更新的环境变量
+            env_names = {env_var.name for env_var in self.envs}
+
+            # 过滤掉已存在的环境变量行，并构建新的内容
+            new_lines = []
+            for line in existing_lines:
+                # 检查是否是 export 语句且匹配我们要设置的环境变量
+                if line.strip().startswith("export "):
+                    # 提取变量名
+                    export_part = line.strip()[7:]  # 去掉 "export "
+                    if "=" in export_part:
+                        var_name = export_part.split("=", 1)[0]
+                        if var_name not in env_names:
+                            new_lines.append(line)
+                    else:
+                        new_lines.append(line)
+                else:
+                    new_lines.append(line)
+
+            # 添加新的环境变量配置
+            new_lines.extend(
+                f"export {env_var.name}={env_var.value}\n" for env_var in self.envs
+            )
+
+            # 写回 bashrc 文件
+            with open(bashrc_path, "w", encoding="utf-8") as f:
+                f.writelines(new_lines)
+
+        return True
+
+
+class EnvOps:
+    """环境变量操作类
+
+    提供环境变量的查看、设置、删除、导入/导出等功能
+    """
+
+    def __init__(self) -> None:
+        """初始化环境变量操作实例"""
+        self._envs: dict[str, str] = {}
+
+    def get(self, name: str, default: str | None = None) -> str | None:
+        """获取环境变量值
+
+        Args:
+            name: 环境变量名称
+            default: 默认值
+
+        Returns:
+            环境变量值或默认值
+        """
+        return os.environ.get(name, default)
+
+    def set(self, name: str, value: str, *, persistent: bool = False) -> None:
+        """设置环境变量
+
+        Args:
+            name: 环境变量名称
+            value: 环境变量值
+            persistent: 是否保存到内部配置（用于后续恢复）
+        """
+        os.environ[name] = value
+        logger.info(f"已设置环境变量: {name}={value}")
+
+        if persistent:
+            self._envs[name] = value
+            logger.info(f"已保存环境变量到配置: {name}")
+
+    def unset(self, name: str, *, remove_persistent: bool = False) -> None:
+        """删除环境变量
+
+        Args:
+            name: 环境变量名称
+            remove_persistent: 是否同时从内部配置中删除
+        """
+        if name in os.environ:
+            del os.environ[name]
+            logger.info(f"已删除环境变量: {name}")
+
+        if remove_persistent and name in self._envs:
+            del self._envs[name]
+            logger.info(f"已从配置中删除: {name}")
+
+    def list_env(self, pattern: str | None = None) -> dict[str, str]:
+        """列出当前环境变量
+
+        Args:
+            pattern: 可选的过滤模式，只返回包含该模式的变量
+
+        Returns:
+            环境变量字典
+        """
+        envs = dict(os.environ)
+        if pattern:
+            envs = {k: v for k, v in envs.items() if pattern.lower() in k.lower()}
+        return envs
+
+    def show_config(self) -> dict[str, str]:
+        """显示持久化的环境变量配置
+
+        Returns:
+            持久化的环境变量字典
+        """
+        return self._envs.copy()
+
+    def restore(self) -> dict[str, str]:
+        """恢复持久化的环境变量
+
+        Returns:
+            已恢复的环境变量字典
+        """
+        restored = {}
+        for key, value in self._envs.items():
+            os.environ[key] = value
+            restored[key] = value
+            logger.info(f"已恢复环境变量: {key}={value}")
+        return restored
+
+    def clear_all(self) -> None:
+        """清除所有配置的环境变量"""
+        for key in list(self._envs.keys()):
+            if key in os.environ:
+                del os.environ[key]
+                logger.info(f"已删除环境变量: {key}")
+
+        self._envs.clear()
+        logger.info("已清除所有环境变量配置")
+
+    def export_to_file(self, filepath: str, *, shell_type: str = "bash") -> None:
+        """导出环境变量到脚本文件
+
+        Args:
+            filepath: 输出文件路径
+            shell_type: 脚本类型 (bash/cmd/powershell)，默认"bash"
+        """
+        filepath_path = Path(filepath)
+        filepath_path.parent.mkdir(parents=True, exist_ok=True)
+
+        lines = []
+        if shell_type == "cmd":
+            lines.append("@echo off")
+            lines.append(":: 环境变量配置脚本")
+            for key, value in self._envs.items():
+                lines.append(f"set {key}={value}")
+        elif shell_type == "powershell":
+            lines.append("# 环境变量配置脚本 (PowerShell)")
+            for key, value in self._envs.items():
+                lines.append(f'$env:{key}="{value}"')
+        else:  # bash/sh 脚本
+            lines.append("#!/bin/bash")
+            lines.append("# 环境变量配置脚本")
+            for key, value in self._envs.items():
+                lines.append(f'export {key}="{value}"')
+
+        content = "\n".join(lines) + "\n"
+        with filepath_path.open("w", encoding="utf-8") as f:
+            f.write(content)
+        logger.info(f"已导出环境变量到: {filepath}")
+
+    def import_from_file(self, filepath: str) -> int:
+        """从脚本文件导入环境变量
+
+        Args:
+            filepath: 导入文件路径
+
+        Returns:
+            成功导入的环境变量数量
+        """
+        filepath_path = Path(filepath)
+        if not filepath_path.exists():
+            msg = f"文件不存在: {filepath}"
+            raise FileNotFoundError(msg)
+
+        count = 0
+        with filepath_path.open("r", encoding="utf-8") as f:
+            for line in f:
+                line = line.strip()
+                # 跳过注释和空行
+                if not line or line.startswith("#") or line.startswith("@"):
+                    continue
+
+                # 解析 export VAR=value (bash)
+                if line.startswith("export "):
+                    line = line[7:]  # 移除 "export "
+                    if "=" in line:
+                        key, value = line.split("=", 1)
+                        # 移除引号
+                        value = value.strip("'\"")
+                        self.set(key, value)
+                        count += 1
+
+                # 解析 set VAR=value (cmd)
+                elif line.startswith("set "):
+                    line = line[4:]  # 移除 "set "
+                    if "=" in line:
+                        key, value = line.split("=", 1)
+                        self.set(key, value)
+                        count += 1
+
+                # 解析 $env:VAR="value" (powershell)
+                elif line.startswith("$env:"):
+                    line = line[5:]  # 移除 "$env:"
+                    if "=" in line:
+                        key, value = line.split("=", 1)
+                        # 移除引号
+                        value = value.strip("'\"")
+                        self.set(key, value)
+                        count += 1
+
+        logger.info(f"从文件导入了 {count} 个环境变量: {filepath}")
+        return count
+
+    def __repr__(self) -> str:
+        return "EnvOps(环境变量配置工具)"

bitool/cmd/git.py

@@ -0,0 +1,123 @@
+"""Git命令封装模块.
+
+提供常用的Git操作命令封装, 包括提交、标签、检测等功能.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from pathlib import Path
+
+from bitool.cmd._base import BaseCommand
+from bitool.cmd._condition import BuiltinConditions
+from bitool.cmd.run import RunCommand
+from bitool.core import logger
+from bitool.utils import execute
+
+# Git 条件检查
+_GIT_INSTALLED = BuiltinConditions.HAS_APP_INSTALLED("git")
+
+
+def _is_git_repo() -> bool:
+    """检查当前目录是否为 Git 仓库.
+
+    Returns
+    -------
+    bool
+        如果是 Git 仓库返回 True, 否则返回 False
+    """
+    try:
+        execute(["git", "rev-parse", "--git-dir"], check=True, capture_output=True)
+    except (FileNotFoundError, OSError, RuntimeError):
+        return False
+    else:
+        return True
+
+
+@dataclass
+class GitAddCommand(RunCommand):
+    """Git add 命令.
+
+    Attributes:
+        files: 要添加的文件列表, 默认 None
+        all_files: 是否添加所有文件, 默认 False
+    """
+
+    name: str = "git-add"
+    description: str = "添加文件到 Git 暂存区"
+    files: list[Path] | None = None
+    all_files: bool = False
+    allow_conditions: list = field(default_factory=lambda: [_GIT_INSTALLED])
+
+    def __post_init__(self) -> None:
+        """数据类初始化后的处理, 构建 cmd 列表."""
+        if self.all_files:
+            self.cmd = ["git", "add", "."]
+        elif self.files:
+            self.cmd = ["git", "add"] + [str(f) for f in self.files]
+        else:
+            self.cmd = ["git", "add", "."]
+
+
+@dataclass
+class GitCommitCommand(RunCommand):
+    """Git commit 命令.
+
+    Attributes:
+        message: 提交消息, 默认 "chore: update"
+    """
+
+    name: str = "git-commit"
+    description: str = "提交 Git 更改"
+    message: str = "chore: update"
+    allow_conditions: list = field(default_factory=lambda: [_GIT_INSTALLED])
+
+    def __post_init__(self) -> None:
+        """数据类初始化后的处理, 构建 cmd 列表."""
+        self.cmd = ["git", "commit", "-m", self.message]
+
+
+@dataclass
+class GitTagCommand(RunCommand):
+    """Git tag 命令.
+
+    Attributes:
+        tag_name: 标签名称
+        message: 标签消息, 默认 None (创建轻量标签)
+    """
+
+    name: str = "git-tag"
+    description: str = "创建 Git 标签"
+    tag_name: str = ""
+    message: str | None = None
+    allow_conditions: list = field(default_factory=lambda: [_GIT_INSTALLED])
+
+    def __post_init__(self) -> None:
+        """数据类初始化后的处理, 构建 cmd 列表."""
+        if self.message:
+            self.cmd = ["git", "tag", "-a", self.tag_name, "-m", self.message]
+        else:
+            self.cmd = ["git", "tag", self.tag_name]
+
+
+@dataclass
+class GitCheckIsRepoCommand(BaseCommand):
+    """检查是否为 Git 仓库的命令."""
+
+    name: str = "git-is-repo"
+    description: str = "检查当前目录是否为 Git 仓库"
+
+    def run(self) -> bool:
+        """执行检查.
+
+        Returns
+        -------
+        bool
+            如果是 Git 仓库返回 True
+        """
+        is_repo = _is_git_repo()
+        if is_repo:
+            logger.info("当前目录是 Git 仓库")
+        else:
+            logger.warning("当前目录不是 Git 仓库")
+        return is_repo