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

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