get short sha of commit with gitpython

python git gitpython
Kentaro Wada picture Kentaro Wada · Aug 12, 2015 · Viewed 10.2k times · Source

The long SHA can be gotten like below:

repo = git.Repo(search_parent_directories=True)
sha = repo.head.object.hexsha

Or, in git 3.1.7:

sha = repo.head.commit.hexsha

How about short one? (short SHA is decided by the scale of the repo, so it should not be like sha[:7])

Answer

lemonhead picture lemonhead · Aug 12, 2015

As far as I can tell, the gitpython Commit object does not support the short sha directly. However, you can use still gitpython's support for calling git directly to retrieve it (as of git 3.1.7):

repo = git.Repo(search_parent_directories=True)
sha = repo.head.commit.hexsha
short_sha = repo.git.rev_parse(sha, short=4)

This is the equivalent of running

git rev-parse --short=4 ...

on the command-line, which is the usual way of getting the short hash. This will return the shortest possible unambiguous hash of length >= 4 (You could pass in a smaller number, but since git's internal min is 4 it will have the same effect).

Related questions

How can I pull a remote repository with GitPython?

I am trying to find the way to pull a git repository using gitPython. So far this is what I have taken from the official docs here. test_remote = repo.create_remote('test', 'git@server:repo.git') repo.delete_remote(…

Read More
Git push via GitPython

I have this code in Python (using "import git"): repo = git.Repo("my_repository") repo.git.add("bla.txt") repo.git.commit("my commit description") Now I want to push this commit. I've tried a lot with no success. The …

Read More
Checkout or list remote branches in GitPython

I don't see an option to checkout or list remote/local branches in this module: https://gitpython.readthedocs.io/en/stable/

Read More