]> git.madduck.net Git - etc/vim.git/blob - docs/compatible_configs.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Mark Primer projects that will change formatting
[etc/vim.git] / docs / compatible_configs.md
1 # _Black_ compatible configurations
2
3 All of Black's changes are harmless (or at least, they should be), but a few do conflict
4 against other tools. It is not uncommon to be using other tools alongside _Black_ like
5 linters and type checkers. Some of them need a bit of tweaking to resolve the conflicts.
6 Listed below are _Black_ compatible configurations in various formats for the common
7 tools out there.
8
9 **Please note** that _Black_ only supports the TOML file format for its configuration
10 (e.g. `pyproject.toml`). The provided examples are to only configure their corresponding
11 tools, using **their** supported file formats.
12
13 ## isort
14
15 [isort](https://pypi.org/p/isort/) helps to sort and format imports in your Python code.
16 _Black_ also formats imports, but in a different way from isort's defaults which leads
17 to conflicting changes.
18
19 ### Configuration
20
21 ```
22 multi_line_output = 3
23 include_trailing_comma = True
24 force_grid_wrap = 0
25 use_parentheses = True
26 ensure_newline_before_comments = True
27 line_length = 88
28 ```
29
30 ### Why those options above?
31
32 _Black_ wraps imports that surpass `line-length` by moving identifiers into their own
33 indented line. If that still doesn't fit the bill, it will put all of them in separate
34 lines and put a trailing comma. A more detailed explanation of this behaviour can be
35 [found here](https://github.com/psf/black#how-black-wraps-lines).
36
37 isort's default mode of wrapping imports that extend past the `line_length` limit is
38 "Grid".
39
40 ```py3
41 from third_party import (lib1, lib2, lib3,
42                          lib4, lib5, ...)
43 ```
44
45 This style is incompatible with _Black_, but isort can be configured to use a different
46 wrapping mode called "Vertical Hanging Indent" which looks like this:
47
48 ```py3
49 from third_party import (
50     lib1,
51     lib2,
52     lib3,
53     lib4,
54 )
55 ```
56
57 This style is _Black_ compatible and can be achieved by `multi-line-output = 3`. Also,
58 as mentioned above, when wrapping long imports _Black_ puts a trailing comma and uses
59 parentheses. isort should follow the same behaviour and passing the options
60 `include_trailing_comma = True` and `use_parentheses = True` configures that.
61
62 The option `force_grid_wrap = 0` is just to tell isort to only wrap imports that surpass
63 the `line_length` limit.
64
65 Finally, isort should be told to wrap imports when they surpass _Black_'s default limit
66 of 88 characters via `line_length = 88` as well as
67 `ensure_newline_before_comments = True` to ensure spacing import sections with comments
68 works the same as with _Black_.
69
70 **Please note** `ensure_newline_before_comments = True` only works since isort >= 5 but
71 does not break older versions so you can keep it if you are running previous versions.
72 If only isort >= 5 is used you can add `profile = black` instead of all the options
73 since [profiles](https://timothycrosley.github.io/isort/docs/configuration/profiles/)
74 are available and do the configuring for you.
75
76 ### Formats
77
78 <details>
79 <summary>.isort.cfg</summary>
80
81 ```cfg
82 [settings]
83 multi_line_output = 3
84 include_trailing_comma = True
85 force_grid_wrap = 0
86 use_parentheses = True
87 ensure_newline_before_comments = True
88 line_length = 88
89 ```
90
91 </details>
92
93 <details>
94 <summary>setup.cfg</summary>
95
96 ```cfg
97 [isort]
98 multi_line_output = 3
99 include_trailing_comma = True
100 force_grid_wrap = 0
101 use_parentheses = True
102 ensure_newline_before_comments = True
103 line_length = 88
104 ```
105
106 </details>
107
108 <details>
109 <summary>pyproject.toml</summary>
110
111 ```toml
112 [tool.isort]
113 multi_line_output = 3
114 include_trailing_comma = true
115 force_grid_wrap = 0
116 use_parentheses = true
117 ensure_newline_before_comments = true
118 line_length = 88
119 ```
120
121 </details>
122
123 <details>
124 <summary>.editorconfig</summary>
125
126 ```ini
127 [*.py]
128 multi_line_output = 3
129 include_trailing_comma = True
130 force_grid_wrap = 0
131 use_parentheses = True
132 ensure_newline_before_comments = True
133 line_length = 88
134 ```
135
136 </details>
137
138 ## Flake8
139
140 [Flake8](https://pypi.org/p/flake8/) is a code linter. It warns you of syntax errors,
141 possible bugs, stylistic errors, etc. For the most part, Flake8 follows
142 [PEP 8](https://www.python.org/dev/peps/pep-0008/) when warning about stylistic errors.
143 There are a few deviations that cause incompatibilities with _Black_.
144
145 ### Configuration
146
147 ```
148 max-line-length = 88
149 extend-ignore = E203, W503
150 ```
151
152 ### Why those options above?
153
154 When breaking a line, _Black_ will break it before a binary operator. This is compliant
155 with PEP 8, but this behaviour will cause flake8 to raise
156 `W503 line break before binary operator` warnings.
157
158 In some cases, as determined by PEP 8, _Black_ will enforce an equal amount of
159 whitespace around slice operators. Due to this, Flake8 will raise
160 `E203 whitespace before ':'` warnings.
161
162 Since both of these warnings are not PEP 8 compliant, Flake8 should be configured to
163 ignore these warnings via `extend-ignore = E203, W503`.
164
165 Also, as like with isort, flake8 should be configured to allow lines up to the length
166 limit of `88`, _Black_'s default. This explains `max-line-length = 88`.
167
168 ### Formats
169
170 <details>
171 <summary>.flake8</summary>
172
173 ```ini
174 [flake8]
175 max-line-length = 88
176 extend-ignore = E203, W503
177 ```
178
179 </details>
180
181 <details>
182 <summary>setup.cfg</summary>
183
184 ```cfg
185 [flake8]
186 max-line-length = 88
187 extend-ignore = E203, W503
188 ```
189
190 </details>
191
192 <details>
193 <summary>tox.ini</summary>
194
195 ```ini
196 [flake8]
197 max-line-length = 88
198 extend-ignore = E203, W503
199 ```
200
201 </details>
202
203 ## Pylint
204
205 [Pylint](https://pypi.org/p/pylint/) is also a code linter like Flake8. It has the same
206 checks as flake8 and more. In particular, it has more formatting checks regarding style
207 conventions like variable naming. With so many checks, Pylint is bound to have some
208 mixed feelings about _Black_'s formatting style.
209
210 ### Configuration
211
212 ```
213 disable = C0330, C0326
214 max-line-length = 88
215 ```
216
217 ### Why those options above?
218
219 When _Black_ is folding very long expressions, the closing brackets will
220 [be dedented](https://github.com/psf/black#how-black-wraps-lines).
221
222 ```py3
223 ImportantClass.important_method(
224     exc, limit, lookup_lines, capture_locals, callback
225 )
226 ```
227
228 Although, this style is PEP 8 compliant, Pylint will raise
229 `C0330: Wrong hanging indentation before block (add 4 spaces)` warnings. Since _Black_
230 isn't configurable on this style, Pylint should be told to ignore these warnings via
231 `disable = C0330`.
232
233 Also, since _Black_ deals with whitespace around operators and brackets, Pylint's
234 warning `C0326: Bad whitespace` should be disabled using `disable = C0326`.
235
236 And as usual, Pylint should be configured to only complain about lines that surpass `88`
237 characters via `max-line-length = 88`.
238
239 ### Formats
240
241 <details>
242 <summary>pylintrc</summary>
243
244 ```ini
245 [MESSAGES CONTROL]
246 disable = C0330, C0326
247
248 [format]
249 max-line-length = 88
250 ```
251
252 </details>
253
254 <details>
255 <summary>setup.cfg</summary>
256
257 ```cfg
258 [pylint]
259 max-line-length = 88
260
261 [pylint.messages_control]
262 disable = C0330, C0326
263 ```
264
265 </details>
266
267 <details>
268 <summary>pyproject.toml</summary>
269
270 ```toml
271 [tool.pylint.messages_control]
272 disable = "C0330, C0326"
273
274 [tool.pylint.format]
275 max-line-length = "88"
276 ```
277
278 </details>