使用 Python 操作 Git 版本庫 - GitPython

GitPython 是一個用於操作 Git 版本庫的 python 包，
它提供了一系列的物件模型(庫 - Repo、樹 - Tree、提交 - Commit等)
用於操作版本庫中的相應物件。

版本庫物件 - Repo

首先，使用包含 .git 資料夾的版本庫路徑建立 git.Repo 物件

from git import Repo
# 建立版本庫物件
repo = git.Repo(r'E:\Notes')

然後便可以使用這個 Repo

# 版本庫是否為空版本庫
repo.bare

# 當前工作區是否乾淨
repo.is_dirty()

# 版本庫中未跟蹤的檔案列表
repo.untracked_files

# 克隆版本庫
repo.clone('clone_path')

# 壓縮版本庫到 tar 檔案
with open('repo.tar', 'wb') as fp:
    repo.archive(fp)

# 新建分支
repo.create_head('branchname')

# 檢視當前分支
repo.active_branch
 

索引/暫存區物件 - Index

Git 術語中，index 表示暫存區，為下次將要提交到版本庫裡的檔案，
GitPython 提供 Repo.Index 來操作暫存區，如新增、提交操作

index = repo.index
index.add(['new.txt'])
index.remove(['old.txt'])
index.commit('this is a test')

遠端版本庫操作 - Remotes

Remotes 用於操作遠端版本庫，可以通過 Repo.remote 方法獲取遠端版本庫，
Repo.Remotes

# 獲取預設版本庫 origin
remote = repo.remote()
# 從遠端版本庫拉取分支
remote.pull()
# 推送本地分支到遠端版本庫
remote.push()
# 重新命名遠端分支
# remote.rename('new_origin')

直接執行 Git 命令

一般我們在工作目錄做了改變之後，就會呼叫 git add 命令新增檔案到暫存區，
然後呼叫 git commit 命令提交更改，Repo 雖然沒有新增、提交方法，
但取而代之提供了一個 git.cmd.Git 物件實現對 Git 命令的呼叫，
通過 Repo.git 來進行 Git 命令操作。

git = repo.git
git.add('test1.txt') # git add test1.txt
git.commit('-m', 'this is a test') # git commit -m 'this is a test'

Repo.git.[command] 即相當於呼叫對應的 git 命令，而呼叫對應命令方法所用的引數，
會被轉換成跟在命令後的引數。

而呼叫命令方法所用的命名引數會被轉換成對應的完整引數，如：git.command(flag=True)
會被轉換成 git command --flag 命令執行

總結

基本的 Git 操作可以概括如下：

# 新建版本庫物件
repo = Repo(r'E:\Notes')

# 進行檔案修改操作

# 獲取版本庫暫存區
index = repo.index
# 新增修改檔案
index.add(['new.txt'])
# 提交修改到本地倉庫
index.commit('this is a test')

# 獲取遠端倉庫
remote = repo.remote()
# 推送本地修改到遠端倉庫
remote.push()

參考連結：

https://my.oschina.net/hopeMan/blog/141221

http://gitpython.readthedocs.io/en/stable/tutorial.html

分類: