如何使用Python(GitPython)实现git添加远程仓库并推送main分支

目标命令 #

需要等价实现以下三条Git命令的效果：

git remote add origin https://gitlab.com/xxxx/aaa/bbb/feature2.git
git branch -M main
git push -uf origin main

此前尝试的问题 #

• 第一种方案错误点：直接把远程仓库URL传给Repo()初始化，GitPython的Repo类只能操作本地路径下的仓库，不支持直接传入远程地址，因此触发no such path报错。
• 第二种方案错误点：参考的教程逻辑针对的是远程仓库已有内容的场景，本次操作的目标远程仓库是全新空仓库，没有任何提交和分支记录，执行fetch()后根本不存在origin.refs.main这个分支引用，后续创建跟踪分支、拉取代码的逻辑自然会触发AttributeError: 'IterableList' object has no attribute 'origin/main'报错；额外的origin.rename('main')逻辑还会把远程仓库的别名从origin改成main，和目标需求完全不符。

可运行的正确代码 #

import shutil
import git

def create_static_site():
    # 把需要推送的文件拷贝到本地仓库工作目录
    shutil.copytree(source_dir, destination_dir)
    # 初始化本地Git仓库，指定初始分支名为main，等价于初始化后执行git branch -M main
    local_repo = git.Repo.init("tempDir", initial_branch='main')
    # 添加远程仓库origin，等价于git remote add origin 远程地址
    origin = local_repo.create_remote('origin', "https://gitlab.com/xxxx/aaa/bbb/feature2.git")
    # 校验远程配置写入成功
    assert origin.exists()
    assert origin == local_repo.remotes.origin == local_repo.remotes['origin']
    # 暂存工作目录所有文件
    local_repo.git.add(all=True)
    # 生成首次提交
    local_repo.index.commit("first_commit")
    # 推送本地main分支到远程origin，同时设置上游跟踪、开启强制推送，等价于git push -uf origin main
    local_repo.git.push('--set-upstream', '--force', origin.name, 'main')

提示：如果仓库是私有仓库，提前在本地配置好Git的SSH密钥或者凭据缓存，避免推送时出现鉴权失败。

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