git.cmd.Git.execute(..): fix with_stdout=False#2126

ngie-eign

In the event the end-user called one of the APIs with with_stdout=False, i.e., they didn't want to capture stdout, the code would crash with an AttributeError or ValueError when trying to dereference the stdout/stderr streams attached to Popen(..) objects.

Be more defensive by checking the streams first to make sure they're not None before trying to access their corresponding attributes.

Add myself to AUTHORS and add corresponding regression tests for the change.

Byron

Thanks a lot. This looks good to me.

If the machine doesn't find anything horrendous, we can merge this.

Copilot

Pull request overview

Fixes Git.execute(..., with_stdout=False) crashing when stdout/stderr streams are None, and adds regression coverage to prevent future regressions.

Changes:

Make Git.execute() defensive against None stdout/stderr streams when stripping newlines, copying output, and closing handles.
Add regression tests for with_stdout=False scenarios (with and without output_stream).
Add contributor entry to AUTHORS and improve test cleanup robustness in rmtree tests.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description

git/cmd.py	Adds None checks around stdout/stderr usage to avoid crashes when stdout isn’t piped.
test/test_git.py	Adds regression tests covering with_stdout=False behavior.
test/test_util.py	Adds a pytest finalizer to ensure temp directories are cleaned up on platforms with stricter permissions.
AUTHORS	Adds a new contributor entry.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Byron

Needs auto-review comments to be addressed.

ngie-eign

@Byron : I tried dealing with the type hinting issues, but it turned into a lot of onion peeling... I would prefer to delay this for another PR (my WIP branch can be found here: https://github.com/ngie-eign/GitPython/tree/type-checking-rabbit-hole ).

Byron

Alright, let's do this!

Getting python to be sane at runtime is a bit like fighting windmills. And since CI isn't failing, I suppose we are fine enough until someone raises an issue.

In any case, an overhaul shouldn't be too bad if it leads to actual improvements, but there is also a danger as GitPython is 'stable' with all its faults, which makes it something to rely on. Or in other words: The tests probably don't cover all uses out there and an overhaul can be dangerous.

Maybe before spending too much time on this, you also have a good use case that shows why this is better and why this library really should. Change.

ngie-eign force-pushed the fix-execute-with_stdout-no-issues branch 3 times, most recently from d3d587c to a64bde9 Compare April 17, 2026 17:04

Byron requested a review from Copilot April 18, 2026 02:53

Copilot started reviewing on behalf of Byron April 18, 2026 02:53 View session

Byron approved these changes Apr 18, 2026

View reviewed changes

Copilot AI reviewed Apr 18, 2026

View reviewed changes

Comment thread test/test_util.py Outdated Show resolved Hide resolved

Comment thread git/cmd.py Show resolved Hide resolved

Comment thread git/cmd.py Show resolved Hide resolved

Byron requested changes Apr 18, 2026

View reviewed changes

ngie-eign force-pushed the fix-execute-with_stdout-no-issues branch 2 times, most recently from 0ae13c9 to 335989f Compare April 18, 2026 16:44

ngie-eign force-pushed the fix-execute-with_stdout-no-issues branch from 335989f to 6fc4742 Compare April 18, 2026 16:49

ngie-eign mentioned this pull request Apr 18, 2026

Use subprocess timeout #2127

Draft

ngie-eign requested a review from Byron April 18, 2026 18:07

Byron approved these changes Apr 19, 2026

View reviewed changes

ngie-eign deleted the fix-execute-with_stdout-no-issues branch April 20, 2026 20:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

git.cmd.Git.execute(..): fix with_stdout=False#2126