Configure GitPython to output/log commands and process output

Question

I'm using GitPython to run several simple commands against repos. Essentially most of it is just:

repo = Repo(repo_dir)
repo.git.fetch()
result = repo.git.diff("origin", name_only=True)
repo.git.merge()
# ...

Is there some way to setup GitPython to output/log the commands that are run, and also display the raw output they produce?

For example, the above I would expect to be something along the lines of:

$ git fetch
$ git diff --name-only origin
path/to/differing_file
path/to/another/differing_file
$ git merge

ElpieKay · Accepted Answer · 2021-01-08 11:25:02Z

5

GitPython uses the module logging. By adding logging.basicConfig(level=logging.DEBUG) before your code, it prints logs like

DEBUG:git.cmd:Popen(['git', 'fetch'], cwd=E:\path\foo, universal_newlines=False, shell=None)

If you want it to print formatted logs as you expect, you could modify GitPython's source code. I'm using Python 2.7 and my GitPython is installed at C:\Python27\lib\site-packages\git. You can run git.__file__ in REPL to find your installation directory. In the file C:\Python27\lib\site-packages\git\cmd.py, you can find a method def execute. It calls subprocess.Popen to run the command. You can modify the line log.debug before Popen or just insert print(' '.join(cmd)) at a proper line. If you are using Python 3.3 or newer, you could also refer to this answer on how to print the command with subprocess.

edited Jan 8, 2021 at 11:25

answered Jan 8, 2021 at 11:16

ElpieKay

31.6k6 gold badges38 silver badges72 bronze badges

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

1 Comment

Halvor Holsten Strand Over a year ago

This is perfect. Thank you.

Oweis Al-Agtash · Accepted Answer · 2022-03-11 17:05:25Z

0

You could also:

pull = self.repo.git.pull('--rebase')
log.info(pull)

answered Mar 11, 2022 at 17:05

Oweis Al-Agtash

1882 silver badges11 bronze badges

1 Comment

K. Frank Over a year ago

What module is your "log.info" from? Is there a benefit compared to just wrapping it into a print statement print(self.repo.git.pull('--rebase')? And is there a way to get the output live and not only after the command completed?

Collectives™ on Stack Overflow

Configure GitPython to output/log commands and process output

2 Answers 2

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related