Checkout or list remote branches in GitPython

python git gitpython
Mike picture Mike · Mar 18, 2010 · Viewed 24.7k times · Source

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

Answer

pkowalczyk picture pkowalczyk · Feb 13, 2017

To list branches you can use:

from git import Repo
r = Repo(your_repo_path)
repo_heads = r.heads # or it's alias: r.branches

r.heads returns git.util.IterableList (inherits after list) of git.Head objects, so you can:

repo_heads_names = [h.name for h in repo_heads]

And to checkout eg. master:

repo_heads['master'].checkout() 
# you can get elements of IterableList through it_list['branch_name'] 
# or it_list.branch_name

Module mentioned in the question is GitPython which moved from gitorious to Github.

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
How to check out a branch with GitPython

I have cloned a repository with GitPython, now I would like to checkout a branch and update the local repository's working tree with the contents of that branch. Ideally, I'd also be able to check if the branch exists before …

Read More