Check status of local Python relative to remote with GitPython

Question

How can I use GitPython to determine whether:

My local branch is ahead of the remote (I can safely push)
My local branch is behind the remote (I can safely pull)
My local branch has diverged from the remote?

To check if the local and remote are the same, I'm doing this:

def local_and_remote_are_at_same_commit(repo, remote):
    local_commit = repo.commit()
    remote_commit = remote.fetch()[0].commit
    return local_commit.hexsha == remote_commit.hexsha

Possible duplicate of How to get count of unpublished commit with GitPython? — Michael come lately
– Michael come lately, Commented Dec 12, 2018 at 15:46

Voy · Accepted Answer · 2020-12-17 05:32:41Z

19

See https://stackoverflow.com/a/15862203/197789

E.g.

commits_behind = repo.iter_commits('master..origin/master')

and

commits_ahead = repo.iter_commits('origin/master..master')

Then you can use something like the following to go from iterator to a count:

count = sum(1 for c in commits_ahead)

(You may want to fetch from the remotes before running iter_commits, eg: repo.remotes.origin.fetch())

This was last checked with GitPython 1.0.2.

edited Dec 17, 2020 at 5:32

Voy

6,4643 gold badges56 silver badges67 bronze badges

answered Jan 29, 2014 at 12:56

Von

4,5552 gold badges32 silver badges31 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Waldo Bronchart Over a year ago

With a branch that was 3 commits behind and 1 commit ahead, this gave me a sum of 4 for len(list(commits_behind)) and len(list(commits_ahead))

Waldo Bronchart · Accepted Answer · 2021-04-15 13:44:46Z

2

The following worked better for me, which I got from this stackoverflow answer

commits_diff = repo.git.rev_list('--left-right', '--count', f'{branch}...{branch}@{{u}}')
num_ahead, num_behind = commits_diff.split('\t')
print(f'num_commits_ahead: {num_ahead}')
print(f'num_commits_behind: {num_behind}')

answered Apr 15, 2021 at 13:44

Waldo Bronchart

10.7k4 gold badges27 silver badges29 bronze badges

2 Comments

SkyWalker Over a year ago

Thank you for the answer, what's @{{u}}???

Waldo Bronchart Over a year ago

I believe it's for "upstream", the double { is to escape the python string formatter {

Collectives™ on Stack Overflow

Check status of local Python relative to remote with GitPython

2 Answers 2

1 Comment

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related