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

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