exclude files/directories, how?

[jedie]

black normal respects .gitignore it seems that with darker this is not the case, isn't it?

How to exclude files?

[akaihola]

In #171 and #215 we added some support for respecting Black exclusions. But apparently .gitignore was missed there?!?

Thanks for the report, I'll try to reproduce, and this needs to be fixed for sure.

[akaihola]

Ok, I can't reproduce this on Darker 1.3.2. If I create the file ./src/ignored_file.py in a Git repository with these contents:

a = 2
b  =  5

and run darker --diff src, I get

--- darker/ignored_file.py	2022-02-06 17:30:51.041694 +0000
+++ darker/ignored_file.py	2022-02-06 17:31:14.314713 +0000
@@ -1,2 +1,2 @@
 a = 2
-b  =  5
+b = 5

If I then add ignored_file.py to ./.gitignore and run darker --diff src again, I don't get any output.

Does this differ from the behavior on your system @jedie?

[jedie]

Currently i have the same troubles with darker 1.7.2 (and black==23.7.0)

Now i have a project with a test project using docker compose. The problem: I add "volumes" direct in the root of the project. The .gitignore contains /volumes/ to exclude the whole directory tree. But black tries to access them, e.g.:

Traceback (most recent call last):
  File "/home/jens/toniecloud/django-huey-monitor/.venv/bin/darker", line 8, in <module>
    sys.exit(main_with_error_handling())
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/darker/__main__.py", line 631, in main_with_error_handling
    return main()
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/darker/__main__.py", line 562, in main
    files_to_process = filter_python_files(paths, root, {})
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/darker/black_diff.py", line 164, in filter_python_files
    files_from_directories = set(
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/black/files.py", line 375, in gen_python_files
    yield from gen_python_files(
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/black/files.py", line 375, in gen_python_files
    yield from gen_python_files(
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/black/files.py", line 375, in gen_python_files
    yield from gen_python_files(
  [Previous line repeated 1 more time]
  File "/home/jens/toniecloud/django-huey-monitor/.venv/lib/python3.10/site-packages/black/files.py", line 335, in gen_python_files
    for child in paths:
  File "/usr/lib/python3.10/pathlib.py", line 1017, in iterdir
    for name in self._accessor.listdir(self):
PermissionError: [Errno 13] Permission denied: '/home/jens/toniecloud/django-huey-monitor/volumes/postgresql/data'

For debuggin i add a pprint(locals()) into darker.black_diff.filter_python_files() just before calling black.files.gen_python_files() here:

darker/src/darker/black_diff.py

Line 163 in e96018f

files_from_directories = set(

Looks like:

{'absolute_paths': {PosixPath('/home/jens/toniecloud/django-huey-monitor')},
 'black_config': {},
 'directories': {PosixPath('/home/jens/toniecloud/django-huey-monitor')},
 'files': set(),
 'kwargs': {'gitignore_dict': None, 'quiet': False, 'verbose': False},
 'param': 'quiet',
 'paths': {PosixPath('.')},
 'pprint': <function pprint at 0x7fd4cf9baa70>,
 'root': PosixPath('/home/jens/toniecloud/django-huey-monitor'),
 'sig': <Signature (paths: Iterable[pathlib.Path], root: pathlib.Path, include: Pattern[str], exclude: Pattern[str], extend_exclude: Optional[Pattern[str]], force_exclude: Optional[Pattern[str]], report: black.report.Report, gitignore_dict: Optional[Dict[pathlib.Path, pathspec.pathspec.PathSpec]], *, verbose: bool, quiet: bool) -> Iterator[pathlib.Path]>}

So gen_python_files() will be called with gitignore_dict=None
I also hacked into black.files.gen_python_files() and print gitignore_dict: On every call it's None
There is a comment in gen_python_files():

If gitignore is None, gitignore usage is disabled

I add a print into black.files.get_gitignore() and this function will be never called.

So i assume my .gitignore file will be not used.

Think the fix is very easy: Just call gen_python_files() with gitignore_dict={} instead of gitignore_dict=None -> #515