Skip to content

feat(cmd): add the strip_newline flag #1423

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.

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 5 commits into from
Apr 7, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
chore: s/strip_newline/&_in_stdout
  • Loading branch information
toku-sa-n committed Apr 7, 2022
commit 49150e79c6f7a19a0d61a5ea6864b9ac140264ff
10 changes: 5 additions & 5 deletions git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
execute_kwargs = {'istream', 'with_extended_output',
'with_exceptions', 'as_process', 'stdout_as_string',
'output_stream', 'with_stdout', 'kill_after_timeout',
'universal_newlines', 'shell', 'env', 'max_chunk_size', 'strip_newline'}
'universal_newlines', 'shell', 'env', 'max_chunk_size', 'strip_newline_in_stdout'}

log = logging.getLogger(__name__)
log.addHandler(logging.NullHandler())
Expand Down Expand Up @@ -738,7 +738,7 @@ def execute(self,
shell: Union[None, bool] = None,
env: Union[None, Mapping[str, str]] = None,
max_chunk_size: int = io.DEFAULT_BUFFER_SIZE,
strip_newline: bool = True,
strip_newline_in_stdout: bool = True,
**subprocess_kwargs: Any
) -> Union[str, bytes, Tuple[int, Union[str, bytes], str], AutoInterrupt]:
"""Handles executing the command on the shell and consumes and returns
Expand Down Expand Up @@ -811,8 +811,8 @@ def execute(self,
effects on a repository. For example, stale locks in case of git gc could
render the repository incapable of accepting changes until the lock is manually
removed.
:param strip_newline:
Whether to strip the trailing '\n' of the command output.
:param strip_newline_in_stdout:
Whether to strip the trailing '\n' of the command stdout.

:return:
* str(output) if extended_output = False (Default)
Expand Down Expand Up @@ -947,7 +947,7 @@ def _kill_process(pid: int) -> None:
if not universal_newlines:
stderr_value = stderr_value.encode(defenc)
# strip trailing "\n"
if stdout_value.endswith(newline) and strip_newline: # type: ignore
if stdout_value.endswith(newline) and strip_newline_in_stdout: # type: ignore
stdout_value = stdout_value[:-1]
if stderr_value.endswith(newline): # type: ignore
stderr_value = stderr_value[:-1]
Expand Down
4 changes: 2 additions & 2 deletions test/test_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -1100,11 +1100,11 @@ def test_rebasing(self, rw_dir):
self.assertEqual(r.currently_rebasing_on(), commitSpanish)

@with_rw_directory
def test_do_not_strip_newline(self, rw_dir):
def test_do_not_strip_newline_in_stdout(self, rw_dir):
r = Repo.init(rw_dir)
fp = osp.join(rw_dir, 'hello.txt')
with open(fp, 'w') as fs:
fs.write("hello\n")
r.git.add(Git.polish_url(fp))
r.git.commit(message="init")
self.assertEqual(r.git.show("HEAD:hello.txt", strip_newline=False), 'hello\n')
self.assertEqual(r.git.show("HEAD:hello.txt", strip_newline_in_stdout=False), 'hello\n')