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

d6e76cd8ae2f50219f5b592c1e887bd47c8b3dfd
[etc/vim.git] / README.md
1 ![Black Logo](https://raw.githubusercontent.com/ambv/black/master/docs/_static/logo2-readme.png)
2 <h2 align="center">The Uncompromising Code Formatter</h2>
3
4 <p align="center">
5 <a href="https://travis-ci.org/ambv/black"><img alt="Build Status" src="https://travis-ci.org/ambv/black.svg?branch=master"></a>
6 <a href="http://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="http://readthedocs.org/projects/black/badge/?version=stable"></a>
7 <a href="https://coveralls.io/github/ambv/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/ambv/black/badge.svg?branch=master"></a>
8 <a href="https://github.com/ambv/black/blob/master/LICENSE"><img alt="License: MIT" src="http://black.readthedocs.io/en/stable/_static/license.svg"></a>
9 <a href="https://pypi.python.org/pypi/black"><img alt="PyPI" src="http://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
10 <a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
11 </p>
12
13 > “Any color you like.”
14
15
16 *Black* is the uncompromising Python code formatter.  By using it, you
17 agree to cede control over minutiae of hand-formatting.  In return,
18 *Black* gives you speed, determinism, and freedom from `pycodestyle`
19 nagging about formatting.  You will save time and mental energy for
20 more important matters.
21
22 Blackened code looks the same regardless of the project you're reading.
23 Formatting becomes transparent after a while and you can focus on the
24 content instead.
25
26 *Black* makes code review faster by producing the smallest diffs
27 possible.
28
29 ---
30
31 *Contents:* **[Installation and usage](#installation-and-usage)** |
32 **[The *Black* code style](#the-black-code-style)** |
33 **[Editor integration](#editor-integration)** |
34 **[Version control integration](#version-control-integration)** |
35 **[Ignoring unmodified files](#ignoring-unmodified-files)** |
36 **[Testimonials](#testimonials)** |
37 **[Show your style](#show-your-style)** |
38 **[License](#license)** |
39 **[Contributing](#contributing-to-black)** |
40 **[Change Log](#change-log)** |
41 **[Authors](#authors)**
42
43 ---
44
45 ## Installation and usage
46
47 ### Installation
48
49 *Black* can be installed by running `pip install black`.  It requires
50 Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
51
52
53 ### Usage
54
55 To get started right away with sensible defaults:
56
57 ```
58 black {source_file_or_directory}
59 ```
60
61 ### Command line options
62
63 Black doesn't provide many options.  You can list them by running
64 `black --help`:
65
66 ```text
67 black [OPTIONS] [SRC]...
68
69 Options:
70   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
71   --py36                      Allow using Python 3.6-only syntax on all input
72                               files.  This will put trailing commas in function
73                               signatures and calls also after *args and
74                               **kwargs.  [default: per-file auto-detection]
75   --pyi                       Format all input files like typing stubs
76                               regardless of file extension (useful when piping
77                               source on standard input).
78   -S, --skip-string-normalization
79                               Don't normalize string quotes or prefixes.
80   --check                     Don't write the files back, just return the
81                               status.  Return code 0 means nothing would
82                               change.  Return code 1 means some files would be
83                               reformatted.  Return code 123 means there was an
84                               internal error.
85   --diff                      Don't write the files back, just output a diff
86                               for each file on stdout.
87   --fast / --safe             If --fast given, skip temporary sanity checks.
88                               [default: --safe]
89   --include TEXT              A regular expression that matches files and
90                               directories that should be included on
91                               recursive searches. On Windows, use forward
92                               slashes for directories.  [default: \.pyi?$]
93   --exclude TEXT              A regular expression that matches files and
94                               directories that should be excluded on
95                               recursive searches. On Windows, use forward
96                               slashes for directories.  [default:
97                               build/|buck-out/|dist/|_build/|\.git/|\.hg/|
98                               \.mypy_cache/|\.tox/|\.venv/]
99   -q, --quiet                 Don't emit non-error messages to stderr. Errors
100                               are still emitted, silence those with
101                               2>/dev/null.
102   -v, --verbose               Also emit messages to stderr about files
103                               that were not changed or were ignored due to
104                               --exclude=.
105   --version                   Show the version and exit.
106   --help                      Show this message and exit.
107 ```
108
109 *Black* is a well-behaved Unix-style command-line tool:
110 * it does nothing if no sources are passed to it;
111 * it will read from standard input and write to standard output if `-`
112   is used as the filename;
113 * it only outputs messages to users on standard error;
114 * exits with code 0 unless an internal error occurred (or `--check` was
115   used).
116
117
118 ### NOTE: This is a beta product
119
120 *Black* is already successfully used by several projects, small and big.
121 It also sports a decent test suite.  However, it is still very new.
122 Things will probably be wonky for a while. This is made explicit by the
123 "Beta" trove classifier, as well as by the "b" in the version number.
124 What this means for you is that **until the formatter becomes stable,
125 you should expect some formatting to change in the future**.  That being
126 said, no drastic stylistic changes are planned, mostly responses to bug
127 reports.
128
129 Also, as a temporary safety measure, *Black* will check that the
130 reformatted code still produces a valid AST that is equivalent to the
131 original.  This slows it down.  If you're feeling confident, use
132 ``--fast``.
133
134
135 ## The *Black* code style
136
137 *Black* reformats entire files in place.  It is not configurable.  It
138 doesn't take previous formatting into account.  It doesn't reformat
139 blocks that start with `# fmt: off` and end with `# fmt: on`.  It also
140 recognizes [YAPF](https://github.com/google/yapf)'s block comments to
141 the same effect, as a courtesy for straddling code.
142
143
144 ### How *Black* wraps lines
145
146 *Black* ignores previous formatting and applies uniform horizontal
147 and vertical whitespace to your code.  The rules for horizontal
148 whitespace can be summarized as: do whatever makes `pycodestyle` happy.
149 The coding style used by *Black* can be viewed as a strict subset of
150 PEP 8.
151
152 As for vertical whitespace, *Black* tries to render one full expression
153 or simple statement per line.  If this fits the allotted line length,
154 great.
155 ```py3
156 # in:
157
158 l = [1,
159      2,
160      3,
161 ]
162
163 # out:
164
165 l = [1, 2, 3]
166 ```
167
168 If not, *Black* will look at the contents of the first outer matching
169 brackets and put that in a separate indented line.
170 ```py3
171 # in:
172
173 TracebackException.from_exception(exc, limit, lookup_lines, capture_locals)
174
175 # out:
176
177 TracebackException.from_exception(
178     exc, limit, lookup_lines, capture_locals
179 )
180 ```
181
182 If that still doesn't fit the bill, it will decompose the internal
183 expression further using the same rule, indenting matching brackets
184 every time.  If the contents of the matching brackets pair are
185 comma-separated (like an argument list, or a dict literal, and so on)
186 then *Black* will first try to keep them on the same line with the
187 matching brackets.  If that doesn't work, it will put all of them in
188 separate lines.
189 ```py3
190 # in:
191
192 def very_important_function(template: str, *variables, file: os.PathLike, debug: bool = False):
193     """Applies `variables` to the `template` and writes to `file`."""
194     with open(file, 'w') as f:
195         ...
196
197 # out:
198
199 def very_important_function(
200     template: str,
201     *variables,
202     file: os.PathLike,
203     debug: bool = False,
204 ):
205     """Applies `variables` to the `template` and writes to `file`."""
206     with open(file, "w") as f:
207         ...
208 ```
209
210 You might have noticed that closing brackets are always dedented and
211 that a trailing comma is always added.  Such formatting produces smaller
212 diffs; when you add or remove an element, it's always just one line.
213 Also, having the closing bracket dedented provides a clear delimiter
214 between two distinct sections of the code that otherwise share the same
215 indentation level (like the arguments list and the docstring in the
216 example above).
217
218 If a data structure literal (tuple, list, set, dict) or a line of "from"
219 imports cannot fit in the allotted length, it's always split into one
220 element per line.  This minimizes diffs as well as enables readers of
221 code to find which commit introduced a particular entry.  This also
222 makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
223 the following configuration.
224
225 <details>
226 <summary>A compatible `.isort.cfg`</summary>
227
228 ```
229 [settings]
230 multi_line_output=3
231 include_trailing_comma=True
232 force_grid_wrap=0
233 combine_as_imports=True
234 line_length=88
235 ```
236
237 The equivalent command line is:
238 ```
239 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width=88 [ file.py ]
240 ```
241 </details>
242
243 ### Line length
244
245 You probably noticed the peculiar default line length.  *Black* defaults
246 to 88 characters per line, which happens to be 10% over 80.  This number
247 was found to produce significantly shorter files than sticking with 80
248 (the most popular), or even 79 (used by the standard library).  In
249 general, [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
250
251 If you're paid by the line of code you write, you can pass
252 `--line-length` with a lower number.  *Black* will try to respect that.
253 However, sometimes it won't be able to without breaking other rules.  In
254 those rare cases, auto-formatted code will exceed your allotted limit.
255
256 You can also increase it, but remember that people with sight disabilities
257 find it harder to work with line lengths exceeding 100 characters.
258 It also adversely affects side-by-side diff review  on typical screen
259 resolutions.  Long lines also make it harder to present code neatly
260 in documentation or talk slides.
261
262 If you're using Flake8, you can bump `max-line-length` to 88 and forget
263 about it.  Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
264 B950 warning instead of E501 and keep the max line length at 80 which
265 you are probably already using.  You'd do it like this:
266 ```ini
267 [flake8]
268 max-line-length = 80
269 ...
270 select = C,E,F,W,B,B950
271 ignore = E501
272 ```
273
274 You'll find *Black*'s own .flake8 config file is configured like this.
275 If you're curious about the reasoning behind B950, Bugbear's documentation
276 explains it.  The tl;dr is "it's like highway speed limits, we won't
277 bother you if you overdo it by a few km/h".
278
279
280 ### Empty lines
281
282 *Black* avoids spurious vertical whitespace.  This is in the spirit of
283 PEP 8 which says that in-function vertical whitespace should only be
284 used sparingly.
285
286 *Black* will allow single empty lines inside functions, and single and
287 double empty lines on module level left by the original editors, except
288 when they're within parenthesized expressions.  Since such expressions
289 are always reformatted to fit minimal space, this whitespace is lost.
290
291 It will also insert proper spacing before and after function definitions.
292 It's one line before and after inner functions and two lines before and
293 after module-level functions and classes.  *Black* will not put empty
294 lines between function/class definitions and standalone comments that
295 immediately precede the given function/class.
296
297 *Black* will enforce single empty lines between a class-level docstring
298 and the first following field or method.  This conforms to
299 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
300
301 *Black* won't insert empty lines after function docstrings unless that
302 empty line is required due to an inner function starting immediately
303 after.
304
305
306 ### Trailing commas
307
308 *Black* will add trailing commas to expressions that are split
309 by comma where each element is on its own line.  This includes function
310 signatures.
311
312 Unnecessary trailing commas are removed if an expression fits in one
313 line.  This makes it 1% more likely that your line won't exceed the
314 allotted line length limit.  Moreover, in this scenario, if you added
315 another argument to your call, you'd probably fit it in the same line
316 anyway.  That doesn't make diffs any larger.
317
318 One exception to removing trailing commas is tuple expressions with
319 just one element.  In this case *Black* won't touch the single trailing
320 comma as this would unexpectedly change the underlying data type.  Note
321 that this is also the case when commas are used while indexing.  This is
322 a tuple in disguise: ```numpy_array[3, ]```.
323
324 One exception to adding trailing commas is function signatures
325 containing `*`, `*args`, or `**kwargs`.  In this case a trailing comma
326 is only safe to use on Python 3.6.  *Black* will detect if your file is
327 already 3.6+ only and use trailing commas in this situation.  If you
328 wonder how it knows, it looks for f-strings and existing use of trailing
329 commas in function signatures that have stars in them.  In other words,
330 if you'd like a trailing comma in this situation and *Black* didn't
331 recognize it was safe to do so, put it there manually and *Black* will
332 keep it.
333
334
335 ### Strings
336
337 *Black* prefers double quotes (`"` and `"""`) over single quotes (`'`
338 and `'''`).  It will replace the latter with the former as long as it
339 does not result in more backslash escapes than before.
340
341 *Black* also standardizes string prefixes, making them always lowercase.
342 On top of that, if your code is already Python 3.6+ only or it's using
343 the `unicode_literals` future import, *Black* will remove `u` from the
344 string prefix as it is meaningless in those scenarios.
345
346 The main reason to standardize on a single form of quotes is aesthetics.
347 Having one kind of quotes everywhere reduces reader distraction.
348 It will also enable a future version of *Black* to merge consecutive
349 string literals that ended up on the same line (see
350 [#26](https://github.com/ambv/black/issues/26) for details).
351
352 Why settle on double quotes?  They anticipate apostrophes in English
353 text.  They match the docstring standard described in PEP 257.  An
354 empty string in double quotes (`""`) is impossible to confuse with
355 a one double-quote regardless of fonts and syntax highlighting used.
356 On top of this, double quotes for strings are consistent with C which
357 Python interacts a lot with.
358
359 On certain keyboard layouts like US English, typing single quotes is
360 a bit easier than double quotes.  The latter requires use of the Shift
361 key.  My recommendation here is to keep using whatever is faster to type
362 and let *Black* handle the transformation.
363
364 If you are adopting *Black* in a large project with pre-existing string
365 conventions (like the popular ["single quotes for data, double quotes for
366 human-readable strings"](https://stackoverflow.com/a/56190)), you can
367 pass `--skip-string-normalization` on the command line.  This is meant as
368 an adoption helper, avoid using this for new projects.
369
370
371 ### Line breaks & binary operators
372
373 *Black* will break a line before a binary operator when splitting a block
374 of code over multiple lines. This is so that *Black* is compliant with the
375 recent changes in the [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
376 style guide, which emphasizes that this approach improves readability.
377
378 This behaviour may raise ``W503 line break before binary operator`` warnings in
379 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
380 you should tell Flake8 to ignore these warnings.
381
382
383 ### Slices
384
385 PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
386 to treat ``:`` in slices as a binary operator with the lowest priority, and to
387 leave an equal amount of space on either side, except if a parameter is omitted
388 (e.g. ``ham[1 + 1 :]``). It also states that for extended slices, both ``:``
389 operators have to have the same amount of spacing, except if a parameter is
390 omitted (``ham[1 + 1 ::]``). *Black* enforces these rules consistently.
391
392 This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
393 enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
394 tell Flake8 to ignore these warnings.
395
396
397 ### Parentheses
398
399 Some parentheses are optional in the Python grammar.  Any expression can
400 be wrapped in a pair of parentheses to form an atom.  There are a few
401 interesting cases:
402
403 - `if (...):`
404 - `while (...):`
405 - `for (...) in (...):`
406 - `assert (...), (...)`
407 - `from X import (...)`
408 - assignments like:
409   - `target = (...)`
410   - `target: type = (...)`
411   - `some, *un, packing = (...)`
412   - `augmented += (...)`
413
414 In those cases, parentheses are removed when the entire statement fits
415 in one line, or if the inner expression doesn't have any delimiters to
416 further split on.  If there is only a single delimiter and the expression
417 starts or ends with a bracket, the parenthesis can also be successfully
418 omitted since the existing bracket pair will organize the expression
419 neatly anyway.  Otherwise, the parentheses are added.
420
421 Please note that *Black* does not add or remove any additional nested
422 parentheses that you might want to have for clarity or further
423 code organization.  For example those parentheses are not going to be
424 removed:
425 ```py3
426 return not (this or that)
427 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
428 ```
429
430
431 ### Call chains
432
433 Some popular APIs, like ORMs, use call chaining.  This API style is known
434 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).
435 *Black* formats those by treating dots that follow a call or an indexing
436 operation like a very low priority delimiter.  It's easier to show the
437 behavior than to explain it.  Look at the example:
438 ```py3
439 def example(session):
440     result = (
441         session.query(models.Customer.id)
442         .filter(
443             models.Customer.account_id == account_id,
444             models.Customer.email == email_address,
445         )
446         .order_by(models.Customer.id.asc())
447         .all()
448     )
449 ```
450
451
452 ### Typing stub files
453
454 PEP 484 describes the syntax for type hints in Python.  One of the
455 use cases for typing is providing type annotations for modules which
456 cannot contain them directly (they might be written in C, or they might
457 be third-party, or their implementation may be overly dynamic, and so on).
458
459 To solve this, [stub files with the `.pyi` file
460 extension](https://www.python.org/dev/peps/pep-0484/#stub-files) can be
461 used to describe typing information for an external module.  Those stub
462 files omit the implementation of classes and functions they
463 describe, instead they only contain the structure of the file (listing
464 globals, functions, and classes with their members).  The recommended
465 code style for those files is more terse than PEP 8:
466
467 * prefer `...` on the same line as the class/function signature;
468 * avoid vertical whitespace between consecutive module-level functions,
469   names, or methods and fields within a single class;
470 * use a single blank line between top-level class definitions, or none
471   if the classes are very small.
472
473 *Black* enforces the above rules.  There are additional guidelines for
474 formatting `.pyi` file that are not enforced yet but might be in
475 a future version of the formatter:
476
477 * all function bodies should be empty (contain `...` instead of the body);
478 * do not use docstrings;
479 * prefer `...` over `pass`;
480 * for arguments with a default, use `...` instead of the actual default;
481 * avoid using string literals in type annotations, stub files support
482   forward references natively (like Python 3.7 code with `from __future__
483   import annotations`);
484 * use variable annotations instead of type comments, even for stubs that
485   target older versions of Python;
486 * for arguments that default to `None`, use `Optional[]` explicitly;
487 * use `float` instead of `Union[int, float]`.
488
489
490 ## Editor integration
491
492 ### Emacs
493
494 Use [proofit404/blacken](https://github.com/proofit404/blacken).
495
496
497 ### PyCharm
498
499 1. Install `black`.
500
501 ```console
502 $ pip install black
503 ```
504
505 2. Locate your `black` installation folder.
506
507   On macOS / Linux / BSD:
508
509 ```console
510 $ which black
511 /usr/local/bin/black  # possible location
512 ```
513
514   On Windows:
515
516 ```console
517 $ where black
518 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
519 ```
520
521 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
522
523 4. Click the + icon to add a new external tool with the following values:
524     - Name: Black
525     - Description: Black is the uncompromising Python code formatter.
526     - Program: <install_location_from_step_2>
527     - Arguments: $FilePath$
528
529 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
530     - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.
531
532
533 ### Vim
534
535 Commands and shortcuts:
536
537 * `,=` or `:Black` to format the entire file (ranges not supported);
538 * `:BlackUpgrade` to upgrade *Black* inside the virtualenv;
539 * `:BlackVersion` to get the current version of *Black* inside the
540   virtualenv.
541
542 Configuration:
543 * `g:black_fast` (defaults to `0`)
544 * `g:black_linelength` (defaults to `88`)
545 * `g:black_virtualenv` (defaults to `~/.vim/black`)
546
547 To install with [vim-plug](https://github.com/junegunn/vim-plug):
548
549 ```
550 Plug 'ambv/black',
551 ```
552
553 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
554
555 ```
556 Plugin 'ambv/black'
557 ```
558
559 or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim).
560 Let me know if this requires any changes to work with Vim 8's builtin
561 `packadd`, or Pathogen, and so on.
562
563 This plugin **requires Vim 7.0+ built with Python 3.6+ support**.  It
564 needs Python 3.6 to be able to run *Black* inside the Vim process which
565 is much faster than calling an external command.
566
567 On first run, the plugin creates its own virtualenv using the right
568 Python version and automatically installs *Black*. You can upgrade it later
569 by calling `:BlackUpgrade` and restarting Vim.
570
571 If you need to do anything special to make your virtualenv work and
572 install *Black* (for example you want to run a version from master),
573 create a virtualenv manually and point `g:black_virtualenv` to it.
574 The plugin will use it.
575
576 To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
577
578 ```
579 autocmd BufWritePost *.py execute ':Black'
580 ```
581
582 **How to get Vim with Python 3.6?**
583 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
584 On macOS with Homebrew run: `brew install vim --with-python3`.
585 When building Vim from source, use:
586 `./configure --enable-python3interp=yes`. There's many guides online how
587 to do this.
588
589
590 ### Visual Studio Code
591
592 Use [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode).
593
594
595 ### SublimeText 3
596
597 Use [sublack plugin](https://github.com/jgirardet/sublack).
598
599
600 ### IPython Notebook Magic
601
602 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
603
604
605 ### Other editors
606
607 Atom/Nuclide integration is planned by the author, others will
608 require external contributions.
609
610 Patches welcome! ✨ 🍰 ✨
611
612 Any tool that can pipe code through *Black* using its stdio mode (just
613 [use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
614 The formatted code will be returned on stdout (unless `--check` was
615 passed).  *Black* will still emit messages on stderr but that shouldn't
616 affect your use case.
617
618 This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
619
620
621 ## Version control integration
622
623 Use [pre-commit](https://pre-commit.com/). Once you [have it
624 installed](https://pre-commit.com/#install), add this to the
625 `.pre-commit-config.yaml` in your repository:
626 ```yaml
627 repos:
628 -   repo: https://github.com/ambv/black
629     rev: stable
630     hooks:
631     - id: black
632       args: [--line-length=88, --safe]
633       language_version: python3.6
634 ```
635 Then run `pre-commit install` and you're ready to go.
636
637 `args` in the above config is optional but shows you how you can change
638 the line length if you really need to.  If you're already using Python
639 3.7, switch the `language_version` accordingly. Finally, `stable` is a tag
640 that is pinned to the latest release on PyPI.  If you'd rather run on
641 master, this is also an option.
642
643
644 ## Ignoring unmodified files
645
646 *Black* remembers files it has already formatted, unless the `--diff` flag is used or
647 code is passed via standard input. This information is stored per-user. The exact
648 location of the file depends on the black version and the system on which black
649 is run. The file is non-portable. The standard location on common operating systems
650 is:
651
652 * Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.pickle`
653 * macOS: `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.pickle`
654 * Linux: `/home/<username>/.cache/black/<version>/cache.<line-length>.pickle`
655
656
657 ## Testimonials
658
659 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
660
661 > Black is opinionated so you don't have to be.
662
663 **Hynek Schlawack**, [creator of `attrs`](http://www.attrs.org/), core
664 developer of Twisted and CPython:
665
666 > An auto-formatter that doesn't suck is all I want for Xmas!
667
668 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
669
670 > At least the name is good.
671
672 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
673 and [`pipenv`](https://docs.pipenv.org/):
674
675 > This vastly improves the formatting of our code. Thanks a ton!
676
677
678 ## Show your style
679
680 Use the badge in your project's README.md:
681
682 ```markdown
683 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
684 ```
685
686 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
687
688
689 ## License
690
691 MIT
692
693
694 ## Contributing to Black
695
696 In terms of inspiration, *Black* is about as configurable as *gofmt*.
697 This is deliberate.
698
699 Bug reports and fixes are always welcome!  However, before you suggest a
700 new feature or configuration knob, ask yourself why you want it.  If it
701 enables better integration with some workflow, fixes an inconsistency,
702 speeds things up, and so on - go for it!  On the other hand, if your
703 answer is "because I don't like a particular formatting" then you're not
704 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
705 You can still try but prepare to be disappointed.
706
707 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
708
709
710 ## Change Log
711
712 ### 18.6b1
713
714 * hotfix: don't output human-facing information on stdout (#299)
715
716 * hotfix: don't output cake emoji on non-zero return code (#300)
717
718
719 ### 18.6b0
720
721 * added `--include` and `--exclude` (#270)
722
723 * added `--skip-string-normalization` (#118)
724
725 * added `--verbose` (#283)
726
727 * the header output in `--diff` now actually conforms to the unified diff spec
728
729 * fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
730
731 * fixed unnecessary parentheses when a line contained multiline strings (#232)
732
733 * fixed stdin handling not working correctly if an old version of Click was
734   used (#276)
735
736 * *Black* now preserves line endings when formatting a file in place (#258)
737
738
739 ### 18.5b1
740
741 * added `--pyi` (#249)
742
743 * added `--py36` (#249)
744
745 * Python grammar pickle caches are stored with the formatting caches, making
746   *Black* work in environments where site-packages is not user-writable (#192)
747
748 * *Black* now enforces a PEP 257 empty line after a class-level docstring
749   (and/or fields) and the first method
750
751 * fixed invalid code produced when standalone comments were present in a trailer
752   that was omitted from line splitting on a large expression (#237)
753
754 * fixed optional parentheses being removed within `# fmt: off` sections (#224)
755
756 * fixed invalid code produced when stars in very long imports were incorrectly
757   wrapped in optional parentheses (#234)
758
759 * fixed unstable formatting when inline comments were moved around in
760   a trailer that was omitted from line splitting on a large expression
761   (#238)
762
763 * fixed extra empty line between a class declaration and the first
764   method if no class docstring or fields are present (#219)
765
766 * fixed extra empty line between a function signature and an inner
767   function or inner class (#196)
768
769
770 ### 18.5b0
771
772 * call chains are now formatted according to the
773   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface)
774   style (#67)
775
776 * data structure literals (tuples, lists, dictionaries, and sets) are
777   now also always exploded like imports when they don't fit in a single
778   line (#152)
779
780 * slices are now formatted according to PEP 8 (#178)
781
782 * parentheses are now also managed automatically on the right-hand side
783   of assignments and return statements (#140)
784
785 * math operators now use their respective priorities for delimiting multiline
786   expressions (#148)
787
788 * optional parentheses are now omitted on expressions that start or end
789   with a bracket and only contain a single operator (#177)
790
791 * empty parentheses in a class definition are now removed (#145, #180)
792
793 * string prefixes are now standardized to lowercase and `u` is removed
794   on Python 3.6+ only code and Python 2.7+ code with the `unicode_literals`
795   future import (#188, #198, #199)
796
797 * typing stub files (`.pyi`) are now formatted in a style that is consistent
798   with PEP 484 (#207, #210)
799
800 * progress when reformatting many files is now reported incrementally
801
802 * fixed trailers (content with brackets) being unnecessarily exploded
803   into their own lines after a dedented closing bracket (#119)
804
805 * fixed an invalid trailing comma sometimes left in imports (#185)
806
807 * fixed non-deterministic formatting when multiple pairs of removable parentheses
808   were used (#183)
809
810 * fixed multiline strings being unnecessarily wrapped in optional
811   parentheses in long assignments (#215)
812
813 * fixed not splitting long from-imports with only a single name
814
815 * fixed Python 3.6+ file discovery by also looking at function calls with
816   unpacking. This fixed non-deterministic formatting if trailing commas
817   where used both in function signatures with stars and function calls
818   with stars but the former would be reformatted to a single line.
819
820 * fixed crash on dealing with optional parentheses (#193)
821
822 * fixed "is", "is not", "in", and "not in" not considered operators for
823   splitting purposes
824
825 * fixed crash when dead symlinks where encountered
826
827
828 ### 18.4a4
829
830 * don't populate the cache on `--check` (#175)
831
832
833 ### 18.4a3
834
835 * added a "cache"; files already reformatted that haven't changed on disk
836   won't be reformatted again (#109)
837
838 * `--check` and `--diff` are no longer mutually exclusive (#149)
839
840 * generalized star expression handling, including double stars; this
841   fixes multiplication making expressions "unsafe" for trailing commas (#132)
842
843 * Black no longer enforces putting empty lines behind control flow statements
844   (#90)
845
846 * Black now splits imports like "Mode 3 + trailing comma" of isort (#127)
847
848 * fixed comment indentation when a standalone comment closes a block (#16, #32)
849
850 * fixed standalone comments receiving extra empty lines if immediately preceding
851   a class, def, or decorator (#56, #154)
852
853 * fixed `--diff` not showing entire path (#130)
854
855 * fixed parsing of complex expressions after star and double stars in
856   function calls (#2)
857
858 * fixed invalid splitting on comma in lambda arguments (#133)
859
860 * fixed missing splits of ternary expressions (#141)
861
862
863 ### 18.4a2
864
865 * fixed parsing of unaligned standalone comments (#99, #112)
866
867 * fixed placement of dictionary unpacking inside dictionary literals (#111)
868
869 * Vim plugin now works on Windows, too
870
871 * fixed unstable formatting when encountering unnecessarily escaped quotes
872   in a string (#120)
873
874
875 ### 18.4a1
876
877 * added `--quiet` (#78)
878
879 * added automatic parentheses management (#4)
880
881 * added [pre-commit](https://pre-commit.com) integration (#103, #104)
882
883 * fixed reporting on `--check` with multiple files (#101, #102)
884
885 * fixed removing backslash escapes from raw strings (#100, #105)
886
887
888 ### 18.4a0
889
890 * added `--diff` (#87)
891
892 * add line breaks before all delimiters, except in cases like commas, to
893   better comply with PEP 8 (#73)
894
895 * standardize string literals to use double quotes (almost) everywhere
896   (#75)
897
898 * fixed handling of standalone comments within nested bracketed
899   expressions; Black will no longer produce super long lines or put all
900   standalone comments at the end of the expression (#22)
901
902 * fixed 18.3a4 regression: don't crash and burn on empty lines with
903   trailing whitespace (#80)
904
905 * fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment
906   would cause Black to not emit the rest of the file (#95)
907
908 * when CTRL+C is pressed while formatting many files, Black no longer
909   freaks out with a flurry of asyncio-related exceptions
910
911 * only allow up to two empty lines on module level and only single empty
912   lines within functions (#74)
913
914
915 ### 18.3a4
916
917 * `# fmt: off` and `# fmt: on` are implemented (#5)
918
919 * automatic detection of deprecated Python 2 forms of print statements
920   and exec statements in the formatted file (#49)
921
922 * use proper spaces for complex expressions in default values of typed
923   function arguments (#60)
924
925 * only return exit code 1 when --check is used (#50)
926
927 * don't remove single trailing commas from square bracket indexing
928   (#59)
929
930 * don't omit whitespace if the previous factor leaf wasn't a math
931   operator (#55)
932
933 * omit extra space in kwarg unpacking if it's the first argument (#46)
934
935 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
936   (#68)
937
938
939 ### 18.3a3
940
941 * don't remove single empty lines outside of bracketed expressions
942   (#19)
943
944 * added ability to pipe formatting from stdin to stdin (#25)
945
946 * restored ability to format code with legacy usage of `async` as
947   a name (#20, #42)
948
949 * even better handling of numpy-style array indexing (#33, again)
950
951
952 ### 18.3a2
953
954 * changed positioning of binary operators to occur at beginning of lines
955   instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
956   (#21)
957
958 * ignore empty bracket pairs while splitting. This avoids very weirdly
959   looking formattings (#34, #35)
960
961 * remove a trailing comma if there is a single argument to a call
962
963 * if top level functions were separated by a comment, don't put four
964   empty lines after the upper function
965
966 * fixed unstable formatting of newlines with imports
967
968 * fixed unintentional folding of post scriptum standalone comments
969   into last statement if it was a simple statement (#18, #28)
970
971 * fixed missing space in numpy-style array indexing (#33)
972
973 * fixed spurious space after star-based unary expressions (#31)
974
975
976 ### 18.3a1
977
978 * added `--check`
979
980 * only put trailing commas in function signatures and calls if it's
981   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
982   only safe if there are no `*args` or `**kwargs` used in the signature
983   or call. (#8)
984
985 * fixed invalid spacing of dots in relative imports (#6, #13)
986
987 * fixed invalid splitting after comma on unpacked variables in for-loops
988   (#23)
989
990 * fixed spurious space in parenthesized set expressions (#7)
991
992 * fixed spurious space after opening parentheses and in default
993   arguments (#14, #17)
994
995 * fixed spurious space after unary operators when the operand was
996   a complex expression (#15)
997
998
999 ### 18.3a0
1000
1001 * first published version, Happy 🍰 Day 2018!
1002
1003 * alpha quality
1004
1005 * date-versioned (see: https://calver.org/)
1006
1007
1008 ## Authors
1009
1010 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1011
1012 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1013 [Carl Meyer](mailto:carl@oddbird.net),
1014 [Mika Naylor](mailto:mail@autophagy.io), and
1015 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
1016
1017 Multiple contributions by:
1018 * [Anthony Sottile](mailto:asottile@umich.edu)
1019 * [Artem Malyshev](mailto:proofit404@gmail.com)
1020 * [Christian Heimes](mailto:christian@python.org)
1021 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
1022 * [Eli Treuherz](mailto:eli.treuherz@cgi.com)
1023 * Hugo van Kemenade
1024 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1025 * [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com)
1026 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
1027 * [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1028 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1029 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1030 * [Stavros Korokithakis](mailto:hi@stavros.io)
1031 * [Sunil Kapil](mailto:snlkapil@gmail.com)
1032 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
1033
1034 ---
1035
1036 *Contents:*
1037 **[Installation and Usage](#installation-and-usage)** |
1038 **[The *Black* code style](#the-black-code-style)** |
1039 **[Editor integration](#editor-integration)** |
1040 **[Version control integration](#version-control-integration)** |
1041 **[Ignoring unmodified files](#ignoring-unmodified-files)** |
1042 **[Testimonials](#testimonials)** |
1043 **[Show your style](#show-your-style)** |
1044 **[License](#license)** |
1045 **[Contributing](#contributing-to-black)** |
1046 **[Change Log](#change-log)** |
1047 **[Authors](#authors)**