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

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