dulwich: use untracked_files="no" in is_dirty

This will speed up calling `is_dirty` with untracked_files=False

related to #69

Author: dtrifiro

scmrepo/git/backend/dulwich/__init__.py

@@ -7,6 +7,7 @@
 from io import BytesIO, StringIO
 from typing import (
     TYPE_CHECKING,
+    Any,
     Callable,
     Dict,
     Iterable,
@@ -344,8 +345,11 @@ def is_tracked(self, path: str) -> bool:
         return False
 
     def is_dirty(self, untracked_files: bool = False) -> bool:
-        staged, unstaged, untracked = self.status()
-        return bool(staged or unstaged or (untracked_files and untracked))
+        kwargs: Dict[str, Any] = (
+            {} if untracked_files else {"untracked_files": "no"}
+        )
+        staged, unstaged, untracked = self.status(**kwargs)
+        return bool(staged or unstaged or untracked)
 
     def active_branch(self) -> str:
         raise NotImplementedError

tests/test_git.py

@@ -1041,3 +1041,78 @@ def test_status(
     assert staged["modify"] == ["foo"]
     assert unstaged == ["bar"]
     assert untracked == expected_untracked
+
+
+@pytest.mark.skip_git_backend("pygit2", "gitpython")
+@pytest.mark.parametrize("untracked_files", [False, True])
+def test_is_dirty_dulwich(
+    tmp_dir: TmpDir,
+    scm: Git,
+    git: Git,
+    tmp_dir_factory: TempDirFactory,
+    mocker,
+    untracked_files: str,
+):
+    tmp_dir.gen(
+        {
+            "foo": "foo",
+        }
+    )
+    scm.add_commit(["foo"], message="init")
+
+    assert not git.is_dirty()
+
+    with (tmp_dir / "foo").open("a") as fobj:
+        fobj.write("modified")
+
+    assert git.is_dirty(untracked_files)
+    scm.add_commit(["foo"], message="commit")
+
+    with (tmp_dir / "untracked").open("w") as fobj:
+        fobj.write("untracked")
+
+    spy = mocker.spy(git.dulwich, "status")
+
+    assert git.is_dirty(untracked_files) == untracked_files
+    assert spy.called
+    _, kwargs = spy.call_args
+    if untracked_files:
+        assert not kwargs
+    else:
+        assert kwargs["untracked_files"] == "no"
+
+
+@pytest.mark.skip_git_backend("pygit2", "dulwich")
+@pytest.mark.parametrize("untracked_files", [False, True])
+def test_is_dirty_gitpython(
+    tmp_dir: TmpDir,
+    scm: Git,
+    git: Git,
+    tmp_dir_factory: TempDirFactory,
+    mocker,
+    untracked_files: str,
+):
+    tmp_dir.gen(
+        {
+            "foo": "foo",
+        }
+    )
+    scm.add_commit(["foo"], message="init")
+
+    assert not git.is_dirty()
+
+    with (tmp_dir / "foo").open("a") as fobj:
+        fobj.write("modified")
+
+    assert git.is_dirty(untracked_files)
+    scm.add_commit(["foo"], message="commit")
+
+    with (tmp_dir / "untracked").open("w") as fobj:
+        fobj.write("untracked")
+
+    spy = mocker.spy(git.gitpython.repo, "is_dirty")
+
+    assert git.is_dirty(untracked_files) == untracked_files
+    assert spy.called
+    _, kwargs = spy.call_args
+    assert kwargs["untracked_files"] == untracked_files