fix files list on file rename #1537
Merged
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
Jan 12, 2023
|
@Byron done, and I rewrote the commit message using GitPython hashes, so is simpler for anyone to test |
Byron
requested changes
Jan 13, 2023
There was a problem hiding this comment.
Thanks a lot, this looks like the way to go!
Instead of checking what it shouldn't be (which is a huge set of possible values), could you instead check what it should be? How does a rename look like with the current interface, I'd be very interested to see that.
For posterity, here is what git thinks about the commit being used in the test:
commit 185d847ec7647fd2642a82d9205fb3d07ea71715
Author: Dominic <<redacted>@gmail.com>
Date: Mon Jul 12 17:02:21 2021 +0100
Update and rename test_pytest.yml to Future.yml
diff --git a/.github/workflows/test_pytest.yml b/.github/workflows/Future.yml
similarity index 92%
rename from .github/workflows/test_pytest.yml
rename to .github/workflows/Future.yml
index 627e720f..39146533 100644
--- a/.github/workflows/test_pytest.yml
+++ b/.github/workflows/Future.yml
@@ -5,7 +5,9 @@ name: Future
on:
push:
- branches: [main]
+ branches: [ main ]
+ pull_request:
+ branches: [ main ]
jobs:
build:|
This is the output of And with |
GitPython parses the output of `git diff --numstat` to get the
files changed in a commit.
This breaks when a commit contains a file rename, because the output
of `git diff` is different than expected.
This is the output of a normal commit:
$ git diff --numstat 8f41a39^ 8f41a39
30 5 test/test_repo.py
And this a commit containing a rename:
$ git diff --numstat 185d847^ 185d847
3 1 .github/workflows/{test_pytest.yml => Future.yml}
This can be triggered by this code:
for commit in repo.iter_commits():
print(commit.hexsha)
for file in commit.stats.files:
print(file)
Which will print for the normal commit:
8f41a39
'test/test_repo.py'
And when there is a rename:
185d847
'.github/workflows/{test_pytest.yml => Future.yml}'
Additionally, when a path member is removed, the file list become
a list of strings, breaking even more the caller. This is in the
Linux kernel tree:
$ git diff --numstat db401875f438^ db401875f438
1 1 tools/testing/selftests/drivers/net/mlxsw/{spectrum-2 => }/devlink_trap_tunnel_ipip6.sh
and GitPython parses it as:
db401875f438168c5804b295b93a28c7730bb57a
('tools/testing/selftests/drivers/net/mlxsw/{spectrum-2 => '
'}/devlink_trap_tunnel_ipip6.sh')
Fix this by pasing the --no-renames option to `git diff` which ignores
renames and print the same output as if the file was deleted from the
old path and created in the new one:
$ git diff --numstat --no-renames 185d847^ 185d847
57 0 .github/workflows/Future.yml
0 55 .github/workflows/test_pytest.yml
Byron
approved these changes
Jan 14, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
GitPython parses the output of
git diff --no-renamesto get the files changed in a commit.This breaks when a commit contains a file rename, because the output of
git diffis different than expected.This is the output of a normal commit:
And this a commit containing a rename:
This can be triggered by this code:
Which will print for the normal commit:
And when there is a rename:
Fix this by pasing the --no-renames option to
git diffwhich ignores renames and print the same output as if the file was deleted from the old path and created in the new one: