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

8f539e2e1d42b7f3e9cd9ff97006ea90df9de2bd
[etc/vim.git] / README.md
1 ![Black Logo](https://raw.githubusercontent.com/psf/black/master/docs/_static/logo2-readme.png)
2
3 <h2 align="center">The Uncompromising Code Formatter</h2>
4
5 <p align="center">
6 <a href="https://travis-ci.com/psf/black"><img alt="Build Status" src="https://travis-ci.com/psf/black.svg?branch=master"></a>
7 <a href="https://github.com/psf/black/actions"><img alt="Actions Status" src="https://github.com/psf/black/workflows/Test/badge.svg"></a>
8 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
9 <a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
10 <a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
11 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
12 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
13 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
14 </p>
15
16 > “Any color you like.”
17
18 _Black_ is the uncompromising Python code formatter. By using it, you agree to cede
19 control over minutiae of hand-formatting. In return, _Black_ gives you speed,
20 determinism, and freedom from `pycodestyle` nagging about formatting. You will save time
21 and mental energy for more important matters.
22
23 Blackened code looks the same regardless of the project you're reading. Formatting
24 becomes transparent after a while and you can focus on the content instead.
25
26 _Black_ makes code review faster by producing the smallest diffs possible.
27
28 Try it out now using the [Black Playground](https://black.now.sh). Watch the
29 [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
30
31 ---
32
33 _Contents:_ **[Installation and usage](#installation-and-usage)** |
34 **[Code style](#the-black-code-style)** | **[Pragmatism](#pragmatism)** |
35 **[pyproject.toml](#pyprojecttoml)** | **[Editor integration](#editor-integration)** |
36 **[blackd](#blackd)** | **[black-primer](#black-primer)** |
37 **[Version control integration](#version-control-integration)** |
38 **[Ignoring unmodified files](#ignoring-unmodified-files)** | **[Used by](#used-by)** |
39 **[Testimonials](#testimonials)** | **[Show your style](#show-your-style)** |
40 **[Contributing](#contributing-to-black)** | **[Change Log](#change-log)** |
41 **[Authors](#authors)**
42
43 ---
44
45 ## Installation and usage
46
47 ### Installation
48
49 _Black_ can be installed by running `pip install black`. It requires Python 3.6.0+ to
50 run but you can reformat Python 2 code with it, too.
51
52 ### Usage
53
54 To get started right away with sensible defaults:
55
56 ```sh
57 black {source_file_or_directory}
58 ```
59
60 ### Command line options
61
62 _Black_ doesn't provide many options. You can list them by running `black --help`:
63
64 ```text
65 Usage: black [OPTIONS] [SRC]...
66
67   The uncompromising code formatter.
68
69 Options:
70   -c, --code TEXT                 Format the code passed in as a string.
71   -l, --line-length INTEGER       How many characters per line to allow.
72                                   [default: 88]
73
74   -t, --target-version [py27|py33|py34|py35|py36|py37|py38]
75                                   Python versions that should be supported by
76                                   Black's output. [default: per-file auto-
77                                   detection]
78
79   --pyi                           Format all input files like typing stubs
80                                   regardless of file extension (useful when
81                                   piping source on standard input).
82
83   -S, --skip-string-normalization
84                                   Don't normalize string quotes or prefixes.
85   --check                         Don't write the files back, just return the
86                                   status.  Return code 0 means nothing would
87                                   change.  Return code 1 means some files
88                                   would be reformatted. Return code 123 means
89                                   there was an internal error.
90
91   --diff                          Don't write the files back, just output a
92                                   diff for each file on stdout.
93
94   --color / --no-color            Show colored diff. Only applies when
95                                   `--diff` is given.
96
97   --fast / --safe                 If --fast given, skip temporary sanity
98                                   checks. [default: --safe]
99
100   --include TEXT                  A regular expression that matches files and
101                                   directories that should be included on
102                                   recursive searches.  An empty value means
103                                   all files are included regardless of the
104                                   name.  Use forward slashes for directories
105                                   on all platforms (Windows, too).  Exclusions
106                                   are calculated first, inclusions later.
107                                   [default: \.pyi?$]
108
109   --exclude TEXT                  A regular expression that matches files and
110                                   directories that should be excluded on
111                                   recursive searches.  An empty value means no
112                                   paths are excluded. Use forward slashes for
113                                   directories on all platforms (Windows, too).
114                                   Exclusions are calculated first, inclusions
115                                   later.  [default: /(\.eggs|\.git|\.hg|\.mypy
116                                   _cache|\.nox|\.tox|\.venv|\.svn|_build|buck-
117                                   out|build|dist)/]
118
119   --force-exclude TEXT            Like --exclude, but files and directories
120                                   matching this regex will be excluded even
121                                   when they are passed explicitly as arguments
122
123   -q, --quiet                     Don't emit non-error messages to stderr.
124                                   Errors are still emitted; silence those with
125                                   2>/dev/null.
126
127   -v, --verbose                   Also emit messages to stderr about files
128                                   that were not changed or were ignored due to
129                                   --exclude=.
130
131   --version                       Show the version and exit.
132   --config FILE                   Read configuration from PATH.
133   -h, --help                      Show this message and exit.
134 ```
135
136 _Black_ is a well-behaved Unix-style command-line tool:
137
138 - it does nothing if no sources are passed to it;
139 - it will read from standard input and write to standard output if `-` is used as the
140   filename;
141 - it only outputs messages to users on standard error;
142 - exits with code 0 unless an internal error occurred (or `--check` was used).
143
144 ### Using _Black_ with other tools
145
146 While _Black_ enforces formatting that conforms to PEP 8, other tools may raise warnings
147 about _Black_'s changes or will overwrite _Black_'s changes. A good example of this is
148 [isort](https://pypi.org/p/isort). Since _Black_ is barely configurable, these tools
149 should be configured to neither warn about nor overwrite _Black_'s changes.
150
151 Actual details on _Black_ compatible configurations for various tools can be found in
152 [compatible_configs](https://github.com/psf/black/blob/master/docs/compatible_configs.md).
153
154 ### Migrating your code style without ruining git blame
155
156 A long-standing argument against moving to automated code formatters like _Black_ is
157 that the migration will clutter up the output of `git blame`. This was a valid argument,
158 but since Git version 2.23, Git natively supports
159 [ignoring revisions in blame](https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revltrevgt)
160 with the `--ignore-rev` option. You can also pass a file listing the revisions to ignore
161 using the `--ignore-revs-file` option. The changes made by the revision will be ignored
162 when assigning blame. Lines modified by an ignored revision will be blamed on the
163 previous revision that modified those lines.
164
165 So when migrating your project's code style to _Black_, reformat everything and commit
166 the changes (preferably in one massive commit). Then put the full 40 characters commit
167 identifier(s) into a file.
168
169 ```
170 # Migrate code style to Black
171 5b4ab991dede475d393e9d69ec388fd6bd949699
172 ```
173
174 Afterwards, you can pass that file to `git blame` and see clean and meaningful blame
175 information.
176
177 ```console
178 $ git blame important.py --ignore-revs-file .git-blame-ignore-revs
179 7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 1) def very_important_function(text, file):
180 abdfd8b0 (Alice Doe  2019-09-23 11:39:32 -0400 2)     text = text.lstrip()
181 7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 3)     with open(file, "r+") as f:
182 7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 4)         f.write(formatted)
183 ```
184
185 You can even configure `git` to automatically ignore revisions listed in a file on every
186 call to `git blame`.
187
188 ```console
189 $ git config blame.ignoreRevsFile .git-blame-ignore-revs
190 ```
191
192 **The one caveat is that GitHub and GitLab do not yet support ignoring revisions using
193 their native UI of blame.** So blame information will be cluttered with a reformatting
194 commit on those platforms. (If you'd like this feature, there's an open issue for
195 [GitLab](https://gitlab.com/gitlab-org/gitlab/-/issues/31423) and please let GitHub
196 know!)
197
198 ### NOTE: This is a beta product
199
200 _Black_ is already [successfully used](#used-by) by many projects, small and big. It
201 also sports a decent test suite. However, it is still very new. Things will probably be
202 wonky for a while. This is made explicit by the "Beta" trove classifier, as well as by
203 the "b" in the version number. What this means for you is that **until the formatter
204 becomes stable, you should expect some formatting to change in the future**. That being
205 said, no drastic stylistic changes are planned, mostly responses to bug reports.
206
207 Also, as a temporary safety measure, _Black_ will check that the reformatted code still
208 produces a valid AST that is equivalent to the original. This slows it down. If you're
209 feeling confident, use `--fast`.
210
211 ## The _Black_ code style
212
213 _Black_ reformats entire files in place. It is not configurable. It doesn't take
214 previous formatting into account. It doesn't reformat blocks that start with
215 `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` have to be on the same level of
216 indentation. It also recognizes [YAPF](https://github.com/google/yapf)'s block comments
217 to the same effect, as a courtesy for straddling code.
218
219 ### How _Black_ wraps lines
220
221 _Black_ ignores previous formatting and applies uniform horizontal and vertical
222 whitespace to your code. The rules for horizontal whitespace can be summarized as: do
223 whatever makes `pycodestyle` happy. The coding style used by _Black_ can be viewed as a
224 strict subset of PEP 8.
225
226 As for vertical whitespace, _Black_ tries to render one full expression or simple
227 statement per line. If this fits the allotted line length, great.
228
229 ```py3
230 # in:
231
232 j = [1,
233      2,
234      3
235 ]
236
237 # out:
238
239 j = [1, 2, 3]
240 ```
241
242 If not, _Black_ will look at the contents of the first outer matching brackets and put
243 that in a separate indented line.
244
245 ```py3
246 # in:
247
248 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
249
250 # out:
251
252 ImportantClass.important_method(
253     exc, limit, lookup_lines, capture_locals, extra_argument
254 )
255 ```
256
257 If that still doesn't fit the bill, it will decompose the internal expression further
258 using the same rule, indenting matching brackets every time. If the contents of the
259 matching brackets pair are comma-separated (like an argument list, or a dict literal,
260 and so on) then _Black_ will first try to keep them on the same line with the matching
261 brackets. If that doesn't work, it will put all of them in separate lines.
262
263 ```py3
264 # in:
265
266 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
267     """Applies `variables` to the `template` and writes to `file`."""
268     with open(file, 'w') as f:
269         ...
270
271 # out:
272
273 def very_important_function(
274     template: str,
275     *variables,
276     file: os.PathLike,
277     engine: str,
278     header: bool = True,
279     debug: bool = False,
280 ):
281     """Applies `variables` to the `template` and writes to `file`."""
282     with open(file, "w") as f:
283         ...
284 ```
285
286 _Black_ prefers parentheses over backslashes, and will remove backslashes if found.
287
288 ```py3
289 # in:
290
291 if some_short_rule1 \
292   and some_short_rule2:
293       ...
294
295 # out:
296
297 if some_short_rule1 and some_short_rule2:
298   ...
299
300
301 # in:
302
303 if some_long_rule1 \
304   and some_long_rule2:
305     ...
306
307 # out:
308
309 if (
310     some_long_rule1
311     and some_long_rule2
312 ):
313     ...
314
315 ```
316
317 Backslashes and multiline strings are one of the two places in the Python grammar that
318 break significant indentation. You never need backslashes, they are used to force the
319 grammar to accept breaks that would otherwise be parse errors. That makes them confusing
320 to look at and brittle to modify. This is why _Black_ always gets rid of them.
321
322 If you're reaching for backslashes, that's a clear signal that you can do better if you
323 slightly refactor your code. I hope some of the examples above show you that there are
324 many ways in which you can do it.
325
326 However there is one exception: `with` statements using multiple context managers.
327 Python's grammar does not allow organizing parentheses around the series of context
328 managers.
329
330 We don't want formatting like:
331
332 ```py3
333 with make_context_manager1() as cm1, make_context_manager2() as cm2, make_context_manager3() as cm3, make_context_manager4() as cm4:
334     ...  # nothing to split on - line too long
335 ```
336
337 So _Black_ will now format it like this:
338
339 ```py3
340 with \
341      make_context_manager(1) as cm1, \
342      make_context_manager(2) as cm2, \
343      make_context_manager(3) as cm3, \
344      make_context_manager(4) as cm4 \
345 :
346     ...  # backslashes and an ugly stranded colon
347 ```
348
349 You might have noticed that closing brackets are always dedented and that a trailing
350 comma is always added. Such formatting produces smaller diffs; when you add or remove an
351 element, it's always just one line. Also, having the closing bracket dedented provides a
352 clear delimiter between two distinct sections of the code that otherwise share the same
353 indentation level (like the arguments list and the docstring in the example above).
354
355 If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot
356 fit in the allotted length, it's always split into one element per line. This minimizes
357 diffs as well as enables readers of code to find which commit introduced a particular
358 entry. This also makes _Black_ compatible with [isort](https://pypi.org/p/isort/) with
359 the following configuration.
360
361 <details>
362 <summary>A compatible `.isort.cfg`</summary>
363
364 ```
365 [settings]
366 multi_line_output=3
367 include_trailing_comma=True
368 force_grid_wrap=0
369 use_parentheses=True
370 line_length=88
371 ```
372
373 The equivalent command line is:
374
375 ```
376 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
377 ```
378
379 </details>
380
381 ### Line length
382
383 You probably noticed the peculiar default line length. _Black_ defaults to 88 characters
384 per line, which happens to be 10% over 80. This number was found to produce
385 significantly shorter files than sticking with 80 (the most popular), or even 79 (used
386 by the standard library). In general,
387 [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
388
389 If you're paid by the line of code you write, you can pass `--line-length` with a lower
390 number. _Black_ will try to respect that. However, sometimes it won't be able to without
391 breaking other rules. In those rare cases, auto-formatted code will exceed your allotted
392 limit.
393
394 You can also increase it, but remember that people with sight disabilities find it
395 harder to work with line lengths exceeding 100 characters. It also adversely affects
396 side-by-side diff review on typical screen resolutions. Long lines also make it harder
397 to present code neatly in documentation or talk slides.
398
399 If you're using Flake8, you can bump `max-line-length` to 88 and forget about it.
400 Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s B950 warning
401 instead of E501 and keep the max line length at 80 which you are probably already using.
402 You'd do it like this:
403
404 ```ini
405 [flake8]
406 max-line-length = 80
407 ...
408 select = C,E,F,W,B,B950
409 ignore = E203, E501, W503
410 ```
411
412 You'll find _Black_'s own .flake8 config file is configured like this. Explanation of
413 why W503 and E203 are disabled can be found further in this documentation. And if you're
414 curious about the reasoning behind B950,
415 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
416 explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you
417 overdo it by a few km/h".
418
419 **If you're looking for a minimal, black-compatible flake8 configuration:**
420
421 ```ini
422 [flake8]
423 max-line-length = 88
424 extend-ignore = E203
425 ```
426
427 ### Empty lines
428
429 _Black_ avoids spurious vertical whitespace. This is in the spirit of PEP 8 which says
430 that in-function vertical whitespace should only be used sparingly.
431
432 _Black_ will allow single empty lines inside functions, and single and double empty
433 lines on module level left by the original editors, except when they're within
434 parenthesized expressions. Since such expressions are always reformatted to fit minimal
435 space, this whitespace is lost.
436
437 It will also insert proper spacing before and after function definitions. It's one line
438 before and after inner functions and two lines before and after module-level functions
439 and classes. _Black_ will not put empty lines between function/class definitions and
440 standalone comments that immediately precede the given function/class.
441
442 _Black_ will enforce single empty lines between a class-level docstring and the first
443 following field or method. This conforms to
444 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
445
446 _Black_ won't insert empty lines after function docstrings unless that empty line is
447 required due to an inner function starting immediately after.
448
449 ### Trailing commas
450
451 _Black_ will add trailing commas to expressions that are split by comma where each
452 element is on its own line. This includes function signatures.
453
454 Unnecessary trailing commas are removed if an expression fits in one line. This makes it
455 1% more likely that your line won't exceed the allotted line length limit. Moreover, in
456 this scenario, if you added another argument to your call, you'd probably fit it in the
457 same line anyway. That doesn't make diffs any larger.
458
459 One exception to removing trailing commas is tuple expressions with just one element. In
460 this case _Black_ won't touch the single trailing comma as this would unexpectedly
461 change the underlying data type. Note that this is also the case when commas are used
462 while indexing. This is a tuple in disguise: `numpy_array[3, ]`.
463
464 One exception to adding trailing commas is function signatures containing `*`, `*args`,
465 or `**kwargs`. In this case a trailing comma is only safe to use on Python 3.6. _Black_
466 will detect if your file is already 3.6+ only and use trailing commas in this situation.
467 If you wonder how it knows, it looks for f-strings and existing use of trailing commas
468 in function signatures that have stars in them. In other words, if you'd like a trailing
469 comma in this situation and _Black_ didn't recognize it was safe to do so, put it there
470 manually and _Black_ will keep it.
471
472 ### Strings
473
474 _Black_ prefers double quotes (`"` and `"""`) over single quotes (`'` and `'''`). It
475 will replace the latter with the former as long as it does not result in more backslash
476 escapes than before.
477
478 _Black_ also standardizes string prefixes, making them always lowercase. On top of that,
479 if your code is already Python 3.6+ only or it's using the `unicode_literals` future
480 import, _Black_ will remove `u` from the string prefix as it is meaningless in those
481 scenarios.
482
483 The main reason to standardize on a single form of quotes is aesthetics. Having one kind
484 of quotes everywhere reduces reader distraction. It will also enable a future version of
485 _Black_ to merge consecutive string literals that ended up on the same line (see
486 [#26](https://github.com/psf/black/issues/26) for details).
487
488 Why settle on double quotes? They anticipate apostrophes in English text. They match the
489 docstring standard described in
490 [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). An empty
491 string in double quotes (`""`) is impossible to confuse with a one double-quote
492 regardless of fonts and syntax highlighting used. On top of this, double quotes for
493 strings are consistent with C which Python interacts a lot with.
494
495 On certain keyboard layouts like US English, typing single quotes is a bit easier than
496 double quotes. The latter requires use of the Shift key. My recommendation here is to
497 keep using whatever is faster to type and let _Black_ handle the transformation.
498
499 If you are adopting _Black_ in a large project with pre-existing string conventions
500 (like the popular
501 ["single quotes for data, double quotes for human-readable strings"](https://stackoverflow.com/a/56190)),
502 you can pass `--skip-string-normalization` on the command line. This is meant as an
503 adoption helper, avoid using this for new projects.
504
505 ### Numeric literals
506
507 _Black_ standardizes most numeric literals to use lowercase letters for the syntactic
508 parts and uppercase letters for the digits themselves: `0xAB` instead of `0XAB` and
509 `1e10` instead of `1E10`. Python 2 long literals are styled as `2L` instead of `2l` to
510 avoid confusion between `l` and `1`.
511
512 ### Line breaks & binary operators
513
514 _Black_ will break a line before a binary operator when splitting a block of code over
515 multiple lines. This is so that _Black_ is compliant with the recent changes in the
516 [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
517 style guide, which emphasizes that this approach improves readability.
518
519 This behaviour may raise `W503 line break before binary operator` warnings in style
520 guide enforcement tools like Flake8. Since `W503` is not PEP 8 compliant, you should
521 tell Flake8 to ignore these warnings.
522
523 ### Slices
524
525 PEP 8
526 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
527 to treat `:` in slices as a binary operator with the lowest priority, and to leave an
528 equal amount of space on either side, except if a parameter is omitted (e.g.
529 `ham[1 + 1 :]`). It recommends no spaces around `:` operators for "simple expressions"
530 (`ham[lower:upper]`), and extra space for "complex expressions"
531 (`ham[lower : upper + offset]`). _Black_ treats anything more than variable names as
532 "complex" (`ham[lower : upper + 1]`). It also states that for extended slices, both `:`
533 operators have to have the same amount of spacing, except if a parameter is omitted
534 (`ham[1 + 1 ::]`). _Black_ enforces these rules consistently.
535
536 This behaviour may raise `E203 whitespace before ':'` warnings in style guide
537 enforcement tools like Flake8. Since `E203` is not PEP 8 compliant, you should tell
538 Flake8 to ignore these warnings.
539
540 ### Parentheses
541
542 Some parentheses are optional in the Python grammar. Any expression can be wrapped in a
543 pair of parentheses to form an atom. There are a few interesting cases:
544
545 - `if (...):`
546 - `while (...):`
547 - `for (...) in (...):`
548 - `assert (...), (...)`
549 - `from X import (...)`
550 - assignments like:
551   - `target = (...)`
552   - `target: type = (...)`
553   - `some, *un, packing = (...)`
554   - `augmented += (...)`
555
556 In those cases, parentheses are removed when the entire statement fits in one line, or
557 if the inner expression doesn't have any delimiters to further split on. If there is
558 only a single delimiter and the expression starts or ends with a bracket, the
559 parenthesis can also be successfully omitted since the existing bracket pair will
560 organize the expression neatly anyway. Otherwise, the parentheses are added.
561
562 Please note that _Black_ does not add or remove any additional nested parentheses that
563 you might want to have for clarity or further code organization. For example those
564 parentheses are not going to be removed:
565
566 ```py3
567 return not (this or that)
568 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
569 ```
570
571 ### Call chains
572
573 Some popular APIs, like ORMs, use call chaining. This API style is known as a
574 [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface). _Black_ formats
575 those by treating dots that follow a call or an indexing operation like a very low
576 priority delimiter. It's easier to show the behavior than to explain it. Look at the
577 example:
578
579 ```py3
580 def example(session):
581     result = (
582         session.query(models.Customer.id)
583         .filter(
584             models.Customer.account_id == account_id,
585             models.Customer.email == email_address,
586         )
587         .order_by(models.Customer.id.asc())
588         .all()
589     )
590 ```
591
592 ### Typing stub files
593
594 PEP 484 describes the syntax for type hints in Python. One of the use cases for typing
595 is providing type annotations for modules which cannot contain them directly (they might
596 be written in C, or they might be third-party, or their implementation may be overly
597 dynamic, and so on).
598
599 To solve this,
600 [stub files with the `.pyi` file extension](https://www.python.org/dev/peps/pep-0484/#stub-files)
601 can be used to describe typing information for an external module. Those stub files omit
602 the implementation of classes and functions they describe, instead they only contain the
603 structure of the file (listing globals, functions, and classes with their members). The
604 recommended code style for those files is more terse than PEP 8:
605
606 - prefer `...` on the same line as the class/function signature;
607 - avoid vertical whitespace between consecutive module-level functions, names, or
608   methods and fields within a single class;
609 - use a single blank line between top-level class definitions, or none if the classes
610   are very small.
611
612 _Black_ enforces the above rules. There are additional guidelines for formatting `.pyi`
613 file that are not enforced yet but might be in a future version of the formatter:
614
615 - all function bodies should be empty (contain `...` instead of the body);
616 - do not use docstrings;
617 - prefer `...` over `pass`;
618 - for arguments with a default, use `...` instead of the actual default;
619 - avoid using string literals in type annotations, stub files support forward references
620   natively (like Python 3.7 code with `from __future__ import annotations`);
621 - use variable annotations instead of type comments, even for stubs that target older
622   versions of Python;
623 - for arguments that default to `None`, use `Optional[]` explicitly;
624 - use `float` instead of `Union[int, float]`.
625
626 ## Pragmatism
627
628 Early versions of _Black_ used to be absolutist in some respects. They took after its
629 initial author. This was fine at the time as it made the implementation simpler and
630 there were not many users anyway. Not many edge cases were reported. As a mature tool,
631 _Black_ does make some exceptions to rules it otherwise holds. This section documents
632 what those exceptions are and why this is the case.
633
634 ### The magic trailing comma
635
636 _Black_ in general does not take existing formatting into account.
637
638 However, there are cases where you put a short collection or function call in your code
639 but you anticipate it will grow in the future.
640
641 For example:
642
643 ```py3
644 TRANSLATIONS = {
645     "en_us": "English (US)",
646     "pl_pl": "polski",
647 }
648 ```
649
650 Early versions of _Black_ used to ruthlessly collapse those into one line (it fits!).
651 Now, you can communicate that you don't want that by putting a trailing comma in the
652 collection yourself. When you do, _Black_ will know to always explode your collection
653 into one item per line.
654
655 How do you make it stop? Just delete that trailing comma and _Black_ will collapse your
656 collection into one line if it fits.
657
658 ### r"strings" and R"strings"
659
660 _Black_ normalizes string quotes as well as string prefixes, making them lowercase. One
661 exception to this rule is r-strings. It turns out that the very popular
662 [MagicPython](https://github.com/MagicStack/MagicPython/) syntax highlighter, used by
663 default by (among others) GitHub and Visual Studio Code, differentiates between
664 r-strings and R-strings. The former are syntax highlighted as regular expressions while
665 the latter are treated as true raw strings with no special semantics.
666
667 ## pyproject.toml
668
669 _Black_ is able to read project-specific default values for its command line options
670 from a `pyproject.toml` file. This is especially useful for specifying custom
671 `--include` and `--exclude` patterns for your project.
672
673 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
674 "No". _Black_ is all about sensible defaults.
675
676 ### What on Earth is a `pyproject.toml` file?
677
678 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines `pyproject.toml` as a
679 configuration file to store build system requirements for Python projects. With the help
680 of tools like [Poetry](https://poetry.eustace.io/) or
681 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the need for
682 `setup.py` and `setup.cfg` files.
683
684 ### Where _Black_ looks for the file
685
686 By default _Black_ looks for `pyproject.toml` starting from the common base directory of
687 all files and directories passed on the command line. If it's not there, it looks in
688 parent directories. It stops looking when it finds the file, or a `.git` directory, or a
689 `.hg` directory, or the root of the file system, whichever comes first.
690
691 If you're formatting standard input, _Black_ will look for configuration starting from
692 the current working directory.
693
694 You can also explicitly specify the path to a particular file that you want with
695 `--config`. In this situation _Black_ will not look for any other file.
696
697 If you're running with `--verbose`, you will see a blue message if a file was found and
698 used.
699
700 Please note `blackd` will not use `pyproject.toml` configuration.
701
702 ### Configuration format
703
704 As the file extension suggests, `pyproject.toml` is a
705 [TOML](https://github.com/toml-lang/toml) file. It contains separate sections for
706 different tools. _Black_ is using the `[tool.black]` section. The option keys are the
707 same as long names of options on the command line.
708
709 Note that you have to use single-quoted strings in TOML for regular expressions. It's
710 the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
711 expressions by Black. Use `[ ]` to denote a significant space character.
712
713 <details>
714 <summary>Example `pyproject.toml`</summary>
715
716 ```toml
717 [tool.black]
718 line-length = 88
719 target-version = ['py37']
720 include = '\.pyi?$'
721 exclude = '''
722
723 (
724   /(
725       \.eggs         # exclude a few common directories in the
726     | \.git          # root of the project
727     | \.hg
728     | \.mypy_cache
729     | \.tox
730     | \.venv
731     | _build
732     | buck-out
733     | build
734     | dist
735   )/
736   | foo.py           # also separately exclude a file named foo.py in
737                      # the root of the project
738 )
739 '''
740 ```
741
742 </details>
743
744 ### Lookup hierarchy
745
746 Command-line options have defaults that you can see in `--help`. A `pyproject.toml` can
747 override those defaults. Finally, options provided by the user on the command line
748 override both.
749
750 _Black_ will only ever use one `pyproject.toml` file during an entire run. It doesn't
751 look for multiple files, and doesn't compose configuration from different levels of the
752 file hierarchy.
753
754 ## Editor integration
755
756 ### Emacs
757
758 Options include the following:
759
760 - [purcell/reformatter.el](https://github.com/purcell/reformatter.el)
761 - [proofit404/blacken](https://github.com/proofit404/blacken)
762 - [Elpy](https://github.com/jorgenschaefer/elpy).
763
764 ### PyCharm/IntelliJ IDEA
765
766 1. Install `black`.
767
768 ```console
769 $ pip install black
770 ```
771
772 2. Locate your `black` installation folder.
773
774 On macOS / Linux / BSD:
775
776 ```console
777 $ which black
778 /usr/local/bin/black  # possible location
779 ```
780
781 On Windows:
782
783 ```console
784 $ where black
785 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
786 ```
787
788 Note that if you are using a virtual environment detected by PyCharm, this is an
789 unneeded step. In this case the path to `black` is `$PyInterpreterDirectory$/black`.
790
791 3. Open External tools in PyCharm/IntelliJ IDEA
792
793 On macOS:
794
795 `PyCharm -> Preferences -> Tools -> External Tools`
796
797 On Windows / Linux / BSD:
798
799 `File -> Settings -> Tools -> External Tools`
800
801 4. Click the + icon to add a new external tool with the following values:
802
803    - Name: Black
804    - Description: Black is the uncompromising Python code formatter.
805    - Program: <install_location_from_step_2>
806    - Arguments: `"$FilePath$"`
807
808 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
809
810    - Alternatively, you can set a keyboard shortcut by navigating to
811      `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black`.
812
813 6. Optionally, run _Black_ on every file save:
814
815    1. Make sure you have the
816       [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin
817       installed.
818    2. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a
819       new watcher:
820       - Name: Black
821       - File type: Python
822       - Scope: Project Files
823       - Program: <install_location_from_step_2>
824       - Arguments: `$FilePath$`
825       - Output paths to refresh: `$FilePath$`
826       - Working directory: `$ProjectFileDir$`
827
828    - Uncheck "Auto-save edited files to trigger the watcher"
829
830 ### Wing IDE
831
832 Wing supports black via the OS Commands tool, as explained in the Wing documentation on
833 [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
834
835 1. Install `black`.
836
837 ```console
838 $ pip install black
839 ```
840
841 2. Make sure it runs from the command line, e.g.
842
843 ```console
844 $ black --help
845 ```
846
847 3. In Wing IDE, activate the **OS Commands** panel and define the command **black** to
848    execute black on the currently selected file:
849
850 - Use the Tools -> OS Commands menu selection
851 - click on **+** in **OS Commands** -> New: Command line..
852   - Title: black
853   - Command Line: black %s
854   - I/O Encoding: Use Default
855   - Key Binding: F1
856   - [x] Raise OS Commands when executed
857   - [x] Auto-save files before execution
858   - [x] Line mode
859
860 4. Select a file in the editor and press **F1** , or whatever key binding you selected
861    in step 3, to reformat the file.
862
863 ### Vim
864
865 Commands and shortcuts:
866
867 - `:Black` to format the entire file (ranges not supported);
868 - `:BlackUpgrade` to upgrade _Black_ inside the virtualenv;
869 - `:BlackVersion` to get the current version of _Black_ inside the virtualenv.
870
871 Configuration:
872
873 - `g:black_fast` (defaults to `0`)
874 - `g:black_linelength` (defaults to `88`)
875 - `g:black_skip_string_normalization` (defaults to `0`)
876 - `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
877
878 To install with [vim-plug](https://github.com/junegunn/vim-plug):
879
880 ```
881 Plug 'psf/black', { 'branch': 'stable' }
882 ```
883
884 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
885
886 ```
887 Plugin 'psf/black'
888 ```
889
890 and execute the following in a terminal:
891
892 ```console
893 $ cd ~/.vim/bundle/black
894 $ git checkout origin/stable -b stable
895 ```
896
897 or you can copy the plugin from
898 [plugin/black.vim](https://github.com/psf/black/blob/stable/plugin/black.vim).
899
900 ```
901 mkdir -p ~/.vim/pack/python/start/black/plugin
902 curl https://raw.githubusercontent.com/psf/black/master/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim
903 ```
904
905 Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
906 Pathogen, and so on.
907
908 This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to
909 be able to run _Black_ inside the Vim process which is much faster than calling an
910 external command.
911
912 On first run, the plugin creates its own virtualenv using the right Python version and
913 automatically installs _Black_. You can upgrade it later by calling `:BlackUpgrade` and
914 restarting Vim.
915
916 If you need to do anything special to make your virtualenv work and install _Black_ (for
917 example you want to run a version from master), create a virtualenv manually and point
918 `g:black_virtualenv` to it. The plugin will use it.
919
920 To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:
921
922 ```
923 autocmd BufWritePre *.py execute ':Black'
924 ```
925
926 To run _Black_ on a key press (e.g. F9 below), add this:
927
928 ```
929 nnoremap <F9> :Black<CR>
930 ```
931
932 **How to get Vim with Python 3.6?** On Ubuntu 17.10 Vim comes with Python 3.6 by
933 default. On macOS with Homebrew run: `brew install vim`. When building Vim from source,
934 use: `./configure --enable-python3interp=yes`. There's many guides online how to do
935 this.
936
937 **I get an import error when using _Black_ from a virtual environment**: If you get an
938 error message like this:
939
940 ```text
941 Traceback (most recent call last):
942   File "<string>", line 63, in <module>
943   File "/home/gui/.vim/black/lib/python3.7/site-packages/black.py", line 45, in <module>
944     from typed_ast import ast3, ast27
945   File "/home/gui/.vim/black/lib/python3.7/site-packages/typed_ast/ast3.py", line 40, in <module>
946     from typed_ast import _ast3
947 ImportError: /home/gui/.vim/black/lib/python3.7/site-packages/typed_ast/_ast3.cpython-37m-x86_64-linux-gnu.so: undefined symbool: PyExc_KeyboardInterrupt
948 ```
949
950 Then you need to install `typed_ast` and `regex` directly from the source code. The
951 error happens because `pip` will download [Python wheels](https://pythonwheels.com/) if
952 they are available. Python wheels are a new standard of distributing Python packages and
953 packages that have Cython and extensions written in C are already compiled, so the
954 installation is much more faster. The problem here is that somehow the Python
955 environment inside Vim does not match with those already compiled C extensions and these
956 kind of errors are the result. Luckily there is an easy fix: installing the packages
957 from the source code.
958
959 The two packages that cause the problem are:
960
961 - [regex](https://pypi.org/project/regex/)
962 - [typed-ast](https://pypi.org/project/typed-ast/)
963
964 Now remove those two packages:
965
966 ```console
967 $ pip uninstall regex typed-ast -y
968 ```
969
970 And now you can install them with:
971
972 ```console
973 $ pip install --no-binary :all: regex typed-ast
974 ```
975
976 The C extensions will be compiled and now Vim's Python environment will match. Note that
977 you need to have the GCC compiler and the Python development files installed (on
978 Ubuntu/Debian do `sudo apt-get install build-essential python3-dev`).
979
980 If you later want to update _Black_, you should do it like this:
981
982 ```console
983 $ pip install -U black --no-binary regex,typed-ast
984 ```
985
986 ### Visual Studio Code
987
988 Use the
989 [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
990 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
991
992 ### SublimeText 3
993
994 Use [sublack plugin](https://github.com/jgirardet/sublack).
995
996 ### Jupyter Notebook Magic
997
998 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
999
1000 ### Python Language Server
1001
1002 If your editor supports the [Language Server Protocol](https://langserver.org/) (Atom,
1003 Sublime Text, Visual Studio Code and many more), you can use the
1004 [Python Language Server](https://github.com/palantir/python-language-server) with the
1005 [pyls-black](https://github.com/rupert/pyls-black) plugin.
1006
1007 ### Atom/Nuclide
1008
1009 Use [python-black](https://atom.io/packages/python-black).
1010
1011 ### Kakoune
1012
1013 Add the following hook to your kakrc, then run black with `:format`.
1014
1015 ```
1016 hook global WinSetOption filetype=python %{
1017     set-option window formatcmd 'black -q  -'
1018 }
1019 ```
1020
1021 ### Thonny
1022
1023 Use [Thonny-black-code-format](https://github.com/Franccisco/thonny-black-code-format).
1024
1025 ### Other editors
1026
1027 Other editors will require external contributions.
1028
1029 Patches welcome! ✨ 🍰 ✨
1030
1031 Any tool that can pipe code through _Black_ using its stdio mode (just
1032 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
1033 The formatted code will be returned on stdout (unless `--check` was passed). _Black_
1034 will still emit messages on stderr but that shouldn't affect your use case.
1035
1036 This can be used for example with PyCharm's or IntelliJ's
1037 [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
1038
1039 ## blackd
1040
1041 `blackd` is a small HTTP server that exposes _Black_'s functionality over a simple
1042 protocol. The main benefit of using it is to avoid paying the cost of starting up a new
1043 _Black_ process every time you want to blacken a file.
1044
1045 ### Usage
1046
1047 `blackd` is not packaged alongside _Black_ by default because it has additional
1048 dependencies. You will need to do `pip install black[d]` to install it.
1049
1050 You can start the server on the default port, binding only to the local interface by
1051 running `blackd`. You will see a single line mentioning the server's version, and the
1052 host and port it's listening on. `blackd` will then print an access log similar to most
1053 web servers on standard output, merged with any exception traces caused by invalid
1054 formatting requests.
1055
1056 `blackd` provides even less options than _Black_. You can see them by running
1057 `blackd --help`:
1058
1059 ```text
1060 Usage: blackd [OPTIONS]
1061
1062 Options:
1063   --bind-host TEXT                Address to bind the server to.
1064   --bind-port INTEGER             Port to listen on
1065   --version                       Show the version and exit.
1066   -h, --help                      Show this message and exit.
1067 ```
1068
1069 There is no official blackd client tool (yet!). You can test that blackd is working
1070 using `curl`:
1071
1072 ```sh
1073 blackd --bind-port 9090 &  # or let blackd choose a port
1074 curl -s -XPOST "localhost:9090" -d "print('valid')"
1075 ```
1076
1077 ### Protocol
1078
1079 `blackd` only accepts `POST` requests at the `/` path. The body of the request should
1080 contain the python source code to be formatted, encoded according to the `charset` field
1081 in the `Content-Type` request header. If no `charset` is specified, `blackd` assumes
1082 `UTF-8`.
1083
1084 There are a few HTTP headers that control how the source is formatted. These correspond
1085 to command line flags for _Black_. There is one exception to this: `X-Protocol-Version`
1086 which if present, should have the value `1`, otherwise the request is rejected with
1087 `HTTP 501` (Not Implemented).
1088
1089 The headers controlling how code is formatted are:
1090
1091 - `X-Line-Length`: corresponds to the `--line-length` command line flag.
1092 - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization`
1093   command line flag. If present and its value is not the empty string, no string
1094   normalization will be performed.
1095 - `X-Fast-Or-Safe`: if set to `fast`, `blackd` will act as _Black_ does when passed the
1096   `--fast` command line flag.
1097 - `X-Python-Variant`: if set to `pyi`, `blackd` will act as _Black_ does when passed the
1098   `--pyi` command line flag. Otherwise, its value must correspond to a Python version or
1099   a set of comma-separated Python versions, optionally prefixed with `py`. For example,
1100   to request code that is compatible with Python 3.5 and 3.6, set the header to
1101   `py3.5,py3.6`.
1102 - `X-Diff`: corresponds to the `--diff` command line flag. If present, a diff of the
1103   formats will be output.
1104
1105 If any of these headers are set to invalid values, `blackd` returns a `HTTP 400` error
1106 response, mentioning the name of the problematic header in the message body.
1107
1108 Apart from the above, `blackd` can produce the following response codes:
1109
1110 - `HTTP 204`: If the input is already well-formatted. The response body is empty.
1111 - `HTTP 200`: If formatting was needed on the input. The response body contains the
1112   blackened Python code, and the `Content-Type` header is set accordingly.
1113 - `HTTP 400`: If the input contains a syntax error. Details of the error are returned in
1114   the response body.
1115 - `HTTP 500`: If there was any kind of error while trying to format the input. The
1116   response body contains a textual representation of the error.
1117
1118 The response headers include a `X-Black-Version` header containing the version of
1119 _Black_.
1120
1121 ## black-primer
1122
1123 `black-primer` is a tool built for CI (and huumans) to have _Black_ `--check` a number
1124 of (configured in `primer.json`) Git accessible projects in parallel. _(A PR will be
1125 accepted to add Mercurial support.)_
1126
1127 ### Run flow
1128
1129 - Ensure we have a `black` + `git` in PATH
1130 - Load projects from `primer.json`
1131 - Run projects in parallel with `--worker` workers (defaults to CPU count / 2)
1132   - Checkout projects
1133   - Run black and record result
1134   - Clean up repository checkout _(can optionally be disabled via `--keep`)_
1135 - Display results summary to screen
1136 - Default to cleaning up `--work-dir` (which defaults to tempfile schemantics)
1137 - Return
1138   - 0 for successful run
1139   - < 0 for environment / internal error
1140   - > 0 for each project with an error
1141
1142 ### Speed up Runs 🏎
1143
1144 If you're running locally yourself to test black on lots of code try:
1145
1146 - Using `-k` / `--keep` + `-w` / `--work-dir` so you don't have to re-checkout the repo
1147   each run
1148
1149 ### CLI Arguments
1150
1151 ```text
1152 Usage: black-primer [OPTIONS]
1153
1154   primer - prime projects for blackening ... 🏴
1155
1156 Options:
1157   -c, --config PATH      JSON config file path  [default: /Users/cooper/repos/
1158                          black/src/black_primer/primer.json]
1159
1160   --debug                Turn on debug logging  [default: False]
1161   -k, --keep             Keep workdir + repos post run  [default: False]
1162   -L, --long-checkouts   Pull big projects to test  [default: False]
1163   -R, --rebase           Rebase project if already checked out  [default:
1164                          False]
1165
1166   -w, --workdir PATH     Directory Path for repo checkouts  [default: /var/fol
1167                          ders/tc/hbwxh76j1hn6gqjd2n2sjn4j9k1glp/T/primer.20200
1168                          517125229]
1169
1170   -W, --workers INTEGER  Number of parallel worker coroutines  [default: 69]
1171   -h, --help             Show this message and exit.
1172 ```
1173
1174 ### primer config file
1175
1176 The config is `JSON` format. It's main element is the `"projects"` dictionary. Below
1177 explains each parameter:
1178
1179 ```json
1180 {
1181   "projects": {
1182     "00_Example": {
1183       "cli_arguments": "List of extra CLI arguments to pass Black for this project",
1184       "expect_formatting_changes": "Boolean to indicate that the version of Black is expected to cause changes",
1185       "git_clone_url": "URL you would pass `git clone` to check out this repo",
1186       "long_checkout": "Boolean to have repo skipped by defauult unless `--long-checkouts` is specified",
1187       "py_versions": "List of major Python versions to run this project with - all will do as you'd expect - run on ALL versions"
1188     },
1189     "aioexabgp": {
1190       "cli_arguments": [],
1191       "expect_formatting_changes": true,
1192       "git_clone_url": "https://github.com/cooperlees/aioexabgp.git",
1193       "long_checkout": false,
1194       "py_versions": ["all", "3.8"] // "all" ignores all other versions
1195     }
1196   }
1197 }
1198 ```
1199
1200 ### Example run
1201
1202 ```console
1203 cooper-mbp:black cooper$ ~/venvs/b/bin/black-primer
1204 [2020-05-17 13:06:40,830] INFO: 4 projects to run black over (lib.py:270)
1205 [2020-05-17 13:06:44,215] INFO: Analyzing results (lib.py:285)
1206 -- primer results 📊 --
1207
1208 3 / 4 succeeded (75.0%) ✅
1209 1 / 4 FAILED (25.0%) 💩
1210  - 0 projects Disabled by config
1211  - 0 projects skipped due to Python Version
1212  - 0 skipped due to long checkout
1213
1214 Failed Projects:
1215
1216 ## flake8-bugbear:
1217  - Returned 1
1218  - stdout:
1219 --- tests/b303_b304.py  2020-05-17 20:04:09.991227 +0000
1220 +++ tests/b303_b304.py  2020-05-17 20:06:42.753851 +0000
1221 @@ -26,11 +26,11 @@
1222      maxint = 5  # this is okay
1223      # the following shouldn't crash
1224      (a, b, c) = list(range(3))
1225      # it's different than this
1226      a, b, c = list(range(3))
1227 -    a, b, c, = list(range(3))
1228 +    a, b, c = list(range(3))
1229      # and different than this
1230      (a, b), c = list(range(3))
1231      a, *b, c = [1, 2, 3, 4, 5]
1232      b[1:3] = [0, 0]
1233
1234 would reformat tests/b303_b304.py
1235 Oh no! 💥 💔 💥
1236 1 file would be reformatted, 22 files would be left unchanged.
1237 ```
1238
1239 ## Version control integration
1240
1241 Use [pre-commit](https://pre-commit.com/). Once you
1242 [have it installed](https://pre-commit.com/#install), add this to the
1243 `.pre-commit-config.yaml` in your repository:
1244
1245 ```yaml
1246 repos:
1247   - repo: https://github.com/psf/black
1248     rev: stable
1249     hooks:
1250       - id: black
1251         language_version: python3.6
1252 ```
1253
1254 Then run `pre-commit install` and you're ready to go.
1255
1256 Avoid using `args` in the hook. Instead, store necessary configuration in
1257 `pyproject.toml` so that editors and command-line usage of Black all behave consistently
1258 for your project. See _Black_'s own
1259 [pyproject.toml](https://github.com/psf/black/blob/master/pyproject.toml) for an
1260 example.
1261
1262 If you're already using Python 3.7, switch the `language_version` accordingly. Finally,
1263 `stable` is a branch that tracks the latest release on PyPI. If you'd rather run on
1264 master, this is also an option.
1265
1266 ## Ignoring unmodified files
1267
1268 _Black_ remembers files it has already formatted, unless the `--diff` flag is used or
1269 code is passed via standard input. This information is stored per-user. The exact
1270 location of the file depends on the _Black_ version and the system on which _Black_ is
1271 run. The file is non-portable. The standard location on common operating systems is:
1272
1273 - Windows:
1274   `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle`
1275 - macOS:
1276   `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle`
1277 - Linux:
1278   `/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle`
1279
1280 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
1281 as .pyi, and whether string normalization was omitted.
1282
1283 To override the location of these files on macOS or Linux, set the environment variable
1284 `XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache
1285 in the directory you're running _Black_ from, set `XDG_CACHE_HOME=.cache`. _Black_ will
1286 then write the above files to `.cache/black/<version>/`.
1287
1288 ## Used by
1289
1290 The following notable open-source projects trust _Black_ with enforcing a consistent
1291 code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy,
1292 Poetry, PyPA applications (Warehouse, Bandersnatch, Pipenv, virtualenv), pandas, Pillow,
1293 every Datadog Agent Integration, Home Assistant.
1294
1295 The following organizations use _Black_: Facebook, Dropbox.
1296
1297 Are we missing anyone? Let us know.
1298
1299 ## Testimonials
1300
1301 **Dusty Phillips**,
1302 [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
1303
1304 > _Black_ is opinionated so you don't have to be.
1305
1306 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core developer of
1307 Twisted and CPython:
1308
1309 > An auto-formatter that doesn't suck is all I want for Xmas!
1310
1311 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
1312
1313 > At least the name is good.
1314
1315 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/) and
1316 [`pipenv`](https://docs.pipenv.org/):
1317
1318 > This vastly improves the formatting of our code. Thanks a ton!
1319
1320 ## Show your style
1321
1322 Use the badge in your project's README.md:
1323
1324 ```markdown
1325 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1326 ```
1327
1328 Using the badge in README.rst:
1329
1330 ```
1331 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
1332     :target: https://github.com/psf/black
1333 ```
1334
1335 Looks like this:
1336 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
1337
1338 ## License
1339
1340 MIT
1341
1342 ## Contributing to _Black_
1343
1344 In terms of inspiration, _Black_ is about as configurable as _gofmt_. This is
1345 deliberate.
1346
1347 Bug reports and fixes are always welcome! However, before you suggest a new feature or
1348 configuration knob, ask yourself why you want it. If it enables better integration with
1349 some workflow, fixes an inconsistency, speeds things up, and so on - go for it! On the
1350 other hand, if your answer is "because I don't like a particular formatting" then you're
1351 not ready to embrace _Black_ yet. Such changes are unlikely to get accepted. You can
1352 still try but prepare to be disappointed.
1353
1354 More details can be found in
1355 [CONTRIBUTING](https://github.com/psf/black/blob/master/CONTRIBUTING.md).
1356
1357 ## Change Log
1358
1359 The log's become rather long. It moved to its own file.
1360
1361 See [CHANGES](https://github.com/psf/black/blob/master/CHANGES.md).
1362
1363 ## Authors
1364
1365 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1366
1367 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1368 [Carl Meyer](mailto:carl@oddbird.net),
1369 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
1370 [Mika Naylor](mailto:mail@autophagy.io),
1371 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com), and
1372 [Cooper Lees](mailto:me@cooperlees.com).
1373
1374 Multiple contributions by:
1375
1376 - [Abdur-Rahmaan Janhangeer](mailto:arj.python@gmail.com)
1377 - [Adam Johnson](mailto:me@adamj.eu)
1378 - [Alexander Huynh](mailto:github@grande.coffee)
1379 - [Andrew Thorp](mailto:andrew.thorp.dev@gmail.com)
1380 - [Andrey](mailto:dyuuus@yandex.ru)
1381 - [Andy Freeland](mailto:andy@andyfreeland.net)
1382 - [Anthony Sottile](mailto:asottile@umich.edu)
1383 - [Arjaan Buijk](mailto:arjaan.buijk@gmail.com)
1384 - [Artem Malyshev](mailto:proofit404@gmail.com)
1385 - [Asger Hautop Drewsen](mailto:asgerdrewsen@gmail.com)
1386 - [Augie Fackler](mailto:raf@durin42.com)
1387 - [Aviskar KC](mailto:aviskarkc10@gmail.com)
1388 - [Benjamin Woodruff](mailto:github@benjam.info)
1389 - [Brandt Bucher](mailto:brandtbucher@gmail.com)
1390 - Charles Reid
1391 - [Christian Heimes](mailto:christian@python.org)
1392 - [Chuck Wooters](mailto:chuck.wooters@microsoft.com)
1393 - [Cooper Ry Lees](mailto:me@cooperlees.com)
1394 - [Daniel Hahler](mailto:github@thequod.de)
1395 - [Daniel M. Capella](mailto:polycitizen@gmail.com)
1396 - Daniele Esposti
1397 - dylanjblack
1398 - [Eli Treuherz](mailto:eli@treuherz.com)
1399 - [Florent Thiery](mailto:fthiery@gmail.com)
1400 - hauntsaninja
1401 - Hugo van Kemenade
1402 - [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1403 - [Jason Fried](mailto:me@jasonfried.info)
1404 - [jgirardet](mailto:ijkl@netc.fr)
1405 - [Joe Antonakakis](mailto:jma353@cornell.edu)
1406 - [Jon Dufresne](mailto:jon.dufresne@gmail.com)
1407 - [Jonas Obrist](mailto:ojiidotch@gmail.com)
1408 - [Josh Bode](mailto:joshbode@fastmail.com)
1409 - [Juan Luis Cano Rodríguez](mailto:hello@juanlu.space)
1410 - [Katie McLaughlin](mailto:katie@glasnt.com)
1411 - Lawrence Chan
1412 - [Linus Groh](mailto:mail@linusgroh.de)
1413 - [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1414 - Mariatta
1415 - [Matt VanEseltine](mailto:vaneseltine@gmail.com)
1416 - [Michael Flaxman](mailto:michael.flaxman@gmail.com)
1417 - [Michael J. Sullivan](mailto:sully@msully.net)
1418 - [Michael McClimon](mailto:michael@mcclimon.org)
1419 - [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1420 - [Mike](mailto:roshi@fedoraproject.org)
1421 - [Min ho Kim](mailto:minho42@gmail.com)
1422 - [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
1423 - [Neraste](mailto:neraste.herr10@gmail.com)
1424 - [Ofek Lev](mailto:ofekmeister@gmail.com)
1425 - [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1426 - [Pablo Galindo](mailto:Pablogsal@gmail.com)
1427 - [Peter Bengtsson](mailto:mail@peterbe.com)
1428 - pmacosta
1429 - [Rishikesh Jha](mailto:rishijha424@gmail.com)
1430 - [Stavros Korokithakis](mailto:hi@stavros.io)
1431 - [Stephen Rosen](mailto:sirosen@globus.org)
1432 - [Sunil Kapil](mailto:snlkapil@gmail.com)
1433 - [Thom Lu](mailto:thomas.c.lu@gmail.com)
1434 - [Tom Christie](mailto:tom@tomchristie.com)
1435 - [Tzu-ping Chung](mailto:uranusjr@gmail.com)
1436 - [Utsav Shah](mailto:ukshah2@illinois.edu)
1437 - vezeli
1438 - [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
1439 - [Yngve Høiseth](mailto:yngve@hoiseth.net)
1440 - [Yurii Karabas](mailto:1998uriyyo@gmail.com)