Black --exclude argument not excluding desired file(s)

Question

Let's say I have the following python file exclude_from_black.py in the root of my project:

print('I want single quotes')

I'm trying to exclude this file from black reformatting but none of the following commands seem to work:

black --exclude="exclude_from_black.py"
black --exclude="exclude_from_black\.py"
black --exclude="exclude\_from\_black\.py"

According to the Documentation the exclude argument takes a regex. What am I doing something wrong here?

Well, try `r"exclude_from_black\.py"`, but the first should also work. It seems the issue is not with the regex — Wiktor Stribiżew, Nov 15 '19 at 17:51

score 10 · Answer 1 · answered Dec 11 '19 at 14:22

10

I think you should omit the space after --exclude and wrap the regex in /…/.

Try black --exclude '/exclude_from_black\.py/'

Also, for debugging, -v should give some info about which files were excluded.

answered Dec 11 '19 at 14:22

philippbosch

761
5
9

score 8 · Accepted Answer · answered Mar 16 '21 at 05:22

8

Just tried these examples on black==20.8b1 and everything works as expected:

black --check --verbose --exclude="exclude_from_black.py" .
# exclude_from_black.py ignored: matches the --exclude regular expression

black --check --verbose --exclude="exclude_from_black\.py" .
# exclude_from_black.py ignored: matches the --exclude regular expression

answered Mar 16 '21 at 05:22

Johnny Metz

5,977
18
82
146

3

Really should use `--exclude="exclude_from_black\.py"` since it is a regex. – Clayton J Roberts Jan 18 '22 at 17:51

Black --exclude argument not excluding desired file(s)

2 Answers2