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

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