git: add untracked_files kwarg to status()

note that this currently is only available in dulwich>=0.20.38

Author: dtrifiro

scmrepo/git/backend/base.py

@@ -330,7 +330,7 @@ def checkout_index(
 
     @abstractmethod
     def status(
-        self, ignored: bool = False
+        self, ignored: bool = False, untracked_files: str = "all"
     ) -> Tuple[Mapping[str, Iterable[str]], Iterable[str], Iterable[str]]:
         """Return tuple of (staged_files, unstaged_files, untracked_files).
 
@@ -339,6 +339,15 @@ def status(
 
         If ignored is True, gitignored files will be included in
         untracked_paths.
+
+        untracked_files can be one of the following:
+          - "no" return no untracked files
+          - "normal" (git cli default) return untracked files and directories
+          - "all" (default) return all untracked files in untracked directories
+
+        Using "no" or "normal" will be faster than "all" when large untracked
+        directories are present in the workspace, as collecting all untracked
+        files can take some time.
         """
 
     def _reset(self) -> None:

scmrepo/git/backend/dulwich/__init__.py

@@ -750,12 +750,12 @@ def checkout_index(
         raise NotImplementedError
 
     def status(
-        self, ignored: bool = False
+        self, ignored: bool = False, untracked_files: str = "all"
     ) -> Tuple[Mapping[str, Iterable[str]], Iterable[str], Iterable[str]]:
         from dulwich.porcelain import status as git_status
 
         staged, unstaged, untracked = git_status(
-            self.root_dir, ignored=ignored
+            self.root_dir, ignored=ignored, untracked_files=untracked_files
         )
         return (
             {

scmrepo/git/backend/gitpython.py

@@ -615,7 +615,7 @@ def checkout_index(
             self.repo.index.checkout(paths=paths_list, force=force)
 
     def status(
-        self, ignored: bool = False
+        self, ignored: bool = False, untracked_files: str = "all"
     ) -> Tuple[Mapping[str, Iterable[str]], Iterable[str], Iterable[str]]:
         raise NotImplementedError
 

scmrepo/git/backend/pygit2.py

@@ -594,7 +594,7 @@ def iter_remote_refs(self, url: str, base: Optional[str] = None, **kwargs):
         raise NotImplementedError
 
     def status(
-        self, ignored: bool = False
+        self, ignored: bool = False, untracked_files: str = "all"
     ) -> Tuple[Mapping[str, Iterable[str]], Iterable[str], Iterable[str]]:
         raise NotImplementedError
 

tests/test_git.py

@@ -988,3 +988,56 @@ def test_fetch(
 
     target.fetch()
     assert target.get_ref("refs/remotes/origin/master") == rev
+
+
+@pytest.mark.skip_git_backend("pygit2", "gitpython")
+@pytest.mark.parametrize("untracked_files", ["all", "no"])
+@pytest.mark.parametrize("ignored", [False, True])
+def test_status(
+    tmp_dir: TmpDir,
+    scm: Git,
+    git: Git,
+    tmp_dir_factory: TempDirFactory,
+    untracked_files: str,
+    ignored: bool,
+):
+    tmp_dir.gen(
+        {
+            "foo": "foo",
+            "bar": "bar",
+            ".gitignore": "ignored",
+            "ignored": "ignored",
+        }
+    )
+    scm.add_commit(["foo", "bar", ".gitignore"], message="init")
+
+    staged, unstaged, untracked = git.status(ignored, untracked_files)
+
+    assert not staged
+    assert not unstaged
+    if ignored and untracked_files != "no":
+        assert untracked == ["ignored"]
+    else:
+        assert not untracked
+
+    with (tmp_dir / "foo").open("a") as fh:
+        fh.write("modified")
+
+    with (tmp_dir / "bar").open("a") as fh:
+        fh.write("modified")
+
+    tmp_dir.gen({"untracked_dir": {"subfolder": {"subfile": "subfile"}}})
+    expected_untracked = []
+    if ignored and untracked_files != "no":
+        expected_untracked.append("ignored")
+    if untracked_files != "no":
+        expected_untracked.append(
+            os.path.join("untracked_dir", "subfolder", "subfile")
+        )
+
+    git.add("foo")
+    staged, unstaged, untracked = git.status(ignored, untracked_files)
+
+    assert staged["modify"] == ["foo"]
+    assert unstaged == ["bar"]
+    assert untracked == expected_untracked