Provide a stdin-filename to allow stdin to respect force-exclude rules

[bellini666]

Fix #1776

[ichard26]

Thanks for the PR @bellini666!

Please update the help output that is in the README, add a test as this is a new feature, and see my other comments below.

Also, personally I find the option name of stdin-filename a bit too specific as you can pass a full absolute filepath. That could be useful for cases where the filename isn't excluded, but its containing directory is excluded. Passing filepaths does break when they would point outside of the current working directory but I dunno how much of an issue that is.

[bellini666]

@ichard26 I have fixed your comments and also added some tests for the new functionality!

[bellini666]

@hugovk I tried requesting your review again by clicking in the Re-request review next to you on the reviewers section, but for some reason it is not working. Just pinging you here then to say that your suggestions were applied.

[hugovk]

OK, thanks! That wording looks fine now, I'll leave the functionality to the maintainers to review 👍

[ichard26]

README looks good and well done on the tests!

Unfortunately I found another edge case where Black incorrectly uses format_file_in_place.

[ichard26]

I completely forgot but please also add an entry in the change log, thank you!
^{I really need to have a PR review checklist . . .}

[hugovk]

I really need to have a PR review checklist . . .

Or put it in a PR template?
https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository

[bellini666]

@ichard26 ok, everything should be fine now :)

[cooperlees]

Thanks! Nice addition. Would love @ichard26 to check it one last time before merge tho since they have the most context.

[ichard26]

FYI, I plan on reviewing this soon (as in probably tomorrow).

[ichard26]

Overall these changes look good other than the additional bug I found.

Many thanks for working on this!

[bellini666]

@ichard26 after applying the suggestions (8d13a9c) some tests broke.

I wasn't able to check it yet, but looking at the commit now, wouldn't that if not is_stdin or p.is_dir(): force to enter the p.is_for() block even if it was supposed to go the the p.is_file() when is_stdin is False? Maybe that line should still be if p.is_dir() alone

[ichard26]

You're correct, my bad. Uh perhaps this patch should work.

diff --git a/src/black/__init__.py b/src/black/__init__.py
index 7594cce..0850b11 100644
--- a/src/black/__init__.py
+++ b/src/black/__init__.py
@@ -633,19 +633,7 @@ def get_sources(
             p = Path(s)
             is_stdin = False
 
-        if not is_stdin or p.is_dir():
-            sources.update(
-                gen_python_files(
-                    p.iterdir(),
-                    root,
-                    include_regex,
-                    exclude_regex,
-                    force_exclude_regex,
-                    report,
-                    gitignore,
-                )
-            )
-        elif is_stdin or p.is_file():
+        if is_stdin or p.is_file():
             normalized_path = normalize_path_maybe_ignore(p, root, report)
             if normalized_path is None:
                 continue
@@ -664,6 +652,18 @@ def get_sources(
                 p = Path(f"{STDIN_PLACEHOLDER}{str(p)}")
 
             sources.add(p)
+        elif p.is_dir():
+            sources.update(
+                gen_python_files(
+                    p.iterdir(),
+                    root,
+                    include_regex,
+                    exclude_regex,
+                    force_exclude_regex,
+                    report,
+                    gitignore,
+                )
+            )
         elif s == "-":
             sources.add(p)
         else:

Didn't give much thought into whether this should work. Tests do pass though. If p is an existing file it will go through the right block. Same thing if --stdin-filename is used regardless if a file or a directory actually exists at the path. If p is an existing directory, well then is_stdin and p.is_file() will be False and the p.is_dir() check will pass. If STDIN mode is used but without --stdin-filename, the elif s == "-" will catch that. Please check this manually before pushing though.

[bellini666]

@ichard26 that suggestion worked fine! Just pushed it

[cooperlees]

Awesome work all! Thanks for your addition to black!