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

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