Black (Python) Ignore Rule

Question

I feel Black is doing something not compliant (with my Organisation), so I am trying to ignore certain rules.

Example below and a related link

PEP 8: whitespace before ':'

My Organisation (Coding Standards) does not give priority to what Black feels is right, but wants a way to customise black configurations.

I dont see any mentioned of Ignoring a Rule in Black documentation https://github.com/psf/black#command-line-options.

They have given examples to ignore Flake8 rules, but dont seem to have any documentation for their own product.

score 17 · Answer 1 · edited Jul 11 '23 at 14:43

17

While you can't cherry-pick certain rules to disable, you can skip formatting for individual lines (using # fmt: skip at the end of the line), or for blocks of code (start with # fmt: off and end with # fmt: on)

https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#code-style

And if using PyCharm, here's a guide for skipping certain lines without using the fmt comments: https://godatadriven.com/blog/partial-python-code-formatting-with-black-pycharm/

Edit: implement @kgadek correction

edited Jul 11 '23 at 14:43

joepitz1

194
2
12

answered Nov 21 '21 at 15:19

djangomachine

619
4
15

2

Small correction: you need to wrap a block of code with `# fmt: off` …code-block-here… `# fmt: on` – kgadek May 19 '22 at 16:13

score 9 · Accepted Answer · answered Feb 12 '20 at 13:59

9

You can't customize black. From the readme:

Black reformats entire files in place. It is not configurable.

answered Feb 12 '20 at 13:59

Patrick

674
1
8
22

5

**The Uncompromising Code Formatter**. Indeed. – Jongware Feb 12 '20 at 14:02

Black (Python) Ignore Rule

2 Answers2