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

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