How to get output of git commands into Python variables

Question

Is it possible to collect output of a git command into a Python variable?

Lets a simple command like git status which gives the list of files changed on the repo. Lets say the output of git status is following

A.cpp
B.hpp
C.cpp

Is it possible to get the above output of git status into a Python list?

I read the some git commands do not pipe the output and rather just print? Is it true even today? If a git command was piping the output, how can one collect it a Python list or variable?

Can GitPython help here?

I used GitPython and it worked fine. I opted not to use the offered API, but rather only invoked pure git commands via passing strings to it, as it was much faster to learn and more reliable. It does nice nice wrapping over that part. If you do end up using it a lot, I think it can benefit to actually use the offered API. — Gulzar
– Gulzar, Commented Apr 19, 2021 at 10:57
I forgot exactly the method that allows passing the strings, but it never failed me. — Gulzar
– Gulzar, Commented Apr 19, 2021 at 10:58
Interesting solution with GitPython: Get changed files using gitpython — wuerfelfreak
– wuerfelfreak, Commented Apr 19, 2021 at 12:32

David Meu · Accepted Answer · 2021-04-19 11:18:35Z

3

You can use: GitPython

Or 'native way':

from subprocess import Popen, PIPE
cmd = 'git diff --name-only'
p = Popen(cmd, stdout=PIPE, stderr=PIPE)
stdout, stderr = p.communicate()
files_changed_list = stdout.decode("utf-8").splitlines()

answered Apr 19, 2021 at 11:18

David Meu

1,5309 silver badges19 bronze badges

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

1 Comment

torek Over a year ago

Be aware that the output from git diff --name-only has whatever encoding the names actually have, which may not always be valid UTF-8. If it isn't UTF-8, the exception you'll get here is perhaps the best you can do anyway, though. :-)

Milan Lakhani · Accepted Answer · 2021-04-19 11:29:02Z

1

You could also use Python's os module.

import os

os.system("git diff --name-only | tee status")

would put the names of the changed files into a file called status.

Erm I think the other answer is better though.

edited Apr 19, 2021 at 11:29

answered Apr 19, 2021 at 11:23

Milan Lakhani

1081 silver badge8 bronze badges

Collectives™ on Stack Overflow

How to get output of git commands into Python variables

2 Answers 2

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related