Ignoring Django Migrations in pyproject.toml file for Black formatter

Question

I just got Black and Pre-Commit set up for my Django repository.

I used the default config for Black from the tutorial I followed and it's been working great, but I am having trouble excluding my migrations files from it.

Here is the default configuration I've been using:

pyproject.toml

[tool.black]
line-length = 79
include = '\.pyi?$'
exclude = '''
/(
    \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

I used Regex101.com to make sure that ^.*\b(migrations)\b.*$ matched apps/examples/migrations/test.py.

[tool.black]
line-length = 79
include = '\.pyi?$'
exclude = '''
/(
    \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
  | ^.*\b(migrations)\b.*$
)/
'''

When I add that regex line to my config file, and run pre-commit run --all-files, it ignores the .git folder but still formats the migrations files.

@ClarkSandholtz why are you not accepting any of the answer, or explain why they don't work for you? — sinoroc, Dec 20 '20 at 11:47
@sinoroc the formatting of the migrations ended up not being that big of a deal, so I just didn't worry about fixing it for awhile. Sorry for being slow on this. — Clark Sandholtz, Dec 31 '20 at 16:26

score 19 · Accepted Answer · edited Dec 19 '20 at 19:46

19

Add the migration exclusion to your .pre-commit-config.yaml file

- id: black
  exclude: ^.*\b(migrations)\b.*$

edited Dec 19 '20 at 19:46

anthony sottile

61,815
15
148
207

answered Sep 11 '20 at 05:38

Antony Orenge

439
5
8

There is a reason to configure your tools in pyproject.toml (and others) instead of `pre-commit`'s config: you wan't to configure them in one place and have it working in your IDE/CLI/whatever and not just in `pre-commit`. – smido Apr 11 '23 at 10:00

score 9 · Answer 2 · answered Sep 20 '20 at 18:39

9

That's the solution to the problem: pyproject.toml

[tool.black]
exclude = '''
/(
  | migrations
)/

'''

answered Sep 20 '20 at 18:39

Elinaldo Monteiro

725
9
13

Can you pass the documentation on where you take this syntax under the exclude option? Is this part of TOML language or black? Couldn't find it in Black docs... – tikej Jun 07 '21 at 18:07
Sorry, I don't remember where I got this, it was already in my project :( – Elinaldo Monteiro Jun 08 '21 at 12:54

score 2 · Answer 3 · answered Mar 24 '20 at 22:57

2

Try this (note last line):

[tool.black]
line-length = 79
include = '\.pyi?$'
exclude = '''
/(
    \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
  | migrations
)/
'''

answered Mar 24 '20 at 22:57

tee

4,149
1
32
44

score 2 · Answer 4 · answered Mar 15 '21 at 21:08

Maintaining two different places for exclude config doesn't look good if avoidable and will not work well for the CI either (should you want to dry run black in the PR checks). Adding the following works for the pyproject.toml and then you can run the same in the pre-commit hook and CI:

[tool.black]
...
exclude = '''

(
  /(
    ...
    | .+/migrations
  )/
)
'''

score 1 · Answer 5 · answered Aug 11 '22 at 09:42

1

to just extend the default exlusions (without adding the whole list), you can just do:

[tool.black]
extend-exclude = '''
/(
  | migrations
)/
'''

answered Aug 11 '22 at 09:42

fvmac

11
2

Ignoring Django Migrations in pyproject.toml file for Black formatter

5 Answers5