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

03cf81e40f34b5407159c634e01ca8aab115b947
[etc/vim.git] / README.md
1 ![Black Logo](https://raw.githubusercontent.com/psf/black/master/docs/_static/logo2-readme.png)
2
3 <h2 align="center">The Uncompromising Code Formatter</h2>
4
5 <p align="center">
6 <a href="https://travis-ci.com/psf/black"><img alt="Build Status" src="https://travis-ci.com/psf/black.svg?branch=master"></a>
7 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
8 <a href="https://coveralls.io/github/psf/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/psf/black/badge.svg?branch=master"></a>
9 <a href="https://github.com/psf/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
10 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://img.shields.io/pypi/v/black"></a>
11 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
12 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
13 </p>
14
15 > “Any color you like.”
16
17 _Black_ is the uncompromising Python code formatter. By using it, you agree to cede
18 control over minutiae of hand-formatting. In return, _Black_ gives you speed,
19 determinism, and freedom from `pycodestyle` nagging about formatting. You will save time
20 and mental energy for more important matters.
21
22 Blackened code looks the same regardless of the project you're reading. Formatting
23 becomes transparent after a while and you can focus on the content instead.
24
25 _Black_ makes code review faster by producing the smallest diffs possible.
26
27 Try it out now using the [Black Playground](https://black.now.sh). Watch the
28 [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
29
30 ---
31
32 _Contents:_ **[Installation and usage](#installation-and-usage)** |
33 **[Code style](#the-black-code-style)** | **[pyproject.toml](#pyprojecttoml)** |
34 **[Editor integration](#editor-integration)** | **[blackd](#blackd)** |
35 **[Version control integration](#version-control-integration)** |
36 **[Ignoring unmodified files](#ignoring-unmodified-files)** | **[Used by](#used-by)** |
37 **[Testimonials](#testimonials)** | **[Show your style](#show-your-style)** |
38 **[Contributing](#contributing-to-black)** | **[Change Log](#change-log)** |
39 **[Authors](#authors)**
40
41 ---
42
43 ## Installation and usage
44
45 ### Installation
46
47 _Black_ can be installed by running `pip install black`. It requires Python 3.6.0+ to
48 run but you can reformat Python 2 code with it, too.
49
50 ### Usage
51
52 To get started right away with sensible defaults:
53
54 ```
55 black {source_file_or_directory}
56 ```
57
58 ### Command line options
59
60 _Black_ doesn't provide many options. You can list them by running `black --help`:
61
62 ```text
63 black [OPTIONS] [SRC]...
64
65 Options:
66   -c, --code TEXT                 Format the code passed in as a string.
67   -l, --line-length INTEGER       How many characters per line to allow.
68                                   [default: 88]
69   -t, --target-version [py27|py33|py34|py35|py36|py37|py38]
70                                   Python versions that should be supported by
71                                   Black's output. [default: per-file auto-
72                                   detection]
73   --py36                          Allow using Python 3.6-only syntax on all
74                                   input files.  This will put trailing commas
75                                   in function signatures and calls also after
76                                   *args and **kwargs. Deprecated; use
77                                   --target-version instead. [default: per-file
78                                   auto-detection]
79   --pyi                           Format all input files like typing stubs
80                                   regardless of file extension (useful when
81                                   piping source on standard input).
82   -S, --skip-string-normalization
83                                   Don't normalize string quotes or prefixes.
84   --check                         Don't write the files back, just return the
85                                   status.  Return code 0 means nothing would
86                                   change.  Return code 1 means some files
87                                   would be reformatted.  Return code 123 means
88                                   there was an internal error.
89   --diff                          Don't write the files back, just output a
90                                   diff for each file on stdout.
91   --fast / --safe                 If --fast given, skip temporary sanity
92                                   checks. [default: --safe]
93   --include TEXT                  A regular expression that matches files and
94                                   directories that should be included on
95                                   recursive searches.  An empty value means
96                                   all files are included regardless of the
97                                   name.  Use forward slashes for directories
98                                   on all platforms (Windows, too).  Exclusions
99                                   are calculated first, inclusions later.
100                                   [default: \.pyi?$]
101   --exclude TEXT                  A regular expression that matches files and
102                                   directories that should be excluded on
103                                   recursive searches.  An empty value means no
104                                   paths are excluded. Use forward slashes for
105                                   directories on all platforms (Windows, too).
106                                   Exclusions are calculated first, inclusions
107                                   later.  [default: /(\.eggs|\.git|\.hg|\.mypy
108                                   _cache|\.nox|\.tox|\.venv|_build|buck-
109                                   out|build|dist)/]
110   -q, --quiet                     Don't emit non-error messages to stderr.
111                                   Errors are still emitted, silence those with
112                                   2>/dev/null.
113   -v, --verbose                   Also emit messages to stderr about files
114                                   that were not changed or were ignored due to
115                                   --exclude=.
116   --version                       Show the version and exit.
117   --config PATH                   Read configuration from PATH.
118   -h, --help                      Show this message and exit.
119 ```
120
121 _Black_ is a well-behaved Unix-style command-line tool:
122
123 - it does nothing if no sources are passed to it;
124 - it will read from standard input and write to standard output if `-` is used as the
125   filename;
126 - it only outputs messages to users on standard error;
127 - exits with code 0 unless an internal error occurred (or `--check` was used).
128
129 ### NOTE: This is a beta product
130
131 _Black_ is already [successfully used](#used-by) by many projects, small and big. It
132 also sports a decent test suite. However, it is still very new. Things will probably be
133 wonky for a while. This is made explicit by the "Beta" trove classifier, as well as by
134 the "b" in the version number. What this means for you is that **until the formatter
135 becomes stable, you should expect some formatting to change in the future**. That being
136 said, no drastic stylistic changes are planned, mostly responses to bug reports.
137
138 Also, as a temporary safety measure, _Black_ will check that the reformatted code still
139 produces a valid AST that is equivalent to the original. This slows it down. If you're
140 feeling confident, use `--fast`.
141
142 ## The _Black_ code style
143
144 _Black_ reformats entire files in place. It is not configurable. It doesn't take
145 previous formatting into account. It doesn't reformat blocks that start with
146 `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` have to be on the same level of
147 indentation. It also recognizes [YAPF](https://github.com/google/yapf)'s block comments
148 to the same effect, as a courtesy for straddling code.
149
150 ### How _Black_ wraps lines
151
152 _Black_ ignores previous formatting and applies uniform horizontal and vertical
153 whitespace to your code. The rules for horizontal whitespace can be summarized as: do
154 whatever makes `pycodestyle` happy. The coding style used by _Black_ can be viewed as a
155 strict subset of PEP 8.
156
157 As for vertical whitespace, _Black_ tries to render one full expression or simple
158 statement per line. If this fits the allotted line length, great.
159
160 ```py3
161 # in:
162
163 j = [1,
164      2,
165      3,
166 ]
167
168 # out:
169
170 j = [1, 2, 3]
171 ```
172
173 If not, _Black_ will look at the contents of the first outer matching brackets and put
174 that in a separate indented line.
175
176 ```py3
177 # in:
178
179 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
180
181 # out:
182
183 ImportantClass.important_method(
184     exc, limit, lookup_lines, capture_locals, extra_argument
185 )
186 ```
187
188 If that still doesn't fit the bill, it will decompose the internal expression further
189 using the same rule, indenting matching brackets every time. If the contents of the
190 matching brackets pair are comma-separated (like an argument list, or a dict literal,
191 and so on) then _Black_ will first try to keep them on the same line with the matching
192 brackets. If that doesn't work, it will put all of them in separate lines.
193
194 ```py3
195 # in:
196
197 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
198     """Applies `variables` to the `template` and writes to `file`."""
199     with open(file, 'w') as f:
200         ...
201
202 # out:
203
204 def very_important_function(
205     template: str,
206     *variables,
207     file: os.PathLike,
208     engine: str,
209     header: bool = True,
210     debug: bool = False,
211 ):
212     """Applies `variables` to the `template` and writes to `file`."""
213     with open(file, "w") as f:
214         ...
215 ```
216
217 You might have noticed that closing brackets are always dedented and that a trailing
218 comma is always added. Such formatting produces smaller diffs; when you add or remove an
219 element, it's always just one line. Also, having the closing bracket dedented provides a
220 clear delimiter between two distinct sections of the code that otherwise share the same
221 indentation level (like the arguments list and the docstring in the example above).
222
223 If a data structure literal (tuple, list, set, dict) or a line of "from" imports cannot
224 fit in the allotted length, it's always split into one element per line. This minimizes
225 diffs as well as enables readers of code to find which commit introduced a particular
226 entry. This also makes _Black_ compatible with [isort](https://pypi.org/p/isort/) with
227 the following configuration.
228
229 <details>
230 <summary>A compatible `.isort.cfg`</summary>
231
232 ```
233 [settings]
234 multi_line_output=3
235 include_trailing_comma=True
236 force_grid_wrap=0
237 use_parentheses=True
238 line_length=88
239 ```
240
241 The equivalent command line is:
242
243 ```
244 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
245 ```
246
247 </details>
248
249 ### Line length
250
251 You probably noticed the peculiar default line length. _Black_ defaults to 88 characters
252 per line, which happens to be 10% over 80. This number was found to produce
253 significantly shorter files than sticking with 80 (the most popular), or even 79 (used
254 by the standard library). In general,
255 [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
256
257 If you're paid by the line of code you write, you can pass `--line-length` with a lower
258 number. _Black_ will try to respect that. However, sometimes it won't be able to without
259 breaking other rules. In those rare cases, auto-formatted code will exceed your allotted
260 limit.
261
262 You can also increase it, but remember that people with sight disabilities find it
263 harder to work with line lengths exceeding 100 characters. It also adversely affects
264 side-by-side diff review on typical screen resolutions. Long lines also make it harder
265 to present code neatly in documentation or talk slides.
266
267 If you're using Flake8, you can bump `max-line-length` to 88 and forget about it.
268 Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s B950 warning
269 instead of E501 and keep the max line length at 80 which you are probably already using.
270 You'd do it like this:
271
272 ```ini
273 [flake8]
274 max-line-length = 80
275 ...
276 select = C,E,F,W,B,B950
277 ignore = E203, E501, W503
278 ```
279
280 You'll find _Black_'s own .flake8 config file is configured like this. Explanation of
281 why W503 and E203 are disabled can be found further in this documentation. And if you're
282 curious about the reasoning behind B950,
283 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
284 explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you
285 overdo it by a few km/h".
286
287 ### Empty lines
288
289 _Black_ avoids spurious vertical whitespace. This is in the spirit of PEP 8 which says
290 that in-function vertical whitespace should only be used sparingly.
291
292 _Black_ will allow single empty lines inside functions, and single and double empty
293 lines on module level left by the original editors, except when they're within
294 parenthesized expressions. Since such expressions are always reformatted to fit minimal
295 space, this whitespace is lost.
296
297 It will also insert proper spacing before and after function definitions. It's one line
298 before and after inner functions and two lines before and after module-level functions
299 and classes. _Black_ will not put empty lines between function/class definitions and
300 standalone comments that immediately precede the given function/class.
301
302 _Black_ will enforce single empty lines between a class-level docstring and the first
303 following field or method. This conforms to
304 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
305
306 _Black_ won't insert empty lines after function docstrings unless that empty line is
307 required due to an inner function starting immediately after.
308
309 ### Trailing commas
310
311 _Black_ will add trailing commas to expressions that are split by comma where each
312 element is on its own line. This includes function signatures.
313
314 Unnecessary trailing commas are removed if an expression fits in one line. This makes it
315 1% more likely that your line won't exceed the allotted line length limit. Moreover, in
316 this scenario, if you added another argument to your call, you'd probably fit it in the
317 same line anyway. That doesn't make diffs any larger.
318
319 One exception to removing trailing commas is tuple expressions with just one element. In
320 this case _Black_ won't touch the single trailing comma as this would unexpectedly
321 change the underlying data type. Note that this is also the case when commas are used
322 while indexing. This is a tuple in disguise: `numpy_array[3, ]`.
323
324 One exception to adding trailing commas is function signatures containing `*`, `*args`,
325 or `**kwargs`. In this case a trailing comma is only safe to use on Python 3.6. _Black_
326 will detect if your file is already 3.6+ only and use trailing commas in this situation.
327 If you wonder how it knows, it looks for f-strings and existing use of trailing commas
328 in function signatures that have stars in them. In other words, if you'd like a trailing
329 comma in this situation and _Black_ didn't recognize it was safe to do so, put it there
330 manually and _Black_ will keep it.
331
332 ### Strings
333
334 _Black_ prefers double quotes (`"` and `"""`) over single quotes (`'` and `'''`). It
335 will replace the latter with the former as long as it does not result in more backslash
336 escapes than before.
337
338 _Black_ also standardizes string prefixes, making them always lowercase. On top of that,
339 if your code is already Python 3.6+ only or it's using the `unicode_literals` future
340 import, _Black_ will remove `u` from the string prefix as it is meaningless in those
341 scenarios.
342
343 The main reason to standardize on a single form of quotes is aesthetics. Having one kind
344 of quotes everywhere reduces reader distraction. It will also enable a future version of
345 _Black_ to merge consecutive string literals that ended up on the same line (see
346 [#26](https://github.com/psf/black/issues/26) for details).
347
348 Why settle on double quotes? They anticipate apostrophes in English text. They match the
349 docstring standard described in
350 [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). An empty
351 string in double quotes (`""`) is impossible to confuse with a one double-quote
352 regardless of fonts and syntax highlighting used. On top of this, double quotes for
353 strings are consistent with C which Python interacts a lot with.
354
355 On certain keyboard layouts like US English, typing single quotes is a bit easier than
356 double quotes. The latter requires use of the Shift key. My recommendation here is to
357 keep using whatever is faster to type and let _Black_ handle the transformation.
358
359 If you are adopting _Black_ in a large project with pre-existing string conventions
360 (like the popular
361 ["single quotes for data, double quotes for human-readable strings"](https://stackoverflow.com/a/56190)),
362 you can pass `--skip-string-normalization` on the command line. This is meant as an
363 adoption helper, avoid using this for new projects.
364
365 ### Numeric literals
366
367 _Black_ standardizes most numeric literals to use lowercase letters for the syntactic
368 parts and uppercase letters for the digits themselves: `0xAB` instead of `0XAB` and
369 `1e10` instead of `1E10`. Python 2 long literals are styled as `2L` instead of `2l` to
370 avoid confusion between `l` and `1`.
371
372 ### Line breaks & binary operators
373
374 _Black_ will break a line before a binary operator when splitting a block of code over
375 multiple lines. This is so that _Black_ is compliant with the recent changes in the
376 [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
377 style guide, which emphasizes that this approach improves readability.
378
379 This behaviour may raise `W503 line break before binary operator` warnings in style
380 guide enforcement tools like Flake8. Since `W503` is not PEP 8 compliant, you should
381 tell Flake8 to ignore these warnings.
382
383 ### Slices
384
385 PEP 8
386 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
387 to treat `:` in slices as a binary operator with the lowest priority, and to leave an
388 equal amount of space on either side, except if a parameter is omitted (e.g.
389 `ham[1 + 1 :]`). It also states that for extended slices, both `:` operators have to
390 have the same amount of spacing, except if a parameter is omitted (`ham[1 + 1 ::]`).
391 _Black_ enforces these rules consistently.
392
393 This behaviour may raise `E203 whitespace before ':'` warnings in style guide
394 enforcement tools like Flake8. Since `E203` is not PEP 8 compliant, you should tell
395 Flake8 to ignore these warnings.
396
397 ### Parentheses
398
399 Some parentheses are optional in the Python grammar. Any expression can be wrapped in a
400 pair of parentheses to form an atom. There are a few interesting cases:
401
402 - `if (...):`
403 - `while (...):`
404 - `for (...) in (...):`
405 - `assert (...), (...)`
406 - `from X import (...)`
407 - assignments like:
408   - `target = (...)`
409   - `target: type = (...)`
410   - `some, *un, packing = (...)`
411   - `augmented += (...)`
412
413 In those cases, parentheses are removed when the entire statement fits in one line, or
414 if the inner expression doesn't have any delimiters to further split on. If there is
415 only a single delimiter and the expression starts or ends with a bracket, the
416 parenthesis can also be successfully omitted since the existing bracket pair will
417 organize the expression neatly anyway. Otherwise, the parentheses are added.
418
419 Please note that _Black_ does not add or remove any additional nested parentheses that
420 you might want to have for clarity or further code organization. For example those
421 parentheses are not going to be removed:
422
423 ```py3
424 return not (this or that)
425 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
426 ```
427
428 ### Call chains
429
430 Some popular APIs, like ORMs, use call chaining. This API style is known as a
431 [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface). _Black_ formats
432 those by treating dots that follow a call or an indexing operation like a very low
433 priority delimiter. It's easier to show the behavior than to explain it. Look at the
434 example:
435
436 ```py3
437 def example(session):
438     result = (
439         session.query(models.Customer.id)
440         .filter(
441             models.Customer.account_id == account_id,
442             models.Customer.email == email_address,
443         )
444         .order_by(models.Customer.id.asc())
445         .all()
446     )
447 ```
448
449 ### Typing stub files
450
451 PEP 484 describes the syntax for type hints in Python. One of the use cases for typing
452 is providing type annotations for modules which cannot contain them directly (they might
453 be written in C, or they might be third-party, or their implementation may be overly
454 dynamic, and so on).
455
456 To solve this,
457 [stub files with the `.pyi` file extension](https://www.python.org/dev/peps/pep-0484/#stub-files)
458 can be used to describe typing information for an external module. Those stub files omit
459 the implementation of classes and functions they describe, instead they only contain the
460 structure of the file (listing globals, functions, and classes with their members). The
461 recommended code style for those files is more terse than PEP 8:
462
463 - prefer `...` on the same line as the class/function signature;
464 - avoid vertical whitespace between consecutive module-level functions, names, or
465   methods and fields within a single class;
466 - use a single blank line between top-level class definitions, or none if the classes
467   are very small.
468
469 _Black_ enforces the above rules. There are additional guidelines for formatting `.pyi`
470 file that are not enforced yet but might be in a future version of the formatter:
471
472 - all function bodies should be empty (contain `...` instead of the body);
473 - do not use docstrings;
474 - prefer `...` over `pass`;
475 - for arguments with a default, use `...` instead of the actual default;
476 - avoid using string literals in type annotations, stub files support forward references
477   natively (like Python 3.7 code with `from __future__ import annotations`);
478 - use variable annotations instead of type comments, even for stubs that target older
479   versions of Python;
480 - for arguments that default to `None`, use `Optional[]` explicitly;
481 - use `float` instead of `Union[int, float]`.
482
483 ## pyproject.toml
484
485 _Black_ is able to read project-specific default values for its command line options
486 from a `pyproject.toml` file. This is especially useful for specifying custom
487 `--include` and `--exclude` patterns for your project.
488
489 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
490 "No". _Black_ is all about sensible defaults.
491
492 ### What on Earth is a `pyproject.toml` file?
493
494 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines `pyproject.toml` as a
495 configuration file to store build system requirements for Python projects. With the help
496 of tools like [Poetry](https://poetry.eustace.io/) or
497 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the need for
498 `setup.py` and `setup.cfg` files.
499
500 ### Where _Black_ looks for the file
501
502 By default _Black_ looks for `pyproject.toml` starting from the common base directory of
503 all files and directories passed on the command line. If it's not there, it looks in
504 parent directories. It stops looking when it finds the file, or a `.git` directory, or a
505 `.hg` directory, or the root of the file system, whichever comes first.
506
507 If you're formatting standard input, _Black_ will look for configuration starting from
508 the current working directory.
509
510 You can also explicitly specify the path to a particular file that you want with
511 `--config`. In this situation _Black_ will not look for any other file.
512
513 If you're running with `--verbose`, you will see a blue message if a file was found and
514 used.
515
516 Please note `blackd` will not use `pyproject.toml` configuration.
517
518 ### Configuration format
519
520 As the file extension suggests, `pyproject.toml` is a
521 [TOML](https://github.com/toml-lang/toml) file. It contains separate sections for
522 different tools. _Black_ is using the `[tool.black]` section. The option keys are the
523 same as long names of options on the command line.
524
525 Note that you have to use single-quoted strings in TOML for regular expressions. It's
526 the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
527 expressions by Black. Use `[ ]` to denote a significant space character.
528
529 <details>
530 <summary>Example `pyproject.toml`</summary>
531
532 ```toml
533 [tool.black]
534 line-length = 88
535 target-version = ['py37']
536 include = '\.pyi?$'
537 exclude = '''
538
539 (
540   /(
541       \.eggs         # exclude a few common directories in the
542     | \.git          # root of the project
543     | \.hg
544     | \.mypy_cache
545     | \.tox
546     | \.venv
547     | _build
548     | buck-out
549     | build
550     | dist
551   )/
552   | foo.py           # also separately exclude a file named foo.py in
553                      # the root of the project
554 )
555 '''
556 ```
557
558 </details>
559
560 ### Lookup hierarchy
561
562 Command-line options have defaults that you can see in `--help`. A `pyproject.toml` can
563 override those defaults. Finally, options provided by the user on the command line
564 override both.
565
566 _Black_ will only ever use one `pyproject.toml` file during an entire run. It doesn't
567 look for multiple files, and doesn't compose configuration from different levels of the
568 file hierarchy.
569
570 ## Editor integration
571
572 ### Emacs
573
574 Use [proofit404/blacken](https://github.com/proofit404/blacken) or
575 [Elpy](https://github.com/jorgenschaefer/elpy).
576
577 ### PyCharm/IntelliJ IDEA
578
579 1. Install `black`.
580
581 ```console
582 $ pip install black
583 ```
584
585 2. Locate your `black` installation folder.
586
587 On macOS / Linux / BSD:
588
589 ```console
590 $ which black
591 /usr/local/bin/black  # possible location
592 ```
593
594 On Windows:
595
596 ```console
597 $ where black
598 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
599 ```
600
601 3. Open External tools in PyCharm/IntelliJ IDEA
602
603 On macOS:
604
605 `PyCharm -> Preferences -> Tools -> External Tools`
606
607 On Windows / Linux / BSD:
608
609 `File -> Settings -> Tools -> External Tools`
610
611 4. Click the + icon to add a new external tool with the following values:
612
613    - Name: Black
614    - Description: Black is the uncompromising Python code formatter.
615    - Program: <install_location_from_step_2>
616    - Arguments: `"$FilePath$"`
617
618 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
619
620    - Alternatively, you can set a keyboard shortcut by navigating to
621      `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black`.
622
623 6. Optionally, run _Black_ on every file save:
624
625    1. Make sure you have the
626       [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin
627       installed.
628    2. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a
629       new watcher:
630       - Name: Black
631       - File type: Python
632       - Scope: Project Files
633       - Program: <install_location_from_step_2>
634       - Arguments: `$FilePath$`
635       - Output paths to refresh: `$FilePath$`
636       - Working directory: `$ProjectFileDir$`
637
638    - Uncheck "Auto-save edited files to trigger the watcher"
639
640 ### Wing IDE
641
642 Wing supports black via the OS Commands tool, as explained in the Wing documentation on
643 [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
644
645 1. Install `black`.
646
647 ```console
648 $ pip install black
649 ```
650
651 2. Make sure it runs from the command line, e.g.
652
653 ```console
654 $ black --help
655 ```
656
657 3. In Wing IDE, activate the **OS Commands** panel and define the command **black** to
658    execute black on the currently selected file:
659
660 - Use the Tools -> OS Commands menu selection
661 - click on **+** in **OS Commands** -> New: Command line..
662   - Title: black
663   - Command Line: black %s
664   - I/O Encoding: Use Default
665   - Key Binding: F1
666   - [x] Raise OS Commands when executed
667   - [x] Auto-save files before execution
668   - [x] Line mode
669
670 4. Select a file in the editor and press **F1** , or whatever key binding you selected
671    in step 3, to reformat the file.
672
673 ### Vim
674
675 Commands and shortcuts:
676
677 - `:Black` to format the entire file (ranges not supported);
678 - `:BlackUpgrade` to upgrade _Black_ inside the virtualenv;
679 - `:BlackVersion` to get the current version of _Black_ inside the virtualenv.
680
681 Configuration:
682
683 - `g:black_fast` (defaults to `0`)
684 - `g:black_linelength` (defaults to `88`)
685 - `g:black_skip_string_normalization` (defaults to `0`)
686 - `g:black_virtualenv` (defaults to `~/.vim/black` or `~/.local/share/nvim/black`)
687
688 To install with [vim-plug](https://github.com/junegunn/vim-plug):
689
690 ```
691 Plug 'psf/black'
692 ```
693
694 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
695
696 ```
697 Plugin 'psf/black'
698 ```
699
700 or you can copy the plugin from
701 [plugin/black.vim](https://github.com/psf/black/tree/master/plugin/black.vim).
702
703 ```
704 mkdir -p ~/.vim/pack/python/start/black/plugin
705 curl https://raw.githubusercontent.com/psf/black/master/plugin/black.vim -o ~/.vim/pack/python/start/black/plugin/black.vim
706 ```
707
708 Let me know if this requires any changes to work with Vim 8's builtin `packadd`, or
709 Pathogen, and so on.
710
711 This plugin **requires Vim 7.0+ built with Python 3.6+ support**. It needs Python 3.6 to
712 be able to run _Black_ inside the Vim process which is much faster than calling an
713 external command.
714
715 On first run, the plugin creates its own virtualenv using the right Python version and
716 automatically installs _Black_. You can upgrade it later by calling `:BlackUpgrade` and
717 restarting Vim.
718
719 If you need to do anything special to make your virtualenv work and install _Black_ (for
720 example you want to run a version from master), create a virtualenv manually and point
721 `g:black_virtualenv` to it. The plugin will use it.
722
723 To run _Black_ on save, add the following line to `.vimrc` or `init.vim`:
724
725 ```
726 autocmd BufWritePre *.py execute ':Black'
727 ```
728
729 To run _Black_ on a key press (e.g. F9 below), add this:
730
731 ```
732 nnoremap <F9> :Black<CR>
733 ```
734
735 **How to get Vim with Python 3.6?** On Ubuntu 17.10 Vim comes with Python 3.6 by
736 default. On macOS with Homebrew run: `brew install vim --with-python3`. When building
737 Vim from source, use: `./configure --enable-python3interp=yes`. There's many guides
738 online how to do this.
739
740 ### Visual Studio Code
741
742 Use the
743 [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
744 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
745
746 ### SublimeText 3
747
748 Use [sublack plugin](https://github.com/jgirardet/sublack).
749
750 ### Jupyter Notebook Magic
751
752 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
753
754 ### Python Language Server
755
756 If your editor supports the [Language Server Protocol](https://langserver.org/) (Atom,
757 Sublime Text, Visual Studio Code and many more), you can use the
758 [Python Language Server](https://github.com/palantir/python-language-server) with the
759 [pyls-black](https://github.com/rupert/pyls-black) plugin.
760
761 ### Atom/Nuclide
762
763 Use [python-black](https://atom.io/packages/python-black).
764
765 ### Kakoune
766
767 Add the following hook to your kakrc, then run black with `:format`.
768
769 ```
770 hook global WinSetOption filetype=python %{
771     set-option window formatcmd 'black -q  -'
772 }
773 ```
774
775 ### Other editors
776
777 Other editors will require external contributions.
778
779 Patches welcome! ✨ 🍰 ✨
780
781 Any tool that can pipe code through _Black_ using its stdio mode (just
782 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
783 The formatted code will be returned on stdout (unless `--check` was passed). _Black_
784 will still emit messages on stderr but that shouldn't affect your use case.
785
786 This can be used for example with PyCharm's or IntelliJ's
787 [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
788
789 ## blackd
790
791 `blackd` is a small HTTP server that exposes _Black_'s functionality over a simple
792 protocol. The main benefit of using it is to avoid paying the cost of starting up a new
793 _Black_ process every time you want to blacken a file.
794
795 ### Usage
796
797 `blackd` is not packaged alongside _Black_ by default because it has additional
798 dependencies. You will need to do `pip install black[d]` to install it.
799
800 You can start the server on the default port, binding only to the local interface by
801 running `blackd`. You will see a single line mentioning the server's version, and the
802 host and port it's listening on. `blackd` will then print an access log similar to most
803 web servers on standard output, merged with any exception traces caused by invalid
804 formatting requests.
805
806 `blackd` provides even less options than _Black_. You can see them by running
807 `blackd --help`:
808
809 ```text
810 Usage: blackd [OPTIONS]
811
812 Options:
813   --bind-host TEXT                Address to bind the server to.
814   --bind-port INTEGER             Port to listen on
815   --version                       Show the version and exit.
816   -h, --help                      Show this message and exit.
817 ```
818
819 There is no official blackd client tool (yet!). You can test that blackd is working
820 using `curl`:
821
822 ```
823 blackd --bind-port 9090 &  # or let blackd choose a port
824 curl -s -XPOST "localhost:9090" -d "print('valid')"
825 ```
826
827 ### Protocol
828
829 `blackd` only accepts `POST` requests at the `/` path. The body of the request should
830 contain the python source code to be formatted, encoded according to the `charset` field
831 in the `Content-Type` request header. If no `charset` is specified, `blackd` assumes
832 `UTF-8`.
833
834 There are a few HTTP headers that control how the source is formatted. These correspond
835 to command line flags for _Black_. There is one exception to this: `X-Protocol-Version`
836 which if present, should have the value `1`, otherwise the request is rejected with
837 `HTTP 501` (Not Implemented).
838
839 The headers controlling how code is formatted are:
840
841 - `X-Line-Length`: corresponds to the `--line-length` command line flag.
842 - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization`
843   command line flag. If present and its value is not the empty string, no string
844   normalization will be performed.
845 - `X-Fast-Or-Safe`: if set to `fast`, `blackd` will act as _Black_ does when passed the
846   `--fast` command line flag.
847 - `X-Python-Variant`: if set to `pyi`, `blackd` will act as _Black_ does when passed the
848   `--pyi` command line flag. Otherwise, its value must correspond to a Python version or
849   a set of comma-separated Python versions, optionally prefixed with `py`. For example,
850   to request code that is compatible with Python 3.5 and 3.6, set the header to
851   `py3.5,py3.6`.
852 - `X-Diff`: corresponds to the `--diff` command line flag. If present, a diff of the
853   formats will be output.
854
855 If any of these headers are set to invalid values, `blackd` returns a `HTTP 400` error
856 response, mentioning the name of the problematic header in the message body.
857
858 Apart from the above, `blackd` can produce the following response codes:
859
860 - `HTTP 204`: If the input is already well-formatted. The response body is empty.
861 - `HTTP 200`: If formatting was needed on the input. The response body contains the
862   blackened Python code, and the `Content-Type` header is set accordingly.
863 - `HTTP 400`: If the input contains a syntax error. Details of the error are returned in
864   the response body.
865 - `HTTP 500`: If there was any kind of error while trying to format the input. The
866   response body contains a textual representation of the error.
867
868 The response headers include a `X-Black-Version` header containing the version of
869 _Black_.
870
871 ## Version control integration
872
873 Use [pre-commit](https://pre-commit.com/). Once you
874 [have it installed](https://pre-commit.com/#install), add this to the
875 `.pre-commit-config.yaml` in your repository:
876
877 ```yaml
878 repos:
879   - repo: https://github.com/psf/black
880     rev: stable
881     hooks:
882       - id: black
883         language_version: python3.6
884 ```
885
886 Then run `pre-commit install` and you're ready to go.
887
888 Avoid using `args` in the hook. Instead, store necessary configuration in
889 `pyproject.toml` so that editors and command-line usage of Black all behave consistently
890 for your project. See _Black_'s own [pyproject.toml](/pyproject.toml) for an example.
891
892 If you're already using Python 3.7, switch the `language_version` accordingly. Finally,
893 `stable` is a tag that is pinned to the latest release on PyPI. If you'd rather run on
894 master, this is also an option.
895
896 ## Ignoring unmodified files
897
898 _Black_ remembers files it has already formatted, unless the `--diff` flag is used or
899 code is passed via standard input. This information is stored per-user. The exact
900 location of the file depends on the _Black_ version and the system on which _Black_ is
901 run. The file is non-portable. The standard location on common operating systems is:
902
903 - Windows:
904   `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle`
905 - macOS:
906   `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle`
907 - Linux:
908   `/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle`
909
910 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
911 as .pyi, and whether string normalization was omitted.
912
913 To override the location of these files on macOS or Linux, set the environment variable
914 `XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache
915 in the directory you're running _Black_ from, set `XDG_CACHE_HOME=.cache`. _Black_ will
916 then write the above files to `.cache/black/<version>/`.
917
918 ## Used by
919
920 The following notable open-source projects trust _Black_ with enforcing a consistent
921 code style: pytest, tox, Pyramid, Django Channels, Hypothesis, attrs, SQLAlchemy,
922 Poetry, PyPA applications (Warehouse, Pipenv, virtualenv), pandas, Pillow, every Datadog
923 Agent Integration.
924
925 Are we missing anyone? Let us know.
926
927 ## Testimonials
928
929 **Dusty Phillips**,
930 [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
931
932 > _Black_ is opinionated so you don't have to be.
933
934 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core developer of
935 Twisted and CPython:
936
937 > An auto-formatter that doesn't suck is all I want for Xmas!
938
939 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
940
941 > At least the name is good.
942
943 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/) and
944 [`pipenv`](https://docs.pipenv.org/):
945
946 > This vastly improves the formatting of our code. Thanks a ton!
947
948 ## Show your style
949
950 Use the badge in your project's README.md:
951
952 ```markdown
953 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
954 ```
955
956 Using the badge in README.rst:
957
958 ```
959 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
960     :target: https://github.com/psf/black
961 ```
962
963 Looks like this:
964 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
965
966 ## License
967
968 MIT
969
970 ## Contributing to _Black_
971
972 In terms of inspiration, _Black_ is about as configurable as _gofmt_. This is
973 deliberate.
974
975 Bug reports and fixes are always welcome! However, before you suggest a new feature or
976 configuration knob, ask yourself why you want it. If it enables better integration with
977 some workflow, fixes an inconsistency, speeds things up, and so on - go for it! On the
978 other hand, if your answer is "because I don't like a particular formatting" then you're
979 not ready to embrace _Black_ yet. Such changes are unlikely to get accepted. You can
980 still try but prepare to be disappointed.
981
982 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
983
984 ## Change Log
985
986 ### 19.10b0
987
988 - added support for PEP 572 assignment expressions (#711)
989
990 - added support for PEP 570 positional-only arguments (#943)
991
992 - added support for async generators (#593)
993
994 - added support for pre-splitting collections by putting an explicit trailing comma
995   inside (#826)
996
997 - added `black -c` as a way to format code passed from the command line (#761)
998
999 - --safe now works with Python 2 code (#840)
1000
1001 - fixed grammar selection for Python 2-specific code (#765)
1002
1003 - fixed feature detection for trailing commas in function definitions and call sites
1004   (#763)
1005
1006 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
1007   code now behave correctly (#1005)
1008
1009 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
1010
1011 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
1012
1013 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
1014
1015 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
1016
1017 - _Black_ no longer fails on comments in from-imports (#671)
1018
1019 - _Black_ no longer fails when the file starts with a backslash (#922)
1020
1021 - _Black_ no longer merges regular comments with type comments (#1027)
1022
1023 - _Black_ no longer splits long lines that contain type comments (#997)
1024
1025 - removed unnecessary parentheses around `yield` expressions (#834)
1026
1027 - added parentheses around long tuples in unpacking assignments (#832)
1028
1029 - added parentheses around complex powers when they are prefixed by a unary operator
1030   (#646)
1031
1032 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
1033
1034 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
1035   (#863)
1036
1037 - if _Black_ puts parenthesis around a single expression, it moves comments to the
1038   wrapped expression instead of after the brackets (#872)
1039
1040 - `blackd` now returns the version of _Black_ in the response headers (#1013)
1041
1042 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
1043   provided (#969)
1044
1045 ### 19.3b0
1046
1047 - new option `--target-version` to control which Python versions _Black_-formatted code
1048   should target (#618)
1049
1050 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
1051
1052 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
1053
1054 - long `del` statements are now split into multiple lines (#698)
1055
1056 - type comments are no longer mangled in function signatures
1057
1058 - improved performance of formatting deeply nested data structures (#509)
1059
1060 - _Black_ now properly formats multiple files in parallel on Windows (#632)
1061
1062 - _Black_ now creates cache files atomically which allows it to be used in parallel
1063   pipelines (like `xargs -P8`) (#673)
1064
1065 - _Black_ now correctly indents comments in files that were previously formatted with
1066   tabs (#262)
1067
1068 - `blackd` now supports CORS (#622)
1069
1070 ### 18.9b0
1071
1072 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
1073
1074   - numeric literals are normalized to include `_` separators on Python 3.6+ code
1075
1076   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
1077     leave numeric underscores as they were in the input
1078
1079   - code with `_` in numeric literals is recognized as Python 3.6+
1080
1081   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
1082
1083   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
1084
1085 - added `blackd`, see [its documentation](#blackd) for more info (#349)
1086
1087 - adjacent string literals are now correctly split into multiple lines (#463)
1088
1089 - trailing comma is now added to single imports that don't fit on a line (#250)
1090
1091 - cache is now populated when `--check` is successful for a file which speeds up
1092   consecutive checks of properly formatted unmodified files (#448)
1093
1094 - whitespace at the beginning of the file is now removed (#399)
1095
1096 - fixed mangling [pweave](http://mpastell.com/pweave/) and
1097   [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532)
1098
1099 - fixed unstable formatting when unpacking big tuples (#267)
1100
1101 - fixed parsing of `__future__` imports with renames (#389)
1102
1103 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
1104
1105 - fixed formatting of lambda expressions with default arguments (#468)
1106
1107 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
1108
1109 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
1110   be a bad idea (#415)
1111
1112 ### 18.6b4
1113
1114 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
1115
1116 ### 18.6b3
1117
1118 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
1119
1120 - `# fmt: off` and `# fmt: on` are now much more dependable:
1121
1122   - they now work also within bracket pairs (#329)
1123
1124   - they now correctly work across function/class boundaries (#335)
1125
1126   - they now work when an indentation block starts with empty lines or misaligned
1127     comments (#334)
1128
1129 - made Click not fail on invalid environments; note that Click is right but the
1130   likelihood we'll need to access non-ASCII file paths when dealing with Python source
1131   code is low (#277)
1132
1133 - fixed improper formatting of f-strings with quotes inside interpolated expressions
1134   (#322)
1135
1136 - fixed unnecessary slowdown when long list literals where found in a file
1137
1138 - fixed unnecessary slowdown on AST nodes with very many siblings
1139
1140 - fixed cannibalizing backslashes during string normalization
1141
1142 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
1143
1144 ### 18.6b2
1145
1146 - added `--config` (#65)
1147
1148 - added `-h` equivalent to `--help` (#316)
1149
1150 - fixed improper unmodified file caching when `-S` was used
1151
1152 - fixed extra space in string unpacking (#305)
1153
1154 - fixed formatting of empty triple quoted strings (#313)
1155
1156 - fixed unnecessary slowdown in comment placement calculation on lines without comments
1157
1158 ### 18.6b1
1159
1160 - hotfix: don't output human-facing information on stdout (#299)
1161
1162 - hotfix: don't output cake emoji on non-zero return code (#300)
1163
1164 ### 18.6b0
1165
1166 - added `--include` and `--exclude` (#270)
1167
1168 - added `--skip-string-normalization` (#118)
1169
1170 - added `--verbose` (#283)
1171
1172 - the header output in `--diff` now actually conforms to the unified diff spec
1173
1174 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1175
1176 - fixed unnecessary parentheses when a line contained multiline strings (#232)
1177
1178 - fixed stdin handling not working correctly if an old version of Click was used (#276)
1179
1180 - _Black_ now preserves line endings when formatting a file in place (#258)
1181
1182 ### 18.5b1
1183
1184 - added `--pyi` (#249)
1185
1186 - added `--py36` (#249)
1187
1188 - Python grammar pickle caches are stored with the formatting caches, making _Black_
1189   work in environments where site-packages is not user-writable (#192)
1190
1191 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
1192   fields) and the first method
1193
1194 - fixed invalid code produced when standalone comments were present in a trailer that
1195   was omitted from line splitting on a large expression (#237)
1196
1197 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
1198
1199 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
1200   in optional parentheses (#234)
1201
1202 - fixed unstable formatting when inline comments were moved around in a trailer that was
1203   omitted from line splitting on a large expression (#238)
1204
1205 - fixed extra empty line between a class declaration and the first method if no class
1206   docstring or fields are present (#219)
1207
1208 - fixed extra empty line between a function signature and an inner function or inner
1209   class (#196)
1210
1211 ### 18.5b0
1212
1213 - call chains are now formatted according to the
1214   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
1215
1216 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
1217   exploded like imports when they don't fit in a single line (#152)
1218
1219 - slices are now formatted according to PEP 8 (#178)
1220
1221 - parentheses are now also managed automatically on the right-hand side of assignments
1222   and return statements (#140)
1223
1224 - math operators now use their respective priorities for delimiting multiline
1225   expressions (#148)
1226
1227 - optional parentheses are now omitted on expressions that start or end with a bracket
1228   and only contain a single operator (#177)
1229
1230 - empty parentheses in a class definition are now removed (#145, #180)
1231
1232 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
1233   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
1234   #199)
1235
1236 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
1237   484 (#207, #210)
1238
1239 - progress when reformatting many files is now reported incrementally
1240
1241 - fixed trailers (content with brackets) being unnecessarily exploded into their own
1242   lines after a dedented closing bracket (#119)
1243
1244 - fixed an invalid trailing comma sometimes left in imports (#185)
1245
1246 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
1247   used (#183)
1248
1249 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
1250   assignments (#215)
1251
1252 - fixed not splitting long from-imports with only a single name
1253
1254 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
1255   This fixed non-deterministic formatting if trailing commas where used both in function
1256   signatures with stars and function calls with stars but the former would be
1257   reformatted to a single line.
1258
1259 - fixed crash on dealing with optional parentheses (#193)
1260
1261 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
1262   purposes
1263
1264 - fixed crash when dead symlinks where encountered
1265
1266 ### 18.4a4
1267
1268 - don't populate the cache on `--check` (#175)
1269
1270 ### 18.4a3
1271
1272 - added a "cache"; files already reformatted that haven't changed on disk won't be
1273   reformatted again (#109)
1274
1275 - `--check` and `--diff` are no longer mutually exclusive (#149)
1276
1277 - generalized star expression handling, including double stars; this fixes
1278   multiplication making expressions "unsafe" for trailing commas (#132)
1279
1280 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
1281
1282 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
1283
1284 - fixed comment indentation when a standalone comment closes a block (#16, #32)
1285
1286 - fixed standalone comments receiving extra empty lines if immediately preceding a
1287   class, def, or decorator (#56, #154)
1288
1289 - fixed `--diff` not showing entire path (#130)
1290
1291 - fixed parsing of complex expressions after star and double stars in function calls
1292   (#2)
1293
1294 - fixed invalid splitting on comma in lambda arguments (#133)
1295
1296 - fixed missing splits of ternary expressions (#141)
1297
1298 ### 18.4a2
1299
1300 - fixed parsing of unaligned standalone comments (#99, #112)
1301
1302 - fixed placement of dictionary unpacking inside dictionary literals (#111)
1303
1304 - Vim plugin now works on Windows, too
1305
1306 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
1307   (#120)
1308
1309 ### 18.4a1
1310
1311 - added `--quiet` (#78)
1312
1313 - added automatic parentheses management (#4)
1314
1315 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
1316
1317 - fixed reporting on `--check` with multiple files (#101, #102)
1318
1319 - fixed removing backslash escapes from raw strings (#100, #105)
1320
1321 ### 18.4a0
1322
1323 - added `--diff` (#87)
1324
1325 - add line breaks before all delimiters, except in cases like commas, to better comply
1326   with PEP 8 (#73)
1327
1328 - standardize string literals to use double quotes (almost) everywhere (#75)
1329
1330 - fixed handling of standalone comments within nested bracketed expressions; _Black_
1331   will no longer produce super long lines or put all standalone comments at the end of
1332   the expression (#22)
1333
1334 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
1335   (#80)
1336
1337 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
1338   _Black_ to not emit the rest of the file (#95)
1339
1340 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
1341   a flurry of asyncio-related exceptions
1342
1343 - only allow up to two empty lines on module level and only single empty lines within
1344   functions (#74)
1345
1346 ### 18.3a4
1347
1348 - `# fmt: off` and `# fmt: on` are implemented (#5)
1349
1350 - automatic detection of deprecated Python 2 forms of print statements and exec
1351   statements in the formatted file (#49)
1352
1353 - use proper spaces for complex expressions in default values of typed function
1354   arguments (#60)
1355
1356 - only return exit code 1 when --check is used (#50)
1357
1358 - don't remove single trailing commas from square bracket indexing (#59)
1359
1360 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
1361
1362 - omit extra space in kwarg unpacking if it's the first argument (#46)
1363
1364 - omit extra space in
1365   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1366   (#68)
1367
1368 ### 18.3a3
1369
1370 - don't remove single empty lines outside of bracketed expressions (#19)
1371
1372 - added ability to pipe formatting from stdin to stdin (#25)
1373
1374 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
1375
1376 - even better handling of numpy-style array indexing (#33, again)
1377
1378 ### 18.3a2
1379
1380 - changed positioning of binary operators to occur at beginning of lines instead of at
1381   the end, following
1382   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1383   (#21)
1384
1385 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
1386   formattings (#34, #35)
1387
1388 - remove a trailing comma if there is a single argument to a call
1389
1390 - if top level functions were separated by a comment, don't put four empty lines after
1391   the upper function
1392
1393 - fixed unstable formatting of newlines with imports
1394
1395 - fixed unintentional folding of post scriptum standalone comments into last statement
1396   if it was a simple statement (#18, #28)
1397
1398 - fixed missing space in numpy-style array indexing (#33)
1399
1400 - fixed spurious space after star-based unary expressions (#31)
1401
1402 ### 18.3a1
1403
1404 - added `--check`
1405
1406 - only put trailing commas in function signatures and calls if it's safe to do so. If
1407   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
1408   or `**kwargs` used in the signature or call. (#8)
1409
1410 - fixed invalid spacing of dots in relative imports (#6, #13)
1411
1412 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
1413
1414 - fixed spurious space in parenthesized set expressions (#7)
1415
1416 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
1417
1418 - fixed spurious space after unary operators when the operand was a complex expression
1419   (#15)
1420
1421 ### 18.3a0
1422
1423 - first published version, Happy 🍰 Day 2018!
1424
1425 - alpha quality
1426
1427 - date-versioned (see: https://calver.org/)
1428
1429 ## Authors
1430
1431 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1432
1433 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1434 [Carl Meyer](mailto:carl@oddbird.net),
1435 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
1436 [Mika Naylor](mailto:mail@autophagy.io), and
1437 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
1438
1439 Multiple contributions by:
1440
1441 - [Abdur-Rahmaan Janhangeer](mailto:cryptolabour@gmail.com)
1442 - [Adam Johnson](mailto:me@adamj.eu)
1443 - [Alexander Huynh](mailto:github@grande.coffee)
1444 - [Andrew Thorp](mailto:andrew.thorp.dev@gmail.com)
1445 - [Andrey](mailto:dyuuus@yandex.ru)
1446 - [Andy Freeland](mailto:andy@andyfreeland.net)
1447 - [Anthony Sottile](mailto:asottile@umich.edu)
1448 - [Arjaan Buijk](mailto:arjaan.buijk@gmail.com)
1449 - [Artem Malyshev](mailto:proofit404@gmail.com)
1450 - [Asger Hautop Drewsen](mailto:asgerdrewsen@gmail.com)
1451 - [Augie Fackler](mailto:raf@durin42.com)
1452 - [Aviskar KC](mailto:aviskarkc10@gmail.com)
1453 - [Benjamin Woodruff](mailto:github@benjam.info)
1454 - [Brandt Bucher](mailto:brandtbucher@gmail.com)
1455 - Charles Reid
1456 - [Christian Heimes](mailto:christian@python.org)
1457 - [Chuck Wooters](mailto:chuck.wooters@microsoft.com)
1458 - [Daniel Hahler](mailto:github@thequod.de)
1459 - [Daniel M. Capella](mailto:polycitizen@gmail.com)
1460 - Daniele Esposti
1461 - dylanjblack
1462 - [Eli Treuherz](mailto:eli@treuherz.com)
1463 - [Florent Thiery](mailto:fthiery@gmail.com)
1464 - hauntsaninja
1465 - Hugo van Kemenade
1466 - [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1467 - [Jason Fried](mailto:me@jasonfried.info)
1468 - [jgirardet](mailto:ijkl@netc.fr)
1469 - [Joe Antonakakis](mailto:jma353@cornell.edu)
1470 - [Jon Dufresne](mailto:jon.dufresne@gmail.com)
1471 - [Jonas Obrist](mailto:ojiidotch@gmail.com)
1472 - [Josh Bode](mailto:joshbode@fastmail.com)
1473 - [Juan Luis Cano Rodríguez](mailto:hello@juanlu.space)
1474 - [Katie McLaughlin](mailto:katie@glasnt.com)
1475 - Lawrence Chan
1476 - [Linus Groh](mailto:mail@linusgroh.de)
1477 - [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1478 - Mariatta
1479 - [Matt VanEseltine](mailto:vaneseltine@gmail.com)
1480 - [Michael Flaxman](mailto:michael.flaxman@gmail.com)
1481 - [Michael J. Sullivan](mailto:sully@msully.net)
1482 - [Michael McClimon](mailto:michael@mcclimon.org)
1483 - [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1484 - [Mike](mailto:roshi@fedoraproject.org)
1485 - [Min ho Kim](mailto:minho42@gmail.com)
1486 - [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
1487 - [Neraste](mailto:neraste.herr10@gmail.com)
1488 - [Ofek Lev](mailto:ofekmeister@gmail.com)
1489 - [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1490 - [Pablo Galindo](mailto:Pablogsal@gmail.com)
1491 - [Peter Bengtsson](mailto:mail@peterbe.com)
1492 - pmacosta
1493 - [Rishikesh Jha](mailto:rishijha424@gmail.com)
1494 - [Stavros Korokithakis](mailto:hi@stavros.io)
1495 - [Stephen Rosen](mailto:sirosen@globus.org)
1496 - [Sunil Kapil](mailto:snlkapil@gmail.com)
1497 - [Thom Lu](mailto:thomas.c.lu@gmail.com)
1498 - [Tom Christie](mailto:tom@tomchristie.com)
1499 - [Tzu-ping Chung](mailto:uranusjr@gmail.com)
1500 - [Utsav Shah](mailto:ukshah2@illinois.edu)
1501 - vezeli
1502 - [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
1503 - [Yngve Høiseth](mailto:yngve@hoiseth.net)
1504 - [Yurii Karabas](mailto:1998uriyyo@gmail.com)