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

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