如何在PyQt5中实现Git仓库克隆下载的进度条功能

GitPython的clone_from方法支持传入progress回调参数，你只需要自定义一个继承自git.RemoteProgress的进度类，把进度更新信号绑定到PyQt5的进度条控件即可，不需要修改现有克隆逻辑的核心代码。

1. 自定义进度回调类 #

继承git.RemoteProgress的同时继承PyQt5的QObject发送进度信号，实现跨线程UI更新：

from git import RemoteProgress
from PyQt5.QtCore import QObject, pyqtSignal

class CloneProgress(RemoteProgress, QObject):
    # 进度更新信号，参数为0-100的百分比
    progress_updated = pyqtSignal(int)
    # 克隆完成信号
    clone_finished = pyqtSignal()
    # 克隆错误信号
    clone_error = pyqtSignal(str)

    def __init__(self):
        RemoteProgress.__init__(self)
        QObject.__init__(self)

    def update(self, op_code, cur_count, max_count=None, message=''):
        try:
            if max_count and max_count > 0:
                percentage = int((cur_count / max_count) * 100)
                self.progress_updated.emit(percentage)
            # 检测克隆操作结束
            if op_code & self.END:
                self.clone_finished.emit()
        except Exception as e:
            self.clone_error.emit(str(e))

2. 子线程执行克隆操作 #

注意不要在UI主线程执行克隆操作，会导致界面无响应，必须放到QThread中运行

from PyQt5.QtCore import QThread
from git import Repo

class CloneWorker(QThread):
    def __init__(self, repo_url, local_path, progress_callback):
        super().__init__()
        self.repo_url = repo_url
        self.local_path = local_path
        self.progress_callback = progress_callback

    def run(self):
        try:
            # 原克隆代码仅需新增progress参数
            Repo.clone_from(
                self.repo_url,
                self.local_path,
                progress=self.progress_callback
            )
        except Exception as e:
            self.progress_callback.clone_error.emit(str(e))

3. 主界面绑定进度条 #

将进度信号和QProgressBar控件绑定即可实现实时进度更新，示例主窗口代码如下：

from PyQt5.QtWidgets import QMainWindow, QProgressBar, QPushButton, QVBoxLayout, QWidget

class MainWindow(QMainWindow):
    def __init__(self):
        super().__init__()
        self.setWindowTitle("Git克隆进度示例")
        self.resize(400, 150)

        # 初始化UI控件
        layout = QVBoxLayout()
        self.progress_bar = QProgressBar()
        self.progress_bar.setRange(0, 100)
        self.clone_btn = QPushButton("开始克隆仓库")
        self.clone_btn.clicked.connect(self.start_clone)

        layout.addWidget(self.progress_bar)
        layout.addWidget(self.clone_btn)

        container = QWidget()
        container.setLayout(layout)
        self.setCentralWidget(container)

    def start_clone(self):
        self.clone_btn.setDisabled(True)
        self.progress_bar.setValue(0)

        # 初始化进度回调和工作线程
        self.progress_handler = CloneProgress()
        self.clone_worker = CloneWorker(
            repo_url='https://github.com/addddd123/Osdag',
            local_path='_new_update',
            progress_callback=self.progress_handler
        )

        # 绑定信号槽
        self.progress_handler.progress_updated.connect(self.progress_bar.setValue)
        self.progress_handler.clone_finished.connect(self.on_clone_finish)
        self.progress_handler.clone_error.connect(self.on_clone_error)

        # 启动克隆线程
        self.clone_worker.start()

    def on_clone_finish(self):
        self.progress_bar.setValue(100)
        self.clone_btn.setDisabled(False)
        # 可自行补充克隆完成后的提示逻辑

    def on_clone_error(self, error_msg):
        self.clone_btn.setDisabled(False)
        # 可自行补充错误提示逻辑

补充注意事项 #

• 如果仓库体积较大，可以解析update方法传入的message参数，显示当前操作阶段（接收对象、解压、校验等）
• 如果需要支持中断克隆，可以给CloneWorker新增终止逻辑，调用git.Repo的相关终止方法或者直接终止线程
• 首次克隆前需要确认目标路径_new_update不存在或者为空，否则GitPython会抛出路径已存在的错误

内容的提问来源于stack exchange，提问作者Adnan Sheikh