fix: Allow adding PathLike object to index

Close gitpython-developers#1382

Author: Ruben DI BATTISTA

git/index/base.py

@@ -5,77 +5,69 @@
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 
 import glob
-from io import BytesIO
 import os
-from stat import S_ISLNK
+import os.path as osp
 import subprocess
 import tempfile
-
-from git.compat import (
-    force_bytes,
-    defenc,
-)
-from git.exc import (
-    GitCommandError,
-    CheckoutError,
-    GitError,
-    InvalidGitRepositoryError
-)
-from git.objects import (
-    Blob,
-    Submodule,
-    Tree,
-    Object,
-    Commit,
+from io import BytesIO
+from stat import S_ISLNK
+from typing import (
+    IO,
+    TYPE_CHECKING,
+    Any,
+    BinaryIO,
+    Callable,
+    Dict,
+    Iterable,
+    Iterator,
+    List,
+    NoReturn,
+    Sequence,
+    Tuple,
+    Type,
+    Union,
 )
+
+import git.diff as git_diff
+from git.compat import defenc, force_bytes
+from git.exc import CheckoutError, GitCommandError, GitError, InvalidGitRepositoryError
+from git.objects import Blob, Commit, Object, Submodule, Tree
 from git.objects.util import Serializable
+from git.types import Commit_ish, PathLike
 from git.util import (
     LazyMixin,
     LockedFD,
-    join_path_native,
     file_contents_ro,
+    join_path_native,
+    to_bin_sha,
     to_native_path_linux,
     unbare_repo,
-    to_bin_sha
 )
 from gitdb.base import IStream
 from gitdb.db import MemoryDB
 
-import git.diff as git_diff
-import os.path as osp
-
 from .fun import (
+    S_IFGITLINK,
+    aggressive_tree_merge,
     entry_key,
-    write_cache,
     read_cache,
-    aggressive_tree_merge,
-    write_tree_from_cache,
+    run_commit_hook,
     stat_mode_to_index_mode,
-    S_IFGITLINK,
-    run_commit_hook
-)
-from .typ import (
-    BaseIndexEntry,
-    IndexEntry,
-)
-from .util import (
-    TemporaryFileSwap,
-    post_clear_cache,
-    default_index,
-    git_working_dir
+    write_cache,
+    write_tree_from_cache,
 )
+from .typ import BaseIndexEntry, IndexEntry
+from .util import TemporaryFileSwap, default_index, git_working_dir, post_clear_cache
 
 # typing -----------------------------------------------------------------------------
 
-from typing import (Any, BinaryIO, Callable, Dict, IO, Iterable, Iterator, List, NoReturn,
-                    Sequence, TYPE_CHECKING, Tuple, Type, Union)
 
-from git.types import Commit_ish, PathLike
 
 if TYPE_CHECKING:
     from subprocess import Popen
-    from git.repo import Repo
+
     from git.refs.reference import Reference
+    from git.repo import Repo
     from git.util import Actor
 
 
@@ -594,11 +586,11 @@ def _preprocess_add_items(self, items: Sequence[Union[PathLike, Blob, BaseIndexE
         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))

test/test_index.py

@@ -5,52 +5,36 @@
 # This module is part of GitPython and is released under
 # the BSD License: http://www.opensource.org/licenses/bsd-license.php
 
-from io import BytesIO
 import os
-from stat import (
-    S_ISLNK,
-    ST_MODE
-)
+import os.path as osp
+import shutil
 import tempfile
+from io import BytesIO
+from pathlib import Path
+from stat import S_ISLNK, ST_MODE
+from test.lib import TestBase, fixture, fixture_path, with_rw_directory, with_rw_repo
 from unittest import skipIf
-import shutil
 
 from git import (
-    IndexFile,
-    Repo,
     BlobFilter,
-    UnmergedEntriesError,
-    Tree,
-    Object,
+    CheckoutError,
     Diff,
     GitCommandError,
-    CheckoutError,
+    IndexFile,
+    Object,
+    Repo,
+    Tree,
+    UnmergedEntriesError,
 )
+from git.cmd import Git
 from git.compat import is_win
-from git.exc import (
-    HookExecutionError,
-    InvalidGitRepositoryError
-)
+from git.exc import HookExecutionError, InvalidGitRepositoryError
 from git.index.fun import hook_path
-from git.index.typ import (
-    BaseIndexEntry,
-    IndexEntry
-)
+from git.index.typ import BaseIndexEntry, IndexEntry
 from git.objects import Blob
-from test.lib import (
-    TestBase,
-    fixture_path,
-    fixture,
-    with_rw_repo
-)
-from test.lib import with_rw_directory
-from git.util import Actor, rmtree
-from git.util import HIDE_WINDOWS_KNOWN_ERRORS, hex_to_bin
+from git.util import HIDE_WINDOWS_KNOWN_ERRORS, Actor, hex_to_bin, rmtree
 from gitdb.base import IStream
 
-import os.path as osp
-from git.cmd import Git
-
 HOOKS_SHEBANG = "#!/usr/bin/env sh\n"
 
 is_win_without_bash = is_win and not shutil.which('bash.exe')
@@ -937,3 +921,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)