Deprecate default of Git.show(strip_newline_in_stdout=False) #1948
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Byron
requested changes
Jul 30, 2024
| @@ -1210,6 +1210,14 @@ def execute( | |||
| if self.GIT_PYTHON_TRACE and (self.GIT_PYTHON_TRACE != "full" or as_process): | |||
| _logger.info(" ".join(redacted_command)) | |||
|
|
|||
| if strip_newline_in_stdout and command[:2] == ["git", "show"]: | |||
There was a problem hiding this comment.
"git" shouldn't be hard-coded, and I am pretty sure there is a variable for this somewhere.
| @@ -1210,6 +1210,14 @@ def execute( | |||
| if self.GIT_PYTHON_TRACE and (self.GIT_PYTHON_TRACE != "full" or as_process): | |||
| _logger.info(" ".join(redacted_command)) | |||
|
|
|||
| if strip_newline_in_stdout and command[:2] == ["git", "show"]: | |||
| warnings.warn( | |||
| "Git.show() has strip_newline_in_stdout=True by default, which probably isn't what you want and will " | |||
There was a problem hiding this comment.
Suggested change
| "Git.show() has strip_newline_in_stdout=True by default, which probably isn't what you want and will " | |
| "Git.show() has strip_newline_in_stdout=True by default, which probably isn't what you want and may " |
| return r | ||
|
|
||
| @with_rw_directory | ||
| def test_warn_when_strip_newline_in_stdout(self, rw_dir): |
There was a problem hiding this comment.
Let's put the additional assertion done in test_do_not_strip_newline_in_stdout here so that it's clearer what's under test: The deprecation warning if git show is used and strip_newline_in_stdout=True. This way, test_do_not_strip_newline_in_stdout can be removed. I'd also hope that the assertion then can be changed to use the default value for strip_newline_in_stdout, which is probably True, the cause of the confusion in this case.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As per our discussion in #1377.
Also fix a few tests that were broken by my git being configured to create new repos with
mainas the initial branch, so that all my tests pass.