Skip to content

fix: Allow adding PathLike object to index #1440

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 1 commit into from
May 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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
4 changes: 2 additions & 2 deletions git/index/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -617,11 +617,11 @@ def _preprocess_add_items(
paths = []
entries = []
# if it is a string put in list
if isinstance(items, str):
if isinstance(items, (str, os.PathLike)):
items = [items]

for item in items:
if isinstance(item, str):
if isinstance(item, (str, os.PathLike)):
paths.append(self._to_relative_path(item))
elif isinstance(item, (Blob, Submodule)):
entries.append(BaseIndexEntry.from_blob(item))
Expand Down
11 changes: 11 additions & 0 deletions test/test_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
import os.path as osp
from git.cmd import Git

from pathlib import Path

HOOKS_SHEBANG = "#!/usr/bin/env sh\n"

is_win_without_bash = is_win and not shutil.which("bash.exe")
Expand Down Expand Up @@ -943,3 +945,12 @@ def test_commit_msg_hook_fail(self, rw_repo):
assert str(err)
else:
raise AssertionError("Should have caught a HookExecutionError")

@with_rw_repo('HEAD')
def test_index_add_pathlike(self, rw_repo):
git_dir = Path(rw_repo.git_dir)

file = git_dir / "file.txt"
file.touch()

rw_repo.index.add(file)