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

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