Working on Windows you sometime end up having some paths with backslashes (windows native) and some with slashes - this PR will resolve the issue using gitpython for those kind of cases (see example below). It will also fix the issues if paths contain redundant separators or "..".

import gitrepo = git.Repo(r"C:\gittest")repo.index.add(r"C:\gittest\1.txt")# Traceback (most recent call last):#   File "c:\second_test.py", line 5, in <module>#     repo.index.add(r"C:/gittest/2.txt")#   File "Python311\Lib\site-packages\git\index\base.py", line 879, in add#     paths, entries = self._preprocess_add_items(items)#                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^#   File "Python311\Lib\site-packages\git\index\base.py", line 672, in _preprocess_add_items#     paths.append(self._to_relative_path(item))#                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^#   File "Python311\Lib\site-packages\git\index\base.py", line 657, in _to_relative_path#     raise ValueError("Absolute path %r is not in git repository at %r" % (path, self.repo.working_tree_dir))# ValueError: Absolute path 'C:/gittest/2.txt' is not in git repository at 'C:\\gittest'repo.index.add(r"C:/gittest/2.txt")repo.index.commit("test")

_to_relative_path to support mixing slashes and backslashes

f2254af

Working on Windows you sometime end up having some paths with backslashes (windows native) and some with slashes - this PR will resolve the issue using gitpython for those kind of cases (see example below). It will also fix the issues if paths contain redundant separators or "..".```import gitrepo = git.Repo(r"C:\gittest")repo.index.add(r"C:\gittest\1.txt")# Traceback (most recent call last):#   File "c:\second_test.py", line 5, in <module>#     repo.index.add(r"C:/gittest/2.txt")#   File "Python311\Lib\site-packages\git\index\base.py", line 879, in add#     paths, entries = self._preprocess_add_items(items)#                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^#   File "Python311\Lib\site-packages\git\index\base.py", line 672, in _preprocess_add_items#     paths.append(self._to_relative_path(item))#                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^#   File "Python311\Lib\site-packages\git\index\base.py", line 657, in _to_relative_path#     raise ValueError("Absolute path %r is not in git repository at %r" % (path, self.repo.working_tree_dir))# ValueError: Absolute path 'C:/gittest/2.txt' is not in git repository at 'C:\\gittest'repo.index.add(r"C:/gittest/2.txt")repo.index.commit("test")```

Byron requested changes

Sep 14, 2024

View reviewed changes

Copy link

Member

Byron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thanks a lot - this looks like an improvement.

Could you also add a test that fails with the previous implementation?

Maybe as a question on the side: what prevents the caller from normalizing the input paths right away?

git/index/base.py OutdatedShow resolvedHide resolved

Andrej730 added2 commits

September 14, 2024 16:51

test adding a file using non-normalized path

ca06b11

Remove redundant path normalization for working_tree_dir

4674059

Copy link

ContributorAuthor

Andrej730 commentedSep 14, 2024

Could you also add a test that fails with the previous implementation?

Added.

Maybe as a question on the side: what prevents the caller from normalizing the input paths right away?

Well, normalizing the inputs is one error traceback back away indeed but usually when some method has a string-path argument user expects the method to handle any kind of paths.