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

Document black-jupyter hook (#3650)
[etc/vim.git] / docs / the_black_code_style / current_style.md
1 # The _Black_ code style
2
3 ## Code style
4
5 _Black_ aims for consistency, generality, readability and reducing git diffs. Similar
6 language constructs are formatted with similar rules. Style configuration options are
7 deliberately limited and rarely added. Previous formatting is taken into account as
8 little as possible, with rare exceptions like the magic trailing comma. The coding style
9 used by _Black_ can be viewed as a strict subset of PEP 8.
10
11 _Black_ reformats entire files in place. It doesn't reformat lines that end with
12 `# fmt: skip` or blocks that start with `# fmt: off` and end with `# fmt: on`.
13 `# fmt: on/off` must be on the same level of indentation and in the same block, meaning
14 no unindents beyond the initial indentation level between them. It also recognizes
15 [YAPF](https://github.com/google/yapf)'s block comments to the same effect, as a
16 courtesy for straddling code.
17
18 The rest of this document describes the current formatting style. If you're interested
19 in trying out where the style is heading, see [future style](./future_style.md) and try
20 running `black --preview`.
21
22 ### How _Black_ wraps lines
23
24 _Black_ ignores previous formatting and applies uniform horizontal and vertical
25 whitespace to your code. The rules for horizontal whitespace can be summarized as: do
26 whatever makes `pycodestyle` happy.
27
28 As for vertical whitespace, _Black_ tries to render one full expression or simple
29 statement per line. If this fits the allotted line length, great.
30
31 ```py3
32 # in:
33
34 j = [1,
35      2,
36      3
37 ]
38
39 # out:
40
41 j = [1, 2, 3]
42 ```
43
44 If not, _Black_ will look at the contents of the first outer matching brackets and put
45 that in a separate indented line.
46
47 ```py3
48 # in:
49
50 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
51
52 # out:
53
54 ImportantClass.important_method(
55     exc, limit, lookup_lines, capture_locals, extra_argument
56 )
57 ```
58
59 If that still doesn't fit the bill, it will decompose the internal expression further
60 using the same rule, indenting matching brackets every time. If the contents of the
61 matching brackets pair are comma-separated (like an argument list, or a dict literal,
62 and so on) then _Black_ will first try to keep them on the same line with the matching
63 brackets. If that doesn't work, it will put all of them in separate lines.
64
65 ```py3
66 # in:
67
68 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
69     """Applies `variables` to the `template` and writes to `file`."""
70     with open(file, 'w') as f:
71         ...
72
73 # out:
74
75 def very_important_function(
76     template: str,
77     *variables,
78     file: os.PathLike,
79     engine: str,
80     header: bool = True,
81     debug: bool = False,
82 ):
83     """Applies `variables` to the `template` and writes to `file`."""
84     with open(file, "w") as f:
85         ...
86 ```
87
88 If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot
89 fit in the allotted length, it's always split into one element per line. This minimizes
90 diffs as well as enables readers of code to find which commit introduced a particular
91 entry. This also makes _Black_ compatible with
92 [isort](../guides/using_black_with_other_tools.md#isort) with the ready-made `black`
93 profile or manual configuration.
94
95 You might have noticed that closing brackets are always dedented and that a trailing
96 comma is always added. Such formatting produces smaller diffs; when you add or remove an
97 element, it's always just one line. Also, having the closing bracket dedented provides a
98 clear delimiter between two distinct sections of the code that otherwise share the same
99 indentation level (like the arguments list and the docstring in the example above).
100
101 (labels/why-no-backslashes)=
102
103 _Black_ prefers parentheses over backslashes, and will remove backslashes if found.
104
105 ```py3
106 # in:
107
108 if some_short_rule1 \
109   and some_short_rule2:
110       ...
111
112 # out:
113
114 if some_short_rule1 and some_short_rule2:
115   ...
116
117
118 # in:
119
120 if some_long_rule1 \
121   and some_long_rule2:
122     ...
123
124 # out:
125
126 if (
127     some_long_rule1
128     and some_long_rule2
129 ):
130     ...
131
132 ```
133
134 Backslashes and multiline strings are one of the two places in the Python grammar that
135 break significant indentation. You never need backslashes, they are used to force the
136 grammar to accept breaks that would otherwise be parse errors. That makes them confusing
137 to look at and brittle to modify. This is why _Black_ always gets rid of them.
138
139 If you're reaching for backslashes, that's a clear signal that you can do better if you
140 slightly refactor your code. I hope some of the examples above show you that there are
141 many ways in which you can do it.
142
143 ### Line length
144
145 You probably noticed the peculiar default line length. _Black_ defaults to 88 characters
146 per line, which happens to be 10% over 80. This number was found to produce
147 significantly shorter files than sticking with 80 (the most popular), or even 79 (used
148 by the standard library). In general,
149 [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
150
151 If you're paid by the line of code you write, you can pass `--line-length` with a lower
152 number. _Black_ will try to respect that. However, sometimes it won't be able to without
153 breaking other rules. In those rare cases, auto-formatted code will exceed your allotted
154 limit.
155
156 You can also increase it, but remember that people with sight disabilities find it
157 harder to work with line lengths exceeding 100 characters. It also adversely affects
158 side-by-side diff review on typical screen resolutions. Long lines also make it harder
159 to present code neatly in documentation or talk slides.
160
161 If you're using Flake8, you can bump `max-line-length` to 88 and mostly forget about it.
162 However, it's better if you use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
163 B950 warning instead of E501, and bump the max line length to 88 (or the `--line-length`
164 you used for black), which will align more with black's _"try to respect
165 `--line-length`, but don't become crazy if you can't"_. You'd do it like this:
166
167 ```ini
168 [flake8]
169 max-line-length = 88
170 ...
171 select = C,E,F,W,B,B950
172 extend-ignore = E203, E501
173 ```
174
175 Explanation of why E203 is disabled can be found further in this documentation. And if
176 you're curious about the reasoning behind B950,
177 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
178 explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you
179 overdo it by a few km/h".
180
181 **If you're looking for a minimal, black-compatible flake8 configuration:**
182
183 ```ini
184 [flake8]
185 max-line-length = 88
186 extend-ignore = E203
187 ```
188
189 ### Empty lines
190
191 _Black_ avoids spurious vertical whitespace. This is in the spirit of PEP 8 which says
192 that in-function vertical whitespace should only be used sparingly.
193
194 _Black_ will allow single empty lines inside functions, and single and double empty
195 lines on module level left by the original editors, except when they're within
196 parenthesized expressions. Since such expressions are always reformatted to fit minimal
197 space, this whitespace is lost. The other exception is that it will remove any empty
198 lines immediately following a statement that introduces a new indentation level.
199
200 ```python
201 # in:
202
203 def foo():
204
205     print("All the newlines above me should be deleted!")
206
207
208 if condition:
209
210     print("No newline above me!")
211
212     print("There is a newline above me, and that's OK!")
213
214
215 class Point:
216
217     x: int
218     y: int
219
220 # out:
221
222 def foo():
223     print("All the newlines above me should be deleted!")
224
225
226 if condition:
227     print("No newline above me!")
228
229     print("There is a newline above me, and that's OK!")
230
231
232 class Point:
233     x: int
234     y: int
235 ```
236
237 It will also insert proper spacing before and after function definitions. It's one line
238 before and after inner functions and two lines before and after module-level functions
239 and classes. _Black_ will not put empty lines between function/class definitions and
240 standalone comments that immediately precede the given function/class.
241
242 _Black_ will enforce single empty lines between a class-level docstring and the first
243 following field or method. This conforms to
244 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
245
246 _Black_ won't insert empty lines after function docstrings unless that empty line is
247 required due to an inner function starting immediately after.
248
249 ### Comments
250
251 _Black_ does not format comment contents, but it enforces two spaces between code and a
252 comment on the same line, and a space before the comment text begins. Some types of
253 comments that require specific spacing rules are respected: doc comments (`#: comment`),
254 section comments with long runs of hashes, and Spyder cells. Non-breaking spaces after
255 hashes are also preserved. Comments may sometimes be moved because of formatting
256 changes, which can break tools that assign special meaning to them. See
257 [AST before and after formatting](#ast-before-and-after-formatting) for more discussion.
258
259 ### Trailing commas
260
261 _Black_ will add trailing commas to expressions that are split by comma where each
262 element is on its own line. This includes function signatures.
263
264 One exception to adding trailing commas is function signatures containing `*`, `*args`,
265 or `**kwargs`. In this case a trailing comma is only safe to use on Python 3.6. _Black_
266 will detect if your file is already 3.6+ only and use trailing commas in this situation.
267 If you wonder how it knows, it looks for f-strings and existing use of trailing commas
268 in function signatures that have stars in them. In other words, if you'd like a trailing
269 comma in this situation and _Black_ didn't recognize it was safe to do so, put it there
270 manually and _Black_ will keep it.
271
272 A pre-existing trailing comma informs _Black_ to always explode contents of the current
273 bracket pair into one item per line. Read more about this in the
274 [Pragmatism](#pragmatism) section below.
275
276 ### Strings
277
278 _Black_ prefers double quotes (`"` and `"""`) over single quotes (`'` and `'''`). It
279 will replace the latter with the former as long as it does not result in more backslash
280 escapes than before.
281
282 _Black_ also standardizes string prefixes. Prefix characters are made lowercase with the
283 exception of [capital "R" prefixes](#rstrings-and-rstrings), unicode literal markers
284 (`u`) are removed because they are meaningless in Python 3, and in the case of multiple
285 characters "r" is put first as in spoken language: "raw f-string".
286
287 The main reason to standardize on a single form of quotes is aesthetics. Having one kind
288 of quotes everywhere reduces reader distraction. It will also enable a future version of
289 _Black_ to merge consecutive string literals that ended up on the same line (see
290 [#26](https://github.com/psf/black/issues/26) for details).
291
292 Why settle on double quotes? They anticipate apostrophes in English text. They match the
293 docstring standard described in
294 [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). An empty
295 string in double quotes (`""`) is impossible to confuse with a one double-quote
296 regardless of fonts and syntax highlighting used. On top of this, double quotes for
297 strings are consistent with C which Python interacts a lot with.
298
299 On certain keyboard layouts like US English, typing single quotes is a bit easier than
300 double quotes. The latter requires use of the Shift key. My recommendation here is to
301 keep using whatever is faster to type and let _Black_ handle the transformation.
302
303 If you are adopting _Black_ in a large project with pre-existing string conventions
304 (like the popular
305 ["single quotes for data, double quotes for human-readable strings"](https://stackoverflow.com/a/56190)),
306 you can pass `--skip-string-normalization` on the command line. This is meant as an
307 adoption helper, avoid using this for new projects.
308
309 _Black_ also processes docstrings. Firstly the indentation of docstrings is corrected
310 for both quotations and the text within, although relative indentation in the text is
311 preserved. Superfluous trailing whitespace on each line and unnecessary new lines at the
312 end of the docstring are removed. All leading tabs are converted to spaces, but tabs
313 inside text are preserved. Whitespace leading and trailing one-line docstrings is
314 removed.
315
316 ### Numeric literals
317
318 _Black_ standardizes most numeric literals to use lowercase letters for the syntactic
319 parts and uppercase letters for the digits themselves: `0xAB` instead of `0XAB` and
320 `1e10` instead of `1E10`.
321
322 ### Line breaks & binary operators
323
324 _Black_ will break a line before a binary operator when splitting a block of code over
325 multiple lines. This is so that _Black_ is compliant with the recent changes in the
326 [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
327 style guide, which emphasizes that this approach improves readability.
328
329 Almost all operators will be surrounded by single spaces, the only exceptions are unary
330 operators (`+`, `-`, and `~`), and power operators when both operands are simple. For
331 powers, an operand is considered simple if it's only a NAME, numeric CONSTANT, or
332 attribute access (chained attribute access is allowed), with or without a preceding
333 unary operator.
334
335 ```python
336 # For example, these won't be surrounded by whitespace
337 a = x**y
338 b = config.base**5.2
339 c = config.base**runtime.config.exponent
340 d = 2**5
341 e = 2**~5
342
343 # ... but these will be surrounded by whitespace
344 f = 2 ** get_exponent()
345 g = get_x() ** get_y()
346 h = config['base'] ** 2
347 ```
348
349 ### Slices
350
351 PEP 8
352 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
353 to treat `:` in slices as a binary operator with the lowest priority, and to leave an
354 equal amount of space on either side, except if a parameter is omitted (e.g.
355 `ham[1 + 1 :]`). It recommends no spaces around `:` operators for "simple expressions"
356 (`ham[lower:upper]`), and extra space for "complex expressions"
357 (`ham[lower : upper + offset]`). _Black_ treats anything more than variable names as
358 "complex" (`ham[lower : upper + 1]`). It also states that for extended slices, both `:`
359 operators have to have the same amount of spacing, except if a parameter is omitted
360 (`ham[1 + 1 ::]`). _Black_ enforces these rules consistently.
361
362 This behaviour may raise `E203 whitespace before ':'` warnings in style guide
363 enforcement tools like Flake8. Since `E203` is not PEP 8 compliant, you should tell
364 Flake8 to ignore these warnings.
365
366 ### Parentheses
367
368 Some parentheses are optional in the Python grammar. Any expression can be wrapped in a
369 pair of parentheses to form an atom. There are a few interesting cases:
370
371 - `if (...):`
372 - `while (...):`
373 - `for (...) in (...):`
374 - `assert (...), (...)`
375 - `from X import (...)`
376 - assignments like:
377   - `target = (...)`
378   - `target: type = (...)`
379   - `some, *un, packing = (...)`
380   - `augmented += (...)`
381
382 In those cases, parentheses are removed when the entire statement fits in one line, or
383 if the inner expression doesn't have any delimiters to further split on. If there is
384 only a single delimiter and the expression starts or ends with a bracket, the
385 parentheses can also be successfully omitted since the existing bracket pair will
386 organize the expression neatly anyway. Otherwise, the parentheses are added.
387
388 Please note that _Black_ does not add or remove any additional nested parentheses that
389 you might want to have for clarity or further code organization. For example those
390 parentheses are not going to be removed:
391
392 ```py3
393 return not (this or that)
394 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
395 ```
396
397 ### Call chains
398
399 Some popular APIs, like ORMs, use call chaining. This API style is known as a
400 [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface). _Black_ formats
401 those by treating dots that follow a call or an indexing operation like a very low
402 priority delimiter. It's easier to show the behavior than to explain it. Look at the
403 example:
404
405 ```py3
406 def example(session):
407     result = (
408         session.query(models.Customer.id)
409         .filter(
410             models.Customer.account_id == account_id,
411             models.Customer.email == email_address,
412         )
413         .order_by(models.Customer.id.asc())
414         .all()
415     )
416 ```
417
418 ### Typing stub files
419
420 PEP 484 describes the syntax for type hints in Python. One of the use cases for typing
421 is providing type annotations for modules which cannot contain them directly (they might
422 be written in C, or they might be third-party, or their implementation may be overly
423 dynamic, and so on).
424
425 To solve this,
426 [stub files with the `.pyi` file extension](https://www.python.org/dev/peps/pep-0484/#stub-files)
427 can be used to describe typing information for an external module. Those stub files omit
428 the implementation of classes and functions they describe, instead they only contain the
429 structure of the file (listing globals, functions, and classes with their members). The
430 recommended code style for those files is more terse than PEP 8:
431
432 - prefer `...` on the same line as the class/function signature;
433 - avoid vertical whitespace between consecutive module-level functions, names, or
434   methods and fields within a single class;
435 - use a single blank line between top-level class definitions, or none if the classes
436   are very small.
437
438 _Black_ enforces the above rules. There are additional guidelines for formatting `.pyi`
439 file that are not enforced yet but might be in a future version of the formatter:
440
441 - prefer `...` over `pass`;
442 - avoid using string literals in type annotations, stub files support forward references
443   natively (like Python 3.7 code with `from __future__ import annotations`);
444 - use variable annotations instead of type comments, even for stubs that target older
445   versions of Python.
446
447 ### Line endings
448
449 _Black_ will normalize line endings (`\n` or `\r\n`) based on the first line ending of
450 the file.
451
452 ## Pragmatism
453
454 Early versions of _Black_ used to be absolutist in some respects. They took after its
455 initial author. This was fine at the time as it made the implementation simpler and
456 there were not many users anyway. Not many edge cases were reported. As a mature tool,
457 _Black_ does make some exceptions to rules it otherwise holds. This section documents
458 what those exceptions are and why this is the case.
459
460 ### The magic trailing comma
461
462 _Black_ in general does not take existing formatting into account.
463
464 However, there are cases where you put a short collection or function call in your code
465 but you anticipate it will grow in the future.
466
467 For example:
468
469 ```py3
470 TRANSLATIONS = {
471     "en_us": "English (US)",
472     "pl_pl": "polski",
473 }
474 ```
475
476 Early versions of _Black_ used to ruthlessly collapse those into one line (it fits!).
477 Now, you can communicate that you don't want that by putting a trailing comma in the
478 collection yourself. When you do, _Black_ will know to always explode your collection
479 into one item per line.
480
481 How do you make it stop? Just delete that trailing comma and _Black_ will collapse your
482 collection into one line if it fits.
483
484 If you must, you can recover the behaviour of early versions of _Black_ with the option
485 `--skip-magic-trailing-comma` / `-C`.
486
487 ### r"strings" and R"strings"
488
489 _Black_ normalizes string quotes as well as string prefixes, making them lowercase. One
490 exception to this rule is r-strings. It turns out that the very popular
491 [MagicPython](https://github.com/MagicStack/MagicPython/) syntax highlighter, used by
492 default by (among others) GitHub and Visual Studio Code, differentiates between
493 r-strings and R-strings. The former are syntax highlighted as regular expressions while
494 the latter are treated as true raw strings with no special semantics.
495
496 ### AST before and after formatting
497
498 When run with `--safe` (the default), _Black_ checks that the code before and after is
499 semantically equivalent. This check is done by comparing the AST of the source with the
500 AST of the target. There are three limited cases in which the AST does differ:
501
502 1. _Black_ cleans up leading and trailing whitespace of docstrings, re-indenting them if
503    needed. It's been one of the most popular user-reported features for the formatter to
504    fix whitespace issues with docstrings. While the result is technically an AST
505    difference, due to the various possibilities of forming docstrings, all real-world
506    uses of docstrings that we're aware of sanitize indentation and leading/trailing
507    whitespace anyway.
508
509 1. _Black_ manages optional parentheses for some statements. In the case of the `del`
510    statement, presence of wrapping parentheses or lack of thereof changes the resulting
511    AST but is semantically equivalent in the interpreter.
512
513 1. _Black_ might move comments around, which includes type comments. Those are part of
514    the AST as of Python 3.8. While the tool implements a number of special cases for
515    those comments, there is no guarantee they will remain where they were in the source.
516    Note that this doesn't change runtime behavior of the source code.
517
518 To put things in perspective, the code equivalence check is a feature of _Black_ which
519 other formatters don't implement at all. It is of crucial importance to us to ensure
520 code behaves the way it did before it got reformatted. We treat this as a feature and
521 there are no plans to relax this in the future. The exceptions enumerated above stem
522 from either user feedback or implementation details of the tool. In each case we made
523 due diligence to ensure that the AST divergence is of no practical consequence.