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

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