plum-tools 0.5.0__py3-none-any.whl

plum_tools/.plum_tools.yaml

@@ -0,0 +1,20 @@
+default_ssh_conf:
+    user: root
+    port: 22
+    identityfile: ~/.ssh/id_rsa
+
+host_type_default: 10.10.100
+host_type_2: 192.168.1
+
+ipmi_interval: 100
+
+projects:
+    default:
+        src:  ~/PythonProjects/plum_tools
+        dest: /home/seekplum/plum_tools
+        exclude:
+            - .idea
+            - .vscode
+            - '*.pyc'
+            - '*.log'
+        delete: 0

plum_tools/__init__.py

@@ -0,0 +1,10 @@
+"""
+#=============================================================================
+#  ProjectName: plum_tools
+#     FileName: __init__.py
+#       Author: seekplum
+#        Email: 1131909224m@sina.cn
+#     HomePage: seekplum.github.io
+#       Create: 2019-04-04 22:01
+#=============================================================================
+"""

plum_tools/conf.py

@@ -0,0 +1,65 @@
+"""
+#=============================================================================
+#  ProjectName: plum_tools
+#     FileName: conf
+#         Desc: 相关常量配置信息
+#       Author: seekplum
+#        Email: 1131909224m@sina.cn
+#     HomePage: seekplum.github.io
+#       Create: 2018-07-06 18:39
+#=============================================================================
+"""
+
+import os
+from enum import IntEnum, StrEnum
+
+VERSION = "0.5.0"
+
+
+STASH_UUID = "plum123456789987654321plum"
+COMMAND_TIMEOUT = 3  # 执行命令超时时间
+PROCESSES_NUMBER = 100  # 进程数量
+LOCAL_HOST = "__localhost__"
+
+
+class GitCommand(StrEnum):
+    """git 相关命令"""
+
+    STASH_LIST = "git stash list"  # 检查是否有文件在储藏区
+    STATUS_DEFAULT = "git status"  # 检查文件状态
+    STATUS_SHORT = "git status -s"  # 检查文件状态，简短输出，只能看到文件是否有改动，无法确认是否落后、超前远程分支
+    BRANCH_ABBREV = "git rev-parse --abbrev-ref HEAD"  # 查询当前分支名
+    STASH_SAVE = 'git stash save "%s"'  # 保存修改的文件到储藏区
+    STASH_POP = "git stash pop --index %s"  # 把储藏的文件恢复
+    GIT_CHECKOUT = "git checkout %s"  # 切换分支
+
+    PULL_KEYWORD = '"git pull"'  # 落后远程分支关键字
+    PUSH_KEYWORD = '"git push"'  # 超前远程分支关键字
+
+
+class OsCommand(StrEnum):
+    """系统 相关命令"""
+
+    FIND_COMMAND = 'find %s -name ".git"'  # 通过系统命令查找文件路径
+    PING_COMMAND = "ping -W 3 -c 1 %s"  # ping命令 -W 超时时间 -c 次数
+    # ipmi命令
+    IPMI_COMMAND = "ipmitool -I lanplus -H %(ip)s -U %(user)s -P %(password)s %(command)s"
+    STAT_COMMAND = "stat %s"
+
+
+class SSHConfig(IntEnum):
+    """ssh配置相关"""
+
+    DEFAULT_SSH_PORT = 22
+    CONNECT_TIMEOUT = 3
+
+
+class PathConfig(StrEnum):
+    """相关配置文件"""
+
+    HOME = os.environ["HOME"]
+    ROOT = os.path.dirname(os.path.abspath(__file__))
+    PLUM_YML_NAME = ".plum_tools.yaml"  # 项目需要的配置文件名
+    PLUM_YML_PATH = os.path.join(HOME, PLUM_YML_NAME)  # 项目需要的配置文件路径
+    SSH_CONFIG_NAME = ".ssh/config"  # ssh配置文件名
+    SSH_CONFIG_PATH = os.path.join(HOME, SSH_CONFIG_NAME)  # ssh配置文件路径

plum_tools/exceptions.py

@@ -0,0 +1,38 @@
+"""
+#=============================================================================
+#  ProjectName: plum-tools
+#     FileName: exceptions
+#         Desc: 所有的异常类
+#       Author: seekplum
+#        Email: 1131909224m@sina.cn
+#     HomePage: seekplum.github.io
+#       Create: 2018-07-05 22:02
+#=============================================================================
+"""
+
+
+class RunCmdError(Exception):
+    """执行命令异常"""
+
+    def __init__(self, message: str, out_msg: str, err_msg: str) -> None:
+        """初始化参数
+
+        :param message: 错误提示信息
+        :param out_msg: 执行命令输出结果
+        :param err_msg: 执行命令错误信息
+        """
+        super().__init__(message)  # pylint: disable=R1725
+        self.out_msg = out_msg
+        self.err_msg = err_msg
+
+
+class RunCmdTimeout(Exception):
+    """执行系统命令超时"""
+
+
+class SSHException(Exception):
+    """ssh异常"""
+
+
+class SystemTypeError(Exception):
+    """系统类型异常"""

plum_tools/find_imports.py

@@ -0,0 +1,142 @@
+import ast
+import sys
+import typing as t
+from enum import StrEnum
+from pathlib import Path
+
+from .utils.parser import add_extra_argument, get_base_parser
+
+STD_LIB_MODULE_NAMES = sys.stdlib_module_names
+MODULE_NAME_PAIRS = {
+    "PIL": "pillow",
+    "grpc": "grpcio",
+}
+
+
+class FindMode(StrEnum):
+    STD = "std"  # 标准库
+    ALL = "all"  # 所有库
+    THIRD_PARTY = "3rd-party"  # 第三方库。这个会把项目本身的包也包含进来
+
+
+ModuleDict = t.TypedDict(
+    "ModuleDict",
+    {
+        "name": str,
+        "type": t.Literal["import", "from"],
+        "origin_name": str,
+        "mode": t.Literal[FindMode.STD, FindMode.THIRD_PARTY],
+    },
+)
+GeneratorModuleDict = t.Generator[ModuleDict, None, None]
+
+
+def calc_mode(name: str) -> t.Literal[FindMode.STD, FindMode.THIRD_PARTY]:
+    if name in STD_LIB_MODULE_NAMES:
+        return FindMode.STD
+    return FindMode.THIRD_PARTY
+
+
+def parse_imports(source: str) -> GeneratorModuleDict:
+    tree = ast.parse(source)
+
+    for node in ast.walk(tree):
+        if isinstance(node, ast.Import):
+            for name in node.names:
+                first_name = name.name.split(".")[0]
+                yield ModuleDict(
+                    type="import",
+                    origin_name=name.name,
+                    name=first_name,
+                    mode=calc_mode(first_name),
+                )
+        elif isinstance(node, ast.ImportFrom):
+            if node.module:
+                if node.level > 0:  # 不考虑相对导入
+                    continue
+                first_name = node.module.split(".")[0]
+                yield ModuleDict(
+                    type="from",
+                    origin_name=node.module,
+                    name=first_name,
+                    mode=calc_mode(first_name),
+                )
+
+
+def find_imports_by_file(file_path: str) -> GeneratorModuleDict:
+    with open(file_path, encoding="utf-8") as f:
+        yield from parse_imports(f.read())
+
+
+def find_imports(
+    project_dir: str, *, mode: FindMode = FindMode.ALL, ignore_paths: t.List[str] | None = None
+) -> GeneratorModuleDict:
+    exists = set()
+    project_path = Path(project_dir)
+    ignore_path_set = {str(Path(path)) for path in ignore_paths or []}
+    ignore_dir_parts = {".venv", "__pycache__"}
+    my_module_names = {path.name for path in project_path.iterdir()}
+    src_path = project_path / "src"
+    if src_path.is_dir():
+        my_module_names.update(path.name for path in src_path.iterdir())
+
+    for file in project_path.rglob("*.py"):
+        file_path = str(file)
+        relative_parts = file.relative_to(project_path).parts
+        # 遍历目录中的所有文件，除了.venv和__pycache__目录
+        if file_path in ignore_path_set or any(part in ignore_dir_parts for part in relative_parts):
+            continue
+        if file.absolute() == Path(__file__).absolute():
+            continue
+        try:
+            for module in find_imports_by_file(file_path):
+                if module["name"] in exists or module["name"] in my_module_names:
+                    continue
+                exists.add(module["name"])
+                if mode in (FindMode.ALL, module["mode"]):
+                    yield module
+        except Exception as e:
+            print(f"Error parsing {file_path}: {e}")
+
+
+def main():
+    parser = get_base_parser()
+    parser.add_argument(
+        "--mode",
+        "-m",
+        type=FindMode,
+        choices=list(FindMode),
+        default=FindMode.THIRD_PARTY,
+        help="Find mode",
+    )
+    parser.add_argument(
+        "--project-dir",
+        "-p",
+        type=str,
+        dest="project_dir",
+        default=".",
+        help="Project directory",
+    )
+    parser.add_argument(
+        "--ignore-path",
+        "-i",
+        required=False,
+        action="store",
+        dest="ignore_paths",
+        nargs="+",
+        help="Ignore paths",
+    )
+    add_extra_argument(parser)
+    args = parser.parse_args()
+    modules = sorted(
+        find_imports(args.project_dir, mode=args.mode, ignore_paths=args.ignore_paths),
+        key=lambda x: (x["mode"], x["name"]),
+    )
+    extra_modules = args.extra
+    for module in modules:
+        name = module["name"]
+        if name in MODULE_NAME_PAIRS:
+            name = MODULE_NAME_PAIRS[name]
+        elif name in extra_modules:
+            name = extra_modules[name]
+        print(name)

plum_tools/gitrepo.py

@@ -0,0 +1,144 @@
+"""
+#=============================================================================
+#  ProjectName: plum-tools
+#     FileName: exceptions
+#         Desc: 查找指定路径下所有被改动的git仓库
+#       Author: seekplum
+#        Email: 1131909224m@sina.cn
+#     HomePage: seekplum.github.io
+#       Create: 2018-07-05 22:02
+#=============================================================================
+"""
+
+import functools
+import os
+from collections.abc import Generator
+from multiprocessing import Pool
+
+from .conf import PROCESSES_NUMBER
+from .utils.git import check_is_git_repository, check_repository_modify_status, check_repository_stash
+from .utils.parser import get_base_parser
+from .utils.printer import print_error, print_warn
+
+
+def find_git_project_for_python(path: str) -> Generator[str, None, None]:
+    """查找目录下所有的 git仓库
+
+    :param path 要被检查的目录
+    :example path "/tmp/git"
+
+    >>> for path in find_git_project_for_python("/tmp"):
+    ...    print path
+
+
+    """
+    for root, _, _ in os.walk(path):
+        if check_is_git_repository(root):
+            yield root
+
+
+def check_project(path: str, stash: bool = True) -> dict:
+    """检查git项目
+
+    :param path 仓库路径
+    :example path /tmp/git
+
+    :param stash 是否显示储藏信息
+    :example stash True
+
+    :return result {
+        path: 仓库路径
+        output: 检查输出信息
+        status:
+            True 仓库有文件进行了修改或有储藏文件
+            False 仓库没有和远程一致。且没有储藏文件
+    }
+    :example result {
+        "path": "/tmp/git",
+        "status": False,
+        "output": ""
+    }
+    """
+    result = {
+        "path": path,
+        "status": False,
+    }
+    # 检查文件是否改动
+    status_result, status_out = check_repository_modify_status(path)
+    if status_result:
+        result["status"] = True
+        result["output"] = status_out
+        return result
+
+    if not stash:
+        return result
+    # 检查是否有文件储藏
+    stash_result, stash_out = check_repository_stash(path)
+    if stash_result:
+        result["status"] = True
+        result["output"] = stash_out
+    return result
+
+
+def check_projects(projects: list[str], detail: bool, stash: bool = True) -> None:
+    """检查指导目录下所有的仓库是否有修改
+
+    当仓库中有内容被修改时，打印黄色警告信息
+
+    :param projects 需要检查的目录列表
+    :example ["/tmp"]
+
+    :param detail 是否显示详细错误信息
+    :example False
+
+    :param stash 是否显示储藏信息
+    :example False
+    """
+    targets = [path for project_path in projects for path in find_git_project_for_python(project_path)]
+    with Pool(processes=PROCESSES_NUMBER) as pool:
+        result = pool.map(functools.partial(check_project, stash=stash), targets)
+    for item in result:
+        # 仓库中文件没有被改动而且没有文件被储藏了
+        if not item["status"]:
+            continue
+        print_warn(item["path"])
+
+        # 打印详细错误信息
+        if not detail:
+            continue
+        print_error(item["output"])
+
+
+def main() -> None:
+    """程序主入口"""
+    parser = get_base_parser()
+    parser.add_argument(
+        "-p",
+        "--path",
+        action="store",
+        required=False,
+        dest="path",
+        nargs="+",
+        default=[os.environ["HOME"]],
+        help="The directory path to check",
+    )
+    parser.add_argument(
+        "-d",
+        "--detail",
+        action="store_true",
+        required=False,
+        dest="detail",
+        default=False,
+        help="display staged details",
+    )
+    parser.add_argument(
+        "-s",
+        "--stash",
+        action="store_true",
+        required=False,
+        dest="stash",
+        default=False,
+        help="display stash details",
+    )
+    args = parser.parse_args()
+    check_projects(args.path, args.detail, args.stash)

plum_tools/gitstash.py

@@ -0,0 +1,106 @@
+"""
+#=============================================================================
+#  ProjectName: plum_tools
+#     FileName: gitstash
+#         Desc: 外部传入一个branch，保存本地未提交的修改，然后切换到branch，将上次该branch保存的未提交的结果stash pop出来
+#               命令: gitstash master
+#               描述: 在当前路径下切换到master分支
+#       Author: seekplum
+#        Email: 1131909224m@sina.cn
+#     HomePage: seekplum.github.io
+#       Create: 2018-07-07 16:29
+#=============================================================================
+"""
+
+import os
+import sys
+
+from .conf import STASH_UUID, GitCommand
+from .exceptions import RunCmdError
+from .utils.git import check_repository_modify_status, check_repository_stash, get_current_branch_name
+from .utils.parser import get_base_parser
+from .utils.printer import print_warn
+from .utils.utils import cd, run_cmd
+
+
+class GitCheckoutStash:
+    """切换分支前储藏文件"""
+
+    def __init__(self, current_branch: str, new_branch: str) -> None:
+        """初始化信息
+
+        :param current_branch: 当前分支名
+        :example current_branch master
+
+        :param new_branch: 新的分支名
+        :example new_branch release-1.0.0
+        """
+        self._current_branch = current_branch
+        self._current_path = os.getcwd()  # 当前执行命令的路径
+        self._new_branch = new_branch
+        self._mark = "-"
+        self._stash_uuid = f"{self._current_branch}{self._mark}{STASH_UUID}"
+
+    def _stash(self) -> None:
+        """储藏文件"""
+        # 分支有修改,先进行stash储藏
+        is_modify, _ = check_repository_modify_status(self._current_path)
+        if is_modify:
+            cmd = GitCommand.STASH_SAVE % self._stash_uuid
+            with cd(self._current_path):
+                run_cmd(cmd)
+
+    def _check_branch(self) -> bool:
+        """检查分支是否一致
+
+        :return
+            True: 当前分支和要切换的分支一致
+            False: 当前分支和要切换的分支不一致
+        """
+        return self._current_branch == self._new_branch
+
+    def _checkout(self) -> None:
+        """切换分支"""
+        # 切换到新分支
+        cmd = GitCommand.GIT_CHECKOUT % self._new_branch
+        with cd(self._current_path):
+            run_cmd(cmd)
+
+    def _apply(self) -> None:
+        """恢复储藏的文件"""
+        # 检查切换后的分支是否有储藏文件
+        is_stash, stash_out = check_repository_stash(self._current_path)
+        if not is_stash:
+            return
+        for line in stash_out.splitlines():
+            stash_string, _ = line.split(":", 1)
+            stash_save = f"{self._new_branch}{self._mark}{STASH_UUID}"
+            if stash_save.strip() in line:
+                cmd = GitCommand.STASH_POP % stash_string
+                with cd(self._current_path):
+                    run_cmd(cmd)
+                break
+
+    def checkout(self) -> None:
+        """储藏文件切换分支"""
+        # 不需要切换
+        if self._check_branch():
+            return
+        self._stash()
+        self._checkout()
+        self._apply()
+
+
+def main() -> None:
+    """程序主入口"""
+    parser = get_base_parser()
+    parser.add_argument(dest="branch", action="store", help="specify branch")
+    args = parser.parse_args()
+    new_branch = args.branch
+    try:
+        current_branch = get_current_branch_name()
+    except RunCmdError:
+        print_warn("当前目录不是一个git仓库")
+        sys.exit(1)
+    stash = GitCheckoutStash(current_branch, new_branch)
+    stash.checkout()