]> git.madduck.net Git - etc/vim.git/blob - docs/the_black_code_style.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:

Update CONTRIBUTION.md with pre-commit + black-primer instructions (#1459)
[etc/vim.git] / docs / the_black_code_style.md
1 # The _Black_ code style
2
3 ## Code style
4
5 _Black_ reformats entire files in place. It is not configurable. It doesn't take
6 previous formatting into account. It doesn't reformat blocks that start with
7 `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` have to be on the same level of
8 indentation. It also recognizes [YAPF](https://github.com/google/yapf)'s block comments
9 to the same effect, as a courtesy for straddling code.
10
11 ### How _Black_ wraps lines
12
13 _Black_ ignores previous formatting and applies uniform horizontal and vertical
14 whitespace to your code. The rules for horizontal whitespace can be summarized as: do
15 whatever makes `pycodestyle` happy. The coding style used by _Black_ can be viewed as a
16 strict subset of PEP 8.
17
18 As for vertical whitespace, _Black_ tries to render one full expression or simple
19 statement per line. If this fits the allotted line length, great.
20
21 ```py3
22 # in:
23
24 j = [1,
25      2,
26      3
27 ]
28
29 # out:
30
31 j = [1, 2, 3]
32 ```
33
34 If not, _Black_ will look at the contents of the first outer matching brackets and put
35 that in a separate indented line.
36
37 ```py3
38 # in:
39
40 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
41
42 # out:
43
44 ImportantClass.important_method(
45     exc, limit, lookup_lines, capture_locals, extra_argument
46 )
47 ```
48
49 If that still doesn't fit the bill, it will decompose the internal expression further
50 using the same rule, indenting matching brackets every time. If the contents of the
51 matching brackets pair are comma-separated (like an argument list, or a dict literal,
52 and so on) then _Black_ will first try to keep them on the same line with the matching
53 brackets. If that doesn't work, it will put all of them in separate lines.
54
55 ```py3
56 # in:
57
58 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
59     """Applies `variables` to the `template` and writes to `file`."""
60     with open(file, 'w') as f:
61         ...
62
63 # out:
64
65 def very_important_function(
66     template: str,
67     *variables,
68     file: os.PathLike,
69     engine: str,
70     header: bool = True,
71     debug: bool = False,
72 ):
73     """Applies `variables` to the `template` and writes to `file`."""
74     with open(file, "w") as f:
75         ...
76 ```
77
78 _Black_ prefers parentheses over backslashes, and will remove backslashes if found.
79
80 ```py3
81 # in:
82
83 if some_short_rule1 \
84   and some_short_rule2:
85       ...
86
87 # out:
88
89 if some_short_rule1 and some_short_rule2:
90   ...
91
92
93 # in:
94
95 if some_long_rule1 \
96   and some_long_rule2:
97     ...
98
99 # out:
100
101 if (
102     some_long_rule1
103     and some_long_rule2
104 ):
105     ...
106
107 ```
108
109 Backslashes and multiline strings are one of the two places in the Python grammar that
110 break significant indentation. You never need backslashes, they are used to force the
111 grammar to accept breaks that would otherwise be parse errors. That makes them confusing
112 to look at and brittle to modify. This is why _Black_ always gets rid of them.
113
114 If you're reaching for backslashes, that's a clear signal that you can do better if you
115 slightly refactor your code. I hope some of the examples above show you that there are
116 many ways in which you can do it.
117
118 However there is one exception: `with` statements using multiple context managers.
119 Python's grammar does not allow organizing parentheses around the series of context
120 managers.
121
122 We don't want formatting like:
123
124 ```py3
125 with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4:
126     ...  # nothing to split on - line too long
127 ```
128
129 So _Black_ will now format it like this:
130
131 ```py3
132 with \
133      make_context_manager(1) as cm1, \
134      make_context_manager(2) as cm2, \
135      make_context_manager(3) as cm3, \
136      make_context_manager(4) as cm4 \
137 :
138     ...  # backslashes and an ugly stranded colon
139 ```
140
141 You might have noticed that closing brackets are always dedented and that a trailing
142 comma is always added. Such formatting produces smaller diffs; when you add or remove an
143 element, it's always just one line. Also, having the closing bracket dedented provides a
144 clear delimiter between two distinct sections of the code that otherwise share the same
145 indentation level (like the arguments list and the docstring in the example above).
146
147 If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot
148 fit in the allotted length, it's always split into one element per line. This minimizes
149 diffs as well as enables readers of code to find which commit introduced a particular
150 entry. This also makes _Black_ compatible with [isort](https://pypi.org/p/isort/) with
151 the following configuration.
152
153 <details>
154 <summary>A compatible `.isort.cfg`</summary>
155
156 ```
157 [settings]
158 multi_line_output=3
159 include_trailing_comma=True
160 force_grid_wrap=0
161 use_parentheses=True
162 line_length=88
163 ```
164
165 The equivalent command line is:
166
167 ```
168 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
169 ```
170
171 </details>
172
173 ### Line length
174
175 You probably noticed the peculiar default line length. _Black_ defaults to 88 characters
176 per line, which happens to be 10% over 80. This number was found to produce
177 significantly shorter files than sticking with 80 (the most popular), or even 79 (used
178 by the standard library). In general,
179 [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
180
181 If you're paid by the line of code you write, you can pass `--line-length` with a lower
182 number. _Black_ will try to respect that. However, sometimes it won't be able to without
183 breaking other rules. In those rare cases, auto-formatted code will exceed your allotted
184 limit.
185
186 You can also increase it, but remember that people with sight disabilities find it
187 harder to work with line lengths exceeding 100 characters. It also adversely affects
188 side-by-side diff review on typical screen resolutions. Long lines also make it harder
189 to present code neatly in documentation or talk slides.
190
191 If you're using Flake8, you can bump `max-line-length` to 88 and forget about it.
192 Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s B950 warning
193 instead of E501 and keep the max line length at 80 which you are probably already using.
194 You'd do it like this:
195
196 ```ini
197 [flake8]
198 max-line-length = 80
199 ...
200 select = C,E,F,W,B,B950
201 ignore = E203, E501, W503
202 ```
203
204 You'll find _Black_'s own .flake8 config file is configured like this. Explanation of
205 why W503 and E203 are disabled can be found further in this documentation. And if you're
206 curious about the reasoning behind B950,
207 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
208 explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you
209 overdo it by a few km/h".
210
211 **If you're looking for a minimal, black-compatible flake8 configuration:**
212
213 ```ini
214 [flake8]
215 max-line-length = 88
216 extend-ignore = E203
217 ```
218
219 ### Empty lines
220
221 _Black_ avoids spurious vertical whitespace. This is in the spirit of PEP 8 which says
222 that in-function vertical whitespace should only be used sparingly.
223
224 _Black_ will allow single empty lines inside functions, and single and double empty
225 lines on module level left by the original editors, except when they're within
226 parenthesized expressions. Since such expressions are always reformatted to fit minimal
227 space, this whitespace is lost.
228
229 It will also insert proper spacing before and after function definitions. It's one line
230 before and after inner functions and two lines before and after module-level functions
231 and classes. _Black_ will not put empty lines between function/class definitions and
232 standalone comments that immediately precede the given function/class.
233
234 _Black_ will enforce single empty lines between a class-level docstring and the first
235 following field or method. This conforms to
236 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
237
238 _Black_ won't insert empty lines after function docstrings unless that empty line is
239 required due to an inner function starting immediately after.
240
241 ### Trailing commas
242
243 _Black_ will add trailing commas to expressions that are split by comma where each
244 element is on its own line. This includes function signatures.
245
246 Unnecessary trailing commas are removed if an expression fits in one line. This makes it
247 1% more likely that your line won't exceed the allotted line length limit. Moreover, in
248 this scenario, if you added another argument to your call, you'd probably fit it in the
249 same line anyway. That doesn't make diffs any larger.
250
251 One exception to removing trailing commas is tuple expressions with just one element. In
252 this case _Black_ won't touch the single trailing comma as this would unexpectedly
253 change the underlying data type. Note that this is also the case when commas are used
254 while indexing. This is a tuple in disguise: `numpy_array[3, ]`.
255
256 One exception to adding trailing commas is function signatures containing `*`, `*args`,
257 or `**kwargs`. In this case a trailing comma is only safe to use on Python 3.6. _Black_
258 will detect if your file is already 3.6+ only and use trailing commas in this situation.
259 If you wonder how it knows, it looks for f-strings and existing use of trailing commas
260 in function signatures that have stars in them. In other words, if you'd like a trailing
261 comma in this situation and _Black_ didn't recognize it was safe to do so, put it there
262 manually and _Black_ will keep it.
263
264 ### Strings
265
266 _Black_ prefers double quotes (`"` and `"""`) over single quotes (`'` and `'''`). It
267 will replace the latter with the former as long as it does not result in more backslash
268 escapes than before.
269
270 _Black_ also standardizes string prefixes, making them always lowercase. On top of that,
271 if your code is already Python 3.6+ only or it's using the `unicode_literals` future
272 import, _Black_ will remove `u` from the string prefix as it is meaningless in those
273 scenarios.
274
275 The main reason to standardize on a single form of quotes is aesthetics. Having one kind
276 of quotes everywhere reduces reader distraction. It will also enable a future version of
277 _Black_ to merge consecutive string literals that ended up on the same line (see
278 [#26](https://github.com/psf/black/issues/26) for details).
279
280 Why settle on double quotes? They anticipate apostrophes in English text. They match the
281 docstring standard described in
282 [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). An empty
283 string in double quotes (`""`) is impossible to confuse with a one double-quote
284 regardless of fonts and syntax highlighting used. On top of this, double quotes for
285 strings are consistent with C which Python interacts a lot with.
286
287 On certain keyboard layouts like US English, typing single quotes is a bit easier than
288 double quotes. The latter requires use of the Shift key. My recommendation here is to
289 keep using whatever is faster to type and let _Black_ handle the transformation.
290
291 If you are adopting _Black_ in a large project with pre-existing string conventions
292 (like the popular
293 ["single quotes for data, double quotes for human-readable strings"](https://stackoverflow.com/a/56190)),
294 you can pass `--skip-string-normalization` on the command line. This is meant as an
295 adoption helper, avoid using this for new projects.
296
297 ### Numeric literals
298
299 _Black_ standardizes most numeric literals to use lowercase letters for the syntactic
300 parts and uppercase letters for the digits themselves: `0xAB` instead of `0XAB` and
301 `1e10` instead of `1E10`. Python 2 long literals are styled as `2L` instead of `2l` to
302 avoid confusion between `l` and `1`.
303
304 ### Line breaks & binary operators
305
306 _Black_ will break a line before a binary operator when splitting a block of code over
307 multiple lines. This is so that _Black_ is compliant with the recent changes in the
308 [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
309 style guide, which emphasizes that this approach improves readability.
310
311 This behaviour may raise `W503 line break before binary operator` warnings in style
312 guide enforcement tools like Flake8. Since `W503` is not PEP 8 compliant, you should
313 tell Flake8 to ignore these warnings.
314
315 ### Slices
316
317 PEP 8
318 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
319 to treat `:` in slices as a binary operator with the lowest priority, and to leave an
320 equal amount of space on either side, except if a parameter is omitted (e.g.
321 `ham[1 + 1 :]`). It recommends no spaces around `:` operators for "simple expressions"
322 (`ham[lower:upper]`), and extra space for "complex expressions"
323 (`ham[lower : upper + offset]`). _Black_ treats anything more than variable names as
324 "complex" (`ham[lower : upper + 1]`). It also states that for extended slices, both `:`
325 operators have to have the same amount of spacing, except if a parameter is omitted
326 (`ham[1 + 1 ::]`). _Black_ enforces these rules consistently.
327
328 This behaviour may raise `E203 whitespace before ':'` warnings in style guide
329 enforcement tools like Flake8. Since `E203` is not PEP 8 compliant, you should tell
330 Flake8 to ignore these warnings.
331
332 ### Parentheses
333
334 Some parentheses are optional in the Python grammar. Any expression can be wrapped in a
335 pair of parentheses to form an atom. There are a few interesting cases:
336
337 - `if (...):`
338 - `while (...):`
339 - `for (...) in (...):`
340 - `assert (...), (...)`
341 - `from X import (...)`
342 - assignments like:
343   - `target = (...)`
344   - `target: type = (...)`
345   - `some, *un, packing = (...)`
346   - `augmented += (...)`
347
348 In those cases, parentheses are removed when the entire statement fits in one line, or
349 if the inner expression doesn't have any delimiters to further split on. If there is
350 only a single delimiter and the expression starts or ends with a bracket, the
351 parenthesis can also be successfully omitted since the existing bracket pair will
352 organize the expression neatly anyway. Otherwise, the parentheses are added.
353
354 Please note that _Black_ does not add or remove any additional nested parentheses that
355 you might want to have for clarity or further code organization. For example those
356 parentheses are not going to be removed:
357
358 ```py3
359 return not (this or that)
360 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
361 ```
362
363 ### Call chains
364
365 Some popular APIs, like ORMs, use call chaining. This API style is known as a
366 [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface). _Black_ formats
367 those by treating dots that follow a call or an indexing operation like a very low
368 priority delimiter. It's easier to show the behavior than to explain it. Look at the
369 example:
370
371 ```py3
372 def example(session):
373     result = (
374         session.query(models.Customer.id)
375         .filter(
376             models.Customer.account_id == account_id,
377             models.Customer.email == email_address,
378         )
379         .order_by(models.Customer.id.asc())
380         .all()
381     )
382 ```
383
384 ### Typing stub files
385
386 PEP 484 describes the syntax for type hints in Python. One of the use cases for typing
387 is providing type annotations for modules which cannot contain them directly (they might
388 be written in C, or they might be third-party, or their implementation may be overly
389 dynamic, and so on).
390
391 To solve this,
392 [stub files with the `.pyi` file extension](https://www.python.org/dev/peps/pep-0484/#stub-files)
393 can be used to describe typing information for an external module. Those stub files omit
394 the implementation of classes and functions they describe, instead they only contain the
395 structure of the file (listing globals, functions, and classes with their members). The
396 recommended code style for those files is more terse than PEP 8:
397
398 - prefer `...` on the same line as the class/function signature;
399 - avoid vertical whitespace between consecutive module-level functions, names, or
400   methods and fields within a single class;
401 - use a single blank line between top-level class definitions, or none if the classes
402   are very small.
403
404 _Black_ enforces the above rules. There are additional guidelines for formatting `.pyi`
405 file that are not enforced yet but might be in a future version of the formatter:
406
407 - all function bodies should be empty (contain `...` instead of the body);
408 - do not use docstrings;
409 - prefer `...` over `pass`;
410 - for arguments with a default, use `...` instead of the actual default;
411 - avoid using string literals in type annotations, stub files support forward references
412   natively (like Python 3.7 code with `from __future__ import annotations`);
413 - use variable annotations instead of type comments, even for stubs that target older
414   versions of Python;
415 - for arguments that default to `None`, use `Optional[]` explicitly;
416 - use `float` instead of `Union[int, float]`.
417
418 ## Pragmatism
419
420 Early versions of _Black_ used to be absolutist in some respects. They took after its
421 initial author. This was fine at the time as it made the implementation simpler and
422 there were not many users anyway. Not many edge cases were reported. As a mature tool,
423 _Black_ does make some exceptions to rules it otherwise holds. This section documents
424 what those exceptions are and why this is the case.
425
426 ### The magic trailing comma
427
428 _Black_ in general does not take existing formatting into account.
429
430 However, there are cases where you put a short collection or function call in your code
431 but you anticipate it will grow in the future.
432
433 For example:
434
435 ```py3
436 TRANSLATIONS = {
437     "en_us": "English (US)",
438     "pl_pl": "polski",
439 }
440 ```
441
442 Early versions of _Black_ used to ruthlessly collapse those into one line (it fits!).
443 Now, you can communicate that you don't want that by putting a trailing comma in the
444 collection yourself. When you do, _Black_ will know to always explode your collection
445 into one item per line.
446
447 How do you make it stop? Just delete that trailing comma and _Black_ will collapse your
448 collection into one line if it fits.
449
450 ### r"strings" and R"strings"
451
452 _Black_ normalizes string quotes as well as string prefixes, making them lowercase. One
453 exception to this rule is r-strings. It turns out that the very popular
454 [MagicPython](https://github.com/MagicStack/MagicPython/) syntax highlighter, used by
455 default by (among others) GitHub and Visual Studio Code, differentiates between
456 r-strings and R-strings. The former are syntax highlighted as regular expressions while
457 the latter are treated as true raw strings with no special semantics.