Skip to content

Clarify Git.execute and Popen arguments #1688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 3, 2023
Merged

Clarify Git.execute and Popen arguments #1688

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b79198a
Document Git.execute parameters in definition order
EliahKagan Oct 3, 2023
13e1593
Don't say Git.execute uses a shell, in its summary
EliahKagan Oct 3, 2023
74b68e9
Copyedit Git.execute docstring
EliahKagan Oct 3, 2023
133271b
Other copyediting in the git.cmd module
EliahKagan Oct 3, 2023
fc755da
Avoid having a local function seem to be a method
EliahKagan Oct 3, 2023
2d1efdc
Test that git.cmd.execute_kwargs is correct
EliahKagan Oct 3, 2023
a8a43fe
Simplify shell test helper with with_exceptions=False
EliahKagan Oct 3, 2023
9fa1cee
Extract a _assert_logged_for_popen method
EliahKagan Oct 3, 2023
790a790
Log stdin arg as such, and test that this is done
EliahKagan Oct 3, 2023
c3fde7f
Log args in the order they are passed to Popen
EliahKagan Oct 3, 2023
ab95886
Eliminate istream_ok variable
EliahKagan Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Eliminate istream_ok variable 
In Git.execute, the stdin argument to Popen is the only one where a
compound expression (rather than a single term) is currently
passed. So having that be the same in the log message makes it
easier to understand what is going on, as well as to see how the
information shown in the log corresponds to what Popen receives.
  • Loading branch information
@EliahKagan
EliahKagan committed Oct 3, 2023
commit ab958865d89b3146bb953f826f30da11dc59139a
5 changes: 1 addition & 4 deletions git/cmd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,16 +973,13 @@ def execute(
# end handle

stdout_sink = PIPE if with_stdout else getattr(subprocess, "DEVNULL", None) or open(os.devnull, "wb")
istream_ok = "None"
if istream:
istream_ok = "<valid stream>"
if shell is None:
shell = self.USE_SHELL
log.debug(
"Popen(%s, cwd=%s, stdin=%s, shell=%s, universal_newlines=%s)",
redacted_command,
cwd,
istream_ok,
"<valid stream>" if istream else "None",
shell,
universal_newlines,
)
Expand Down