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

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