GitPython icon indicating copy to clipboard operation
GitPython copied to clipboard

Raise exception when git push fails

Open michaelkozakovsc opened this issue 8 years ago • 19 comments
trafficstars

Having to perform bit operations on flags is very unintuitive. The command line git client fails when push fails.

michaelkozakovsc avatar Apr 19 '17 18:04 michaelkozakovsc

I have the same issue. An exception should be raised instead.

Error lines received while fetching: error: failed to push some refs to '[email protected]:NicoHood/project.git'
hint: Updates were rejected because the tag already exists in the remote.

NicoHood avatar May 13 '17 14:05 NicoHood

This might be related to a change in the git program itself, as I believe git push should return with a none-zero exit status if it fails. Apparently this doesn't happen under certain circumstances (anymore).

Byron avatar Jun 10 '17 18:06 Byron

Is problem that it's eating the exception here

https://github.com/gitpython-developers/GitPython/blob/master/git/remote.py#L702

Should always raise an exception, warning text also references fetch instead of push.

David-Green avatar Aug 09 '17 17:08 David-Green

Is this still an issue? The links provided don't refer to a specific commit, thus the lines shift and make it hard to find the point you refer to, in retrospective. Thank you.

Byron avatar Sep 28 '17 14:09 Byron

@Byron i think @David-Green was referring to this https://github.com/gitpython-developers/GitPython/blob/2b3c16c39953e7a6f55379403ca5d204dcbdb1e7/git/remote.py#L702

michaelkozakovsc avatar Sep 28 '17 14:09 michaelkozakovsc

This has also been an issue for me using 2.1.5: When doing : self.repo = Repo('repo_dir') self.repo.remotes[0].push(self.repo.head.reference.name) Get this logging: (remote.py:702) WARNING > Error lines received while fetching: error: failed to push some refs to 'ssh://xxxxxxx' To prevent you from losing history, non-fast-forward updates were rejected Merge the remote changes before pushing again. See the 'Note about fast-forwards' section of 'git push --help' for details.

But in fact I want this to be an exception. It does look like the following lines that are the problem (at line 730 in the current master: except Exception: if not output: raise elif stderr_text: log.warning("Error lines received while fetching: %s", stderr_text) return output

Wombleydude avatar Apr 18 '18 13:04 Wombleydude

Sorry to pile on, but this just bit my team today too. We were moving a few hundred repos, and a few of them failed to push with mirror to the new remote, yet the script exited successfully with no errors but never actually pushed the repo. Trying to push with command line gives us "error: failed to push some refs to..."

bagatonovic-remesh avatar Apr 25 '18 21:04 bagatonovic-remesh

I got bitten by this too while trying to automate git push.

2018-04-30 11:12:37,693 WARNING git.remote Error lines received while fetching: error: failed to push some refs to 'git@xxxxxx:yyyyyy/zzzzz.git'

soumyadipdm avatar Apr 30 '18 11:04 soumyadipdm

Do you think fixing this would be possible for one of the people having been bitten by this? The code to alter should be right here. Probably changing the behaviour from logging to throwing an exception would be desirable, even though it technically is a breaking change.

Byron avatar Jun 05 '18 10:06 Byron

Also been bitten by this recently...reviving!

JimNero009 avatar Mar 04 '19 15:03 JimNero009

I have had to use some very serious checking to detect and handle failed pushes with gitpython==2.1.11 and it's bonkers that I had to try so hard.

impredicative avatar Mar 04 '19 15:03 impredicative

Agree. Errors should be reported as exceptions.

artgoldberg avatar May 18 '19 21:05 artgoldberg

Also was just bit by this issue.

KalenWessel avatar Jun 10 '19 20:06 KalenWessel

Also was just bit by this issue.

rfrancois avatar Jul 15 '21 07:07 rfrancois

As a general question: What about submitting a PR with a new push_or_throw(…) method, which does as it says? There should be enough references in this thread to implement it without spending too much time on research.

Byron avatar Jul 15 '21 10:07 Byron

In case someone else stumbles on this very strange behaviour, and doesn't immediately dive into Sjord's commits (mentioned in this issue, above this comment): raise_if_error() can now be called on the object returned by the push() call.

That landed in 3.1.25, and the tutorial has an example:

# push and pull behaves similarly to `git push|pull`
origin.pull()
origin.push()  # attempt push, ignore errors
origin.push().raise_if_error()  # push and raise error if it fails

CyrilBrulebois avatar Apr 09 '22 09:04 CyrilBrulebois

For some reason, the PushInfoList class has been shipped since 35f7e9486 aka. 3.1.25~10 but can't be found by searching for it on https://gitpython.readthedocs.io/en/latest/ (latest or specific versions). So I suppose some extra doc metadata is needed to improve discoverability?

CyrilBrulebois avatar Apr 09 '22 09:04 CyrilBrulebois

In case someone needs to work with a slightly older version (e.g. 3.1.14, available in Debian 11), here's something that seems to do the trick for me (keeping in mind raising a generic Exception works well enough for me since I'm in a retry loop doing fetch & push inside a try/except block):

origin.pull(rebase=True)
# Workaround for missing origin.push().raise_if_error() in 3.1.14
# (see https://github.com/gitpython-developers/GitPython/issues/621):
pushinfolist = origin.push()
for pi in pushinfolist:  # pylint: disable=invalid-name
    for flag in [pi.REJECTED, pi.REMOTE_REJECTED, pi.REMOTE_FAILURE, pi.ERROR]:
        if pi.flags & flag:
            raise Exception("error flag %d set" % flag)

Caveat: I had to hardcode which flags look like errors I should care about; not sure how stable it is going to be across releases.

CyrilBrulebois avatar Apr 09 '22 09:04 CyrilBrulebois

Thanks for sharing! The flags should not change across releases as breaking changes are generally avoided.

Byron avatar Apr 09 '22 10:04 Byron