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

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