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

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