Hello, we’re integrating black with pants in a django project and we want all the migrations file to be skipped from black… we already have in our

pyproject.toml

the following:

exclude = '''
/(
  | \.git
  | \.mypy_cache
  | \.venv
  | migrations
  | protos
)/
'''

but running

./pants lint ::

it does not skip them (while running

black .

it does). We also tried writing the following in the root BUILD file:

python_sources(
    name="migrations",
    skip_black=True,
    sources=["**/migrations/*.py"]
)

but it didn’t work. We know we can put the

skip_black=True

in each of the

BUILD

files inside all

migrations

folders but this would require us to add it every time we have a new

migrations

folder, which is a bit of a pain. Can you help us?

The issue, I think, is Black doesn't respect

exclude

if you provide filenames to the cmd. I think they added a

force-exclude

option for this?

if you’re using Pants >= 2.14, you could use

__defaults__

to set

skip_black=True

for all of your migrations

@sparse-lifeguard-95737 The fact is we have a lot of folders containing a

migrations

sub_folder

ah, hrm

@bitter-ability-32190 thanks for the hint we’ll try

FWIW you'll be doing some wasted work here, invoking Pants to run black and black then no-ops, but 🤷‍♂️

true that, do you know if there is a way to write some defaults in the root build file to skip them?

Hmmmmmmmmm

ok thanks

I think you could get away with excludes and pants aliases..

# pants.toml
[cli.alias]
exclude-migrations = "!src/apps/foo/migrations:: !src/apps/bar/migrations::"

Then when formatting:

./pants fmt exclude-migrations src/apps::

What you had could work;

python_sources(
    name="migrations",
    skip_black=True,
    sources=["**/migrations/*.py"]
)

but I’m guessing that you also have another

python_sources

that also globs over the migrations?

We also have some BUILD files created by

./pants tailor

in all of the

migrations

folders and all of them contains a

python_sources()

so I guess they all override it, am I correct?

That would work, yes. And since that higher-level

migrations

target would cover new migration dirs as well, tailor wouldn’t generate new BUILD files for those new migrations

Great thanks a lot