fix: Enhace black efficiently to skip directories listed in .gitignore (

#4415)
psf · Aug 2, 2024 · 14b6e61 · 14b6e61
1 parent b1c4dd9
commit 14b6e61
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 0 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -48,6 +48,8 @@
 
 <!-- Changes that improve Black's performance. -->
 
+- Improve performance when a large directory is listed in `.gitignore` (#4415)
+
 ### Output
 
 <!-- Changes to Black's terminal output and error messages -->

diff --git a/src/black/files.py b/src/black/files.py
@@ -309,6 +309,8 @@ def _path_is_ignored(
     for gitignore_path, pattern in gitignore_dict.items():
         try:
             relative_path = path.relative_to(gitignore_path).as_posix()
+            if path.is_dir():
+                relative_path = relative_path + "/"
         except ValueError:
             break
         if pattern.match_file(relative_path):

diff --git a/tests/data/ignore_directory_gitignore_tests/.gitignore b/tests/data/ignore_directory_gitignore_tests/.gitignore
@@ -0,0 +1,3 @@
+large_ignored_dir/
+large_ignored_dir_two
+abc.py
diff --git a/tests/data/ignore_directory_gitignore_tests/abc.py b/tests/data/ignore_directory_gitignore_tests/abc.py
diff --git a/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/a.py b/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/a.py
diff --git a/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner/b.py b/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner/b.py
diff --git a/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner2/c.py b/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner2/c.py
diff --git a/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner3/d.py b/tests/data/ignore_directory_gitignore_tests/large_ignored_dir_two/inner3/d.py
diff --git a/tests/data/ignore_directory_gitignore_tests/z.py b/tests/data/ignore_directory_gitignore_tests/z.py
diff --git a/tests/test_black.py b/tests/test_black.py
@@ -2537,6 +2537,12 @@ def test_gitignore_that_ignores_subfolders(self) -> None:
         expected = [target / "b.py"]
         assert_collected_sources([target], expected, root=root)
 
+    def test_gitignore_that_ignores_directory(self) -> None:
+        # If gitignore with a directory is in root
+        root = Path(DATA_DIR, "ignore_directory_gitignore_tests")
+        expected = [root / "z.py"]
+        assert_collected_sources([root], expected, root=root)
+
     def test_empty_include(self) -> None:
         path = DATA_DIR / "include_exclude_tests"
         src = [path]