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

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