release.py

# =========================================
# =============== 生成发布包 ===============
# =========================================

import os
import json
import shutil
import argparse
import subprocess

# 定义参数
parser = argparse.ArgumentParser(description="Umi-OCR Release 生成发布包")
# 是否打压缩包
parser.add_argument(
    "--to_7z", action="store_true", default=True, help="[选填] 是否生成压缩包"
)
# 是否生成自解压文件
parser.add_argument(
    "--to_sfx", action="store_true", default=True, help="[选填] 是否生成自解压文件"
)
# 发布目录
parser.add_argument(
    "--path", default="./release", help="[选填] 发布包存放路径，默认为 /release"
)
# 版本文件路径
parser.add_argument(
    "--about",
    default="./UmiOCR-data/about.json",
    help="[选填] 版本文件 about.json 的路径",
)
# 启动器路径
parser.add_argument(
    "--run",
    default="Umi-OCR.exe",
    help="[选填] 启动器，默认为 Umi-OCR.exe",
)
# 保留的内容
parser.add_argument(
    "--datas",
    default="i18n,plugins,py_src,qt_res,runtime,site-packages,main.py,RUN_CLI.bat,RUN_GUI.bat,test_speed.bat,about.json,帮助.txt",
    help="[选填] 内容目录文件选取，格式：文件1,文件2,文件3……",
)
# 插件区分
parser.add_argument(
    "--plugins",
    default="Paddle,win7_x64_PaddleOCR-json|Rapid,win7_x64_RapidOCR-json",
    help="[选填] 插件选取，格式：打包名1,插件1,插件2|打包名2,插件2,插件3",
)
# 要屏蔽的目录
parser.add_argument(
    "--ignores",
    default="__pycache__,win7_x64_Pix2Text",
    help='[选填] 要排除的目录名称，以","划分',
)
# 7z工具路径
parser.add_argument(
    "--path_7z",
    default="dev-tools/7z/7zr.exe",
    help="[选填] 7z 命令行工具的路径，打压缩包要用",
)
# sfx路径
parser.add_argument(
    "--path_sfx",
    default="dev-tools/7z/7z.sfx",
    help="[选填] sfx 自解压工具的路径，创建自解压文件要用",
)
# 压缩类型
parser.add_argument(
    "--args_7z",
    default="-mx=7 -t7z",
    help="[选填] 7z工具参数，可指定压缩包类型和压缩率等。如-t7z等指定压缩类型参数必须放在最后",
)
args = parser.parse_args()

# 工作路径改为当前文件路径
script_dir = os.path.dirname(os.path.abspath(__file__))
os.chdir(script_dir)


# 拷贝所有文件
def copy_all():
    # 目标路径
    target = args.path + "/temp"
    # 清理/重新创建目标路径
    if os.path.exists(target):
        shutil.rmtree(target)
        print("删除temp")
    os.makedirs(target + "/UmiOCR-data")
    print("开始拷贝基础文件")
    # 拷贝启动器
    shutil.copy(args.run, target)
    print("   ", args.run)
    # 排除的目录
    ignores = args.ignores.split(",")

    def ignore_func(directory, filenames):
        return [name for name in filenames if name in ignores]

    # 拷贝data
    datas = args.datas.split(",")
    data_target = target + "/UmiOCR-data"
    for data in datas:
        path = "UmiOCR-data/" + data
        if os.path.isfile(path):
            shutil.copy(path, data_target)
            print("   ", path)
        elif os.path.isdir(path):
            print("   ", path)
            shutil.copytree(path, data_target + "/" + data, ignore=ignore_func)
    print("结束拷贝基础文件")
    # 清理缓存
    cache_n = 0
    files_n = 0
    files_size = 0
    for root, dirs, files in os.walk(target):
        for dir_name in dirs:
            if dir_name == "__pycache__":
                dir_path = os.path.join(root, dir_name)
                shutil.rmtree(dir_path)
                cache_n += 1
        for f in files:
            file_path = os.path.join(root, f)
            files_size += os.path.getsize(file_path)
            files_n += 1
    print(f"清理缓存：{cache_n}")
    print(f"文件总数：{files_n}，总大小：{files_size//1048576}MB")


copy_all()


# 获取版本号信息
def get_version():
    a = args.about
    with open(a, "r", encoding="utf-8") as f:
        u = json.load(f)
    print("读取版本信息")
    v = u["version"]
    v1, v2, v3, p1, p2 = (
        v["major"],  # 主版本号
        v["minor"],  # 次版本号
        v["patch"],  # 修订版本号
        v["prerelease"],  # 预发布阶段
        v["prereleaseNumber"],  # 预发布版本号
    )
    return v1, v2, v3, p1, p2


v1, v2, v3, p1, p2 = get_version()
print("解析版本信息：", v1, v2, v3, p1, p2)


# 获取插件信息
def get_plugins(v1, v2, v3, p1, p2):
    version = f"_v{v1}.{v2}.{v3}"
    if p1:
        version += f"_{p1}"
        if p2:
            version += f"_{p2}"
    plug = args.plugins
    plug = plug.split("|")
    plugs = {}
    # 当前存在的插件
    plug_dir = args.path + "/temp/UmiOCR-data/plugins"
    exist_plugs = os.listdir(plug_dir)
    for v in plug:
        ps = v.split(",")
        name = ps[0]
        # 生成的目录名称
        f = "Umi-OCR_" + name + version
        now_plugs = ps[1:]
        # 检查插件存在
        flag = True
        for p in now_plugs:
            if p not in exist_plugs:
                flag = False
                print(f"    {name} 插件组缺失 {p}")
                break
        if flag:
            plugs[name] = {"name": f, "plugins": now_plugs}
    return plugs


plugs = get_plugins(v1, v2, v3, p1, p2)
print("解析插件信息：", plugs)


# 拷贝生成插件版本文件
def copy_plugins(plugs):
    for key, value in plugs.items():
        print("开始创建插件区分：", key)
        # 目标路径
        target = args.path + "/" + value["name"]
        # 清理/重新创建目标路径
        if os.path.exists(target):
            shutil.rmtree(target)
            print("    删除上次", target)
        # 拷贝文件
        shutil.copytree(args.path + "/temp", target)
        print("    重新创建", target)
        # 删除无关插件目录
        plug_dir = target + "/UmiOCR-data/plugins"
        plugins = os.listdir(plug_dir)
        for plug in plugins:
            if plug not in value["plugins"]:
                path = plug_dir + "/" + plug
                if os.path.isdir(path):
                    shutil.rmtree(path)
                    print("    删除", path)


copy_plugins(plugs)

# 生成压缩包
if not args.to_7z:
    print("打包结束。")
    exit()
# 检测 7zr.exe 存在
if not os.path.exists(args.path_7z):
    print("未找到 7zr.exe ，停止后续压缩步骤。")
    exit()


# 生成压缩包
def to_zip(plugs):
    for key, value in plugs.items():
        print("开始创建插件7z压缩包：", key)
        # 目标路径
        target = args.path + "/" + value["name"]
        # 构建7-Zip命令行参数
        command = [
            args.path_7z,
            "a",
            *args.args_7z.split(" "),  # 参数
            target + ".7z",
            target,
        ]
        # 调用7-Zip命令行工具
        subprocess.run(command)


to_zip(plugs)

# 生成自解压文件
if not args.to_sfx:
    print("打包结束。")
    exit()
# 检测 7zr.exe 存在
if not os.path.exists(args.path_sfx):
    print("未找到 sfx ，停止后续创建自解压文件步骤。")


# 生成压缩包
def to_sfx(plugs):
    for key, value in plugs.items():
        # sfx绝对路径
        path_sfx = os.path.abspath(args.path_sfx)
        # 目标路径
        target = os.path.abspath(args.path) + "\\" + value["name"] + ".7z"
        # copy构建sfx
        command = f'copy /b "{path_sfx}"+"{target}" "{target}.exe"'
        print("\n开始创建插件sfx自解压文件：\n", command)
        subprocess.run(command, shell=True, cwd=args.path)


to_sfx(plugs)

print("打包结束。")