Note: dulwich is not feature complete yet and the development of the project is extremely slow. It is suggested that you use other Python packages instead. For more discussions, please refer to Git Implementations and Bindings in Python .
Tips and Traps¶
- The
gitcommand (and thus Dulwich) accepts URLs both with and without the trailing.git.
In [1]:
!pip3 install dulwich
In [30]:
import dulwich.repo
In [31]:
from dulwich.repo import Repo
In [32]:
import dulwich.porcelain
In [6]:
url = "https://github.com/dclong/test_dulwich"
dir_local = "/tmp/test_dulwich"
!rm -rf {dir_local}
git clone¶
In [7]:
repo = dulwich.porcelain.clone(url, dir_local)
In [77]:
repo
Out[77]:
In [9]:
!ls {dir_local}
Clone the local repository to another location (which is not very useful as you can directly copy the directory to the new location).
In [ ]:
?repo.clone
dulwich.repo.Repo¶
In [20]:
type(repo)
Out[20]:
Create a repo from a local directory.
In [11]:
repo2 = Repo("/tmp/test_dulwich")
repo2
Out[11]:
In [21]:
dir(repo)
Out[21]:
git status¶
In [44]:
s = dulwich.porcelain.status(repo)
dir(s)
Out[44]:
In [47]:
s.staged
Out[47]:
In [48]:
s.unstaged
Out[48]:
In [49]:
s.untracked
Out[49]:
In [76]:
!git -C {dir_local} status
In [78]:
dulwich.porcelain.get_tree_changes(repo)
Out[78]:
In [56]:
!git -C {dir_local} diff
In [64]:
repo[b"head"]
In [65]:
dir(repo)
Out[65]:
In [66]:
repo.head
Out[66]:
In [68]:
repo.head()
Out[68]:
In [72]:
repo[repo.head()]
Out[72]:
In [73]:
repo.object_store
Out[73]:
In [74]:
import sys
from dulwich.patch import write_tree_diff
outstream = getattr(sys.stdout, 'buffer', sys.stdout)
write_tree_diff(outstream, repo.object_store, repo[repo.head()], commit.tree)
In [ ]:
import sys
from dulwich.patch import write_tree_diff
from dulwich.repo import Repo
repo_path = "."
commit_id = b"a6602654997420bcfd0bee2a0563d9416afe34b4"
r = Repo(repo_path)
commit = r[commit_id]
parent_commit = r[commit.parents[0]]
outstream = getattr(sys.stdout, 'buffer', sys.stdout)
write_tree_diff(outstream, r.object_store, parent_commit.tree, commit.tree)
git add¶
In [33]:
!touch /tmp/test_dulwich/abc2
In [34]:
!ls /tmp/test_dulwich/
In [35]:
!git -C /tmp/test_dulwich/ status
In [29]:
?dulwich.porcelain.add
In [32]:
dulwich.porcelain.add("/tmp/test_dulwich", paths="/tmp/test_dulwich/abc")
Out[32]:
By default, dulwich adds all files in the current working directory, which is not the right behavior! I have submitted a ticket to fix the issue.
In [54]:
dulwich.porcelain.add("/tmp/test_dulwich")
In [67]:
dulwich.porcelain.add("/tmp/test_dulwich", paths="/tmp/test_dulwich/.")
Out[67]:
In [71]:
status = dulwich.porcelain.status("/tmp/test_dulwich")
status
Out[71]:
In [72]:
status.unstaged
Out[72]:
In [73]:
status.untracked
Out[73]:
git commit¶
In [48]:
?dulwich.porcelain.commit
In [50]:
dulwich.porcelain.commit("/tmp/test_dulwich/", message="add abc")
Out[50]:
In [51]:
!git -C /tmp/test_dulwich/ status
In [53]:
!git -C /tmp/test_dulwich/ log | head
ConfigFile¶
ConfigFile inherits ConfigDict which means that you operate on a ConfiFile like a dict.
In [14]:
config = repo.get_config()
config
Out[14]:
In [37]:
config.keys()
Out[37]:
In [38]:
config.values()
Out[38]:
In [40]:
config[(b"remote", b"origin")]
Out[40]:
In [27]:
config.get((b"remote", b"origin"), b"url")
Out[27]:
In [31]:
dict(config)
Out[31]:
git remote -v¶
In [31]:
[m for m in dir(dulwich.porcelain) if 'remote' in m]
Out[31]:
In [34]:
dulwich.porcelain.get_branch_remote(repo)
Out[34]:
In [36]:
dulwich.porcelain.get_remote_repo(repo)
Out[36]:
In [39]:
dulwich.porcelain.ls_remote(url)
Out[39]:
In [36]:
[key[1].decode() for key in config.keys() if key[0] == b"remote"]
Out[36]:
dulwich.porcelain.ls_remote¶
In [79]:
dulwich.porcelain.ls_remote(url)
Out[79]:
dulwich.objects.Commit¶
In [43]:
repo.head()
Out[43]:
In [45]:
commit = repo[repo.head()]
commit
Out[45]:
In [46]:
type(commit)
Out[46]:
In [39]:
commit.message
Out[39]:
In [40]:
dir(commit)
Out[40]:
In [41]:
main = heads.main
main
Get the commit pointed to by head called master.
In [17]:
main.commit
Out[17]:
In [18]:
main.rename("main2")
Out[18]:
Verify that the main branch has been renamed to main2.
In [19]:
!cd {dir_local} && git branch
Get the Active Branch¶
In [19]:
[m for m in dir(dulwich.porcelain) if "br" in m]
Out[19]:
In [20]:
dulwich.porcelain.active_branch(repo)
Out[20]:
Get All Branches¶
In [21]:
dulwich.porcelain.branch_list(repo)
Out[21]:
Changed Files¶
Update a file.
In [23]:
!echo "# add a line of comment" >> {dir_local}/build.sh
Staged Files¶
The file build.sh is now staged.
Commit the change.
Push the Commits¶
Push the local main2 branch to the remote main2 branch.
The above is equivalent to the following more detailed specification.
Push the local main2 branch to the remote main branch.
git pull¶
In [11]:
!ls {dir_local}
In [12]:
dulwich.porcelain.pull(repo, refspecs="main")
In [13]:
!ls {dir_local}
git checkout¶
In [12]:
[m for m in dir(dulwich.porcelain) if 'checkout' in m]
Out[12]:
In [18]:
!git -C {dir_local} status
In [26]:
!git -C {dir_local} branch
In [27]:
dulwich.porcelain.checkout_branch(repo, "main")
In [28]:
!git -C {dir_local} branch
git tag¶
List all tags.
In [27]:
!git -C {dir_local} tag
In [24]:
[m for m in dir(dulwich.porcelain) if "tag" in m]
Out[24]:
In [37]:
dulwich.porcelain.tag_list(repo)
Out[37]:
git tag tag_name¶
Create a new tag.
In [38]:
dulwich.porcelain.tag_create(repo, "v2.0.0")
In [40]:
dulwich.porcelain.push(repo, refspecs="v2.0.0")
git diff¶
In [16]:
help(repo.refs[4].commit.diff)
In [3]:
url = "https://github.com/dclong/docker-ubuntu_b.git"
dir_local = "/tmp/" + url[(url.rindex("/") + 1) :]
!rm -rf {dir_local}
In [4]:
repo = git.Repo.clone_from(url, dir_local, branch="main")
repo
Out[4]:
In [25]:
repo.refs
Out[25]:
In [6]:
diffs = repo.refs[4].commit.diff(repo.refs[3].commit)
diffs
Out[6]:
In [21]:
diffs = repo.refs[4].commit.diff(repo.refs[2].commit)
diffs
Out[21]:
In [13]:
str(diffs[0])
Out[13]:
In [12]:
repo.refs[5].name
Out[12]:
In [6]:
print(repo.git.status())
In [6]:
repo.git.checkout("debian", force=True)
Out[6]:
In [8]:
repo.git.checkout(b="a_new_branch", force=True)
Out[8]:
In [ ]:
nima = repo.refs[4].checkout(force=True, b="nima")
nima
In [50]:
diffs = nima.commit.diff(repo.refs[-1].commit)
diffs[0].diff
Out[50]:
Diff the dev and the main branch,
which is equivalent to the Git command
git diff dev..main.
In [30]:
repo.refs[2].commit.diff(repo.refs[1].commit)
Out[30]:
In [32]:
diffs = repo.refs[2].commit.diff(repo.refs[0].commit)
diffs
Out[32]:
In [33]:
diffs[0]
Out[33]:
In [24]:
diffs = repo.refs[6].commit.diff(repo.refs[7].commit)
diffs
Out[24]:
In [25]:
diffs = repo.refs[4].commit.diff(repo.refs[7].commit)
diffs
Out[25]:
In [26]:
diffs[0].diff
Out[26]:
In [27]:
diffs = repo.refs[7].commit.diff(repo.refs[4].commit)
diffs
Out[27]:
In [28]:
diffs[0].diff
Out[28]:
In [19]:
any(ele for ele in [""])
Out[19]:
In [23]:
repo.branches[0].name
Out[23]:
In [ ]:
for branch in repo.branches:
branch.
In [12]:
commit = repo.head.commit
commit
Out[12]:
In [15]:
type(repo.branches[0])
Out[15]:
In [17]:
repo.refs[4].commit.diff(repo.refs[2].commit)
Out[17]:
In [9]:
repo.refs[4].commit.diff(repo.refs[3].commit)
Out[9]:
In [20]:
help(repo.git.branch)
In [28]:
repo.heads
Out[28]:
Diff the debian and the main branches but limit diff to specified paths
(via the paths parameter).
In [24]:
diffs = repo.refs[4].commit.diff(repo.refs[2].commit, paths=["build.sh", "scripts"])
diffs
Out[24]: