]> 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:

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