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

e9937f1296c97e2f569f6d5b39e0d8e8d6966213
[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="http://pepy.tech/project/black"><img alt="Downloads" src="http://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 all numeric literals to use lowercase letters: `0xab`
377 instead of `0XAB` and `1e10` instead of `1E10`. In Python 3.6+, *Black*
378 adds underscores to long numeric literals to aid readability: `100000000`
379 becomes `100_000_000`.
380
381 ### Line breaks & binary operators
382
383 *Black* will break a line before a binary operator when splitting a block
384 of code over multiple lines. This is so that *Black* is compliant with the
385 recent changes in the [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
386 style guide, which emphasizes that this approach improves readability.
387
388 This behaviour may raise ``W503 line break before binary operator`` warnings in
389 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
390 you should tell Flake8 to ignore these warnings.
391
392
393 ### Slices
394
395 PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
396 to treat ``:`` in slices as a binary operator with the lowest priority, and to
397 leave an equal amount of space on either side, except if a parameter is omitted
398 (e.g. ``ham[1 + 1 :]``). It also states that for extended slices, both ``:``
399 operators have to have the same amount of spacing, except if a parameter is
400 omitted (``ham[1 + 1 ::]``). *Black* enforces these rules consistently.
401
402 This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
403 enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
404 tell Flake8 to ignore these warnings.
405
406
407 ### Parentheses
408
409 Some parentheses are optional in the Python grammar.  Any expression can
410 be wrapped in a pair of parentheses to form an atom.  There are a few
411 interesting cases:
412
413 - `if (...):`
414 - `while (...):`
415 - `for (...) in (...):`
416 - `assert (...), (...)`
417 - `from X import (...)`
418 - assignments like:
419   - `target = (...)`
420   - `target: type = (...)`
421   - `some, *un, packing = (...)`
422   - `augmented += (...)`
423
424 In those cases, parentheses are removed when the entire statement fits
425 in one line, or if the inner expression doesn't have any delimiters to
426 further split on.  If there is only a single delimiter and the expression
427 starts or ends with a bracket, the parenthesis can also be successfully
428 omitted since the existing bracket pair will organize the expression
429 neatly anyway.  Otherwise, the parentheses are added.
430
431 Please note that *Black* does not add or remove any additional nested
432 parentheses that you might want to have for clarity or further
433 code organization.  For example those parentheses are not going to be
434 removed:
435 ```py3
436 return not (this or that)
437 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
438 ```
439
440
441 ### Call chains
442
443 Some popular APIs, like ORMs, use call chaining.  This API style is known
444 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).
445 *Black* formats those by treating dots that follow a call or an indexing
446 operation like a very low priority delimiter.  It's easier to show the
447 behavior than to explain it.  Look at the example:
448 ```py3
449 def example(session):
450     result = (
451         session.query(models.Customer.id)
452         .filter(
453             models.Customer.account_id == account_id,
454             models.Customer.email == email_address,
455         )
456         .order_by(models.Customer.id.asc())
457         .all()
458     )
459 ```
460
461
462 ### Typing stub files
463
464 PEP 484 describes the syntax for type hints in Python.  One of the
465 use cases for typing is providing type annotations for modules which
466 cannot contain them directly (they might be written in C, or they might
467 be third-party, or their implementation may be overly dynamic, and so on).
468
469 To solve this, [stub files with the `.pyi` file
470 extension](https://www.python.org/dev/peps/pep-0484/#stub-files) can be
471 used to describe typing information for an external module.  Those stub
472 files omit the implementation of classes and functions they
473 describe, instead they only contain the structure of the file (listing
474 globals, functions, and classes with their members).  The recommended
475 code style for those files is more terse than PEP 8:
476
477 * prefer `...` on the same line as the class/function signature;
478 * avoid vertical whitespace between consecutive module-level functions,
479   names, or methods and fields within a single class;
480 * use a single blank line between top-level class definitions, or none
481   if the classes are very small.
482
483 *Black* enforces the above rules.  There are additional guidelines for
484 formatting `.pyi` file that are not enforced yet but might be in
485 a future version of the formatter:
486
487 * all function bodies should be empty (contain `...` instead of the body);
488 * do not use docstrings;
489 * prefer `...` over `pass`;
490 * for arguments with a default, use `...` instead of the actual default;
491 * avoid using string literals in type annotations, stub files support
492   forward references natively (like Python 3.7 code with `from __future__
493   import annotations`);
494 * use variable annotations instead of type comments, even for stubs that
495   target older versions of Python;
496 * for arguments that default to `None`, use `Optional[]` explicitly;
497 * use `float` instead of `Union[int, float]`.
498
499
500 ## pyproject.toml
501
502 *Black* is able to read project-specific default values for its
503 command line options from a `pyproject.toml` file.  This is
504 especially useful for specifying custom `--include` and `--exclude`
505 patterns for your project.
506
507 **Pro-tip**: If you're asking yourself "Do I need to configure anything?"
508 the answer is "No".  *Black* is all about sensible defaults.
509
510
511 ### What on Earth is a `pyproject.toml` file?
512
513 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines
514 `pyproject.toml` as a configuration file to store build system
515 requirements for Python projects.  With the help of tools
516 like [Poetry](https://poetry.eustace.io/) or
517 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the
518 need for `setup.py` and `setup.cfg` files.
519
520
521 ### Where *Black* looks for the file
522
523 By default *Black* looks for `pyproject.toml` starting from the common
524 base directory of all files and directories passed on the command line.
525 If it's not there, it looks in parent directories.  It stops looking
526 when it finds the file, or a `.git` directory, or a `.hg` directory,
527 or the root of the file system, whichever comes first.
528
529 If you're formatting standard input, *Black* will look for configuration
530 starting from the current working directory.
531
532 You can also explicitly specify the path to a particular file that you
533 want with `--config`.  In this situation *Black* will not look for any
534 other file.
535
536 If you're running with `--verbose`, you will see a blue message if
537 a file was found and used.
538
539
540 ### Configuration format
541
542 As the file extension suggests, `pyproject.toml` is a [TOML](https://github.com/toml-lang/toml) file.  It contains separate
543 sections for different tools.  *Black* is using the `[tool.black]`
544 section.  The option keys are the same as long names of options on
545 the command line.
546
547 Note that you have to use single-quoted strings in TOML for regular
548 expressions. It's the equivalent of r-strings in Python.  Multiline
549 strings are treated as verbose regular expressions by Black.  Use `[ ]`
550 to denote a significant space character.
551
552 <details>
553 <summary>Example `pyproject.toml`</summary>
554
555 ```toml
556 [tool.black]
557 line-length = 88
558 py36 = true
559 include = '\.pyi?$'
560 exclude = '''
561 /(
562     \.git
563   | \.hg
564   | \.mypy_cache
565   | \.tox
566   | \.venv
567   | _build
568   | buck-out
569   | build
570   | dist
571
572   # The following are specific to Black, you probably don't want those.
573   | blib2to3
574   | tests/data
575 )/
576 '''
577 ```
578
579 </details>
580
581 ### Lookup hierarchy
582
583 Command-line options have defaults that you can see in `--help`.
584 A `pyproject.toml` can override those defaults.  Finally, options
585 provided by the user on the command line override both.
586
587 *Black* will only ever use one `pyproject.toml` file during an entire
588 run. It doesn't look for multiple files, and doesn't compose
589 configuration from different levels of the file hierarchy.
590
591
592 ## Editor integration
593
594 ### Emacs
595
596 Use [proofit404/blacken](https://github.com/proofit404/blacken).
597
598
599 ### PyCharm
600
601 1. Install `black`.
602
603 ```console
604 $ pip install black
605 ```
606
607 2. Locate your `black` installation folder.
608
609   On macOS / Linux / BSD:
610
611 ```console
612 $ which black
613 /usr/local/bin/black  # possible location
614 ```
615
616   On Windows:
617
618 ```console
619 $ where black
620 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
621 ```
622
623 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
624
625 4. Click the + icon to add a new external tool with the following values:
626     - Name: Black
627     - Description: Black is the uncompromising Python code formatter.
628     - Program: <install_location_from_step_2>
629     - Arguments: `$FilePath$`
630
631 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
632     - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.
633
634 6. Optionally, run Black on every file save:
635
636     1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed.
637     2. Go to `Preferences -> Tools -> File Watchers` and click `+` to add a new watcher:
638         - Name: Black
639         - File type: Python
640         - Scope: Project Files
641         - Program: <install_location_from_step_2>
642         - Arguments: `$FilePath$`
643         - Output paths to refresh: `$FilePathRelativeToProjectRoot$`
644         - Working directory: `$ProjectFileDir$`
645
646 ### Vim
647
648 Commands and shortcuts:
649
650 * `:Black` to format the entire file (ranges not supported);
651 * `:BlackUpgrade` to upgrade *Black* inside the virtualenv;
652 * `:BlackVersion` to get the current version of *Black* inside the
653   virtualenv.
654
655 Configuration:
656 * `g:black_fast` (defaults to `0`)
657 * `g:black_linelength` (defaults to `88`)
658 * `g:black_skip_string_normalization` (defaults to `0`)
659 * `g:black_virtualenv` (defaults to `~/.vim/black`)
660
661 To install with [vim-plug](https://github.com/junegunn/vim-plug):
662
663 ```
664 Plug 'ambv/black',
665 ```
666
667 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
668
669 ```
670 Plugin 'ambv/black'
671 ```
672
673 or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim).
674 Let me know if this requires any changes to work with Vim 8's builtin
675 `packadd`, or Pathogen, and so on.
676
677 This plugin **requires Vim 7.0+ built with Python 3.6+ support**.  It
678 needs Python 3.6 to be able to run *Black* inside the Vim process which
679 is much faster than calling an external command.
680
681 On first run, the plugin creates its own virtualenv using the right
682 Python version and automatically installs *Black*. You can upgrade it later
683 by calling `:BlackUpgrade` and restarting Vim.
684
685 If you need to do anything special to make your virtualenv work and
686 install *Black* (for example you want to run a version from master),
687 create a virtualenv manually and point `g:black_virtualenv` to it.
688 The plugin will use it.
689
690 To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
691
692 ```
693 autocmd BufWritePre *.py execute ':Black'
694 ```
695
696 **How to get Vim with Python 3.6?**
697 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
698 On macOS with Homebrew run: `brew install vim --with-python3`.
699 When building Vim from source, use:
700 `./configure --enable-python3interp=yes`. There's many guides online how
701 to do this.
702
703
704 ### Visual Studio Code
705
706 Use the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
707 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
708
709
710 ### SublimeText 3
711
712 Use [sublack plugin](https://github.com/jgirardet/sublack).
713
714
715 ### IPython Notebook Magic
716
717 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
718
719
720 ### Python Language Server
721
722 If your editor supports the [Language Server Protocol](https://langserver.org/)
723 (Atom, Sublime Text, Visual Studio Code and many more), you can use
724 the [Python Language Server](https://github.com/palantir/python-language-server) with the
725 [pyls-black](https://github.com/rupert/pyls-black) plugin.
726
727
728 ### Atom/Nuclide
729
730 Use [atom-black](https://github.com/hauntsaninja/atom-black).
731
732
733 ### Other editors
734
735 Other editors will require external contributions.
736
737 Patches welcome! ✨ 🍰 ✨
738
739 Any tool that can pipe code through *Black* using its stdio mode (just
740 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
741 The formatted code will be returned on stdout (unless `--check` was
742 passed).  *Black* will still emit messages on stderr but that shouldn't
743 affect your use case.
744
745 This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
746
747
748 ## Version control integration
749
750 Use [pre-commit](https://pre-commit.com/). Once you [have it
751 installed](https://pre-commit.com/#install), add this to the
752 `.pre-commit-config.yaml` in your repository:
753 ```yaml
754 repos:
755 -   repo: https://github.com/ambv/black
756     rev: stable
757     hooks:
758     - id: black
759       language_version: python3.6
760 ```
761 Then run `pre-commit install` and you're ready to go.
762
763 Avoid using `args` in the hook.  Instead, store necessary configuration
764 in `pyproject.toml` so that editors and command-line usage of Black all
765 behave consistently for your project.  See *Black*'s own `pyproject.toml`
766 for an example.
767
768 If you're already using Python 3.7, switch the `language_version`
769 accordingly. Finally, `stable` is a tag that is pinned to the latest
770 release on PyPI.  If you'd rather run on master, this is also an option.
771
772
773 ## Ignoring unmodified files
774
775 *Black* remembers files it has already formatted, unless the `--diff` flag is used or
776 code is passed via standard input. This information is stored per-user. The exact
777 location of the file depends on the *Black* version and the system on which *Black*
778 is run. The file is non-portable. The standard location on common operating systems
779 is:
780
781 * Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle`
782 * macOS: `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle`
783 * Linux: `/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle`
784
785 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
786 as .pyi, and whether string normalization was omitted.
787
788
789 ## Testimonials
790
791 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
792
793 > *Black* is opinionated so you don't have to be.
794
795 **Hynek Schlawack**, [creator of `attrs`](http://www.attrs.org/), core
796 developer of Twisted and CPython:
797
798 > An auto-formatter that doesn't suck is all I want for Xmas!
799
800 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
801
802 > At least the name is good.
803
804 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
805 and [`pipenv`](https://docs.pipenv.org/):
806
807 > This vastly improves the formatting of our code. Thanks a ton!
808
809
810 ## Show your style
811
812 Use the badge in your project's README.md:
813
814 ```markdown
815 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
816 ```
817
818 Using the badge in README.rst:
819 ```
820 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
821     :target: https://github.com/ambv/black
822 ```
823
824 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
825
826
827 ## License
828
829 MIT
830
831
832 ## Contributing to *Black*
833
834 In terms of inspiration, *Black* is about as configurable as *gofmt*.
835 This is deliberate.
836
837 Bug reports and fixes are always welcome!  However, before you suggest a
838 new feature or configuration knob, ask yourself why you want it.  If it
839 enables better integration with some workflow, fixes an inconsistency,
840 speeds things up, and so on - go for it!  On the other hand, if your
841 answer is "because I don't like a particular formatting" then you're not
842 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
843 You can still try but prepare to be disappointed.
844
845 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
846
847
848 ## Change Log
849
850 ### 18.8b0
851
852 * adjacent string literals are now correctly split into multiple lines (#463)
853
854 * code with `_` in numeric literals is recognized as Python 3.6+ (#461)
855
856 * numeric literals are now normalized to include `_` separators on Python 3.6+ code
857   (#452)
858
859 * cache is now populated when `--check` is successful for a file which speeds up
860   consecutive checks of properly formatted unmodified files (#448)
861
862 * fixed parsing of `__future__` imports with renames (#389)
863
864 * fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
865
866 * note: the Vim plugin stopped registering ``,=`` as a default chord as it turned out
867   to be a bad idea (#415)
868
869
870 ### 18.6b4
871
872 * hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
873
874
875 ### 18.6b3
876
877 * typing stub files (`.pyi`) now have blank lines added after constants (#340)
878
879 * `# fmt: off` and `# fmt: on` are now much more dependable:
880
881   * they now work also within bracket pairs (#329)
882
883   * they now correctly work across function/class boundaries (#335)
884
885   * they now work when an indentation block starts with empty lines or misaligned
886     comments (#334)
887
888 * made Click not fail on invalid environments; note that Click is right but the
889   likelihood we'll need to access non-ASCII file paths when dealing with Python source
890   code is low (#277)
891
892 * fixed improper formatting of f-strings with quotes inside interpolated
893   expressions (#322)
894
895 * fixed unnecessary slowdown when long list literals where found in a file
896
897 * fixed unnecessary slowdown on AST nodes with very many siblings
898
899 * fixed cannibalizing backslashes during string normalization
900
901 * fixed a crash due to symbolic links pointing outside of the project directory (#338)
902
903
904 ### 18.6b2
905
906 * added `--config` (#65)
907
908 * added `-h` equivalent to `--help` (#316)
909
910 * fixed improper unmodified file caching when `-S` was used
911
912 * fixed extra space in string unpacking (#305)
913
914 * fixed formatting of empty triple quoted strings (#313)
915
916 * fixed unnecessary slowdown in comment placement calculation on lines without
917   comments
918
919
920 ### 18.6b1
921
922 * hotfix: don't output human-facing information on stdout (#299)
923
924 * hotfix: don't output cake emoji on non-zero return code (#300)
925
926
927 ### 18.6b0
928
929 * added `--include` and `--exclude` (#270)
930
931 * added `--skip-string-normalization` (#118)
932
933 * added `--verbose` (#283)
934
935 * the header output in `--diff` now actually conforms to the unified diff spec
936
937 * fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
938
939 * fixed unnecessary parentheses when a line contained multiline strings (#232)
940
941 * fixed stdin handling not working correctly if an old version of Click was
942   used (#276)
943
944 * *Black* now preserves line endings when formatting a file in place (#258)
945
946
947 ### 18.5b1
948
949 * added `--pyi` (#249)
950
951 * added `--py36` (#249)
952
953 * Python grammar pickle caches are stored with the formatting caches, making
954   *Black* work in environments where site-packages is not user-writable (#192)
955
956 * *Black* now enforces a PEP 257 empty line after a class-level docstring
957   (and/or fields) and the first method
958
959 * fixed invalid code produced when standalone comments were present in a trailer
960   that was omitted from line splitting on a large expression (#237)
961
962 * fixed optional parentheses being removed within `# fmt: off` sections (#224)
963
964 * fixed invalid code produced when stars in very long imports were incorrectly
965   wrapped in optional parentheses (#234)
966
967 * fixed unstable formatting when inline comments were moved around in
968   a trailer that was omitted from line splitting on a large expression
969   (#238)
970
971 * fixed extra empty line between a class declaration and the first
972   method if no class docstring or fields are present (#219)
973
974 * fixed extra empty line between a function signature and an inner
975   function or inner class (#196)
976
977
978 ### 18.5b0
979
980 * call chains are now formatted according to the
981   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface)
982   style (#67)
983
984 * data structure literals (tuples, lists, dictionaries, and sets) are
985   now also always exploded like imports when they don't fit in a single
986   line (#152)
987
988 * slices are now formatted according to PEP 8 (#178)
989
990 * parentheses are now also managed automatically on the right-hand side
991   of assignments and return statements (#140)
992
993 * math operators now use their respective priorities for delimiting multiline
994   expressions (#148)
995
996 * optional parentheses are now omitted on expressions that start or end
997   with a bracket and only contain a single operator (#177)
998
999 * empty parentheses in a class definition are now removed (#145, #180)
1000
1001 * string prefixes are now standardized to lowercase and `u` is removed
1002   on Python 3.6+ only code and Python 2.7+ code with the `unicode_literals`
1003   future import (#188, #198, #199)
1004
1005 * typing stub files (`.pyi`) are now formatted in a style that is consistent
1006   with PEP 484 (#207, #210)
1007
1008 * progress when reformatting many files is now reported incrementally
1009
1010 * fixed trailers (content with brackets) being unnecessarily exploded
1011   into their own lines after a dedented closing bracket (#119)
1012
1013 * fixed an invalid trailing comma sometimes left in imports (#185)
1014
1015 * fixed non-deterministic formatting when multiple pairs of removable parentheses
1016   were used (#183)
1017
1018 * fixed multiline strings being unnecessarily wrapped in optional
1019   parentheses in long assignments (#215)
1020
1021 * fixed not splitting long from-imports with only a single name
1022
1023 * fixed Python 3.6+ file discovery by also looking at function calls with
1024   unpacking. This fixed non-deterministic formatting if trailing commas
1025   where used both in function signatures with stars and function calls
1026   with stars but the former would be reformatted to a single line.
1027
1028 * fixed crash on dealing with optional parentheses (#193)
1029
1030 * fixed "is", "is not", "in", and "not in" not considered operators for
1031   splitting purposes
1032
1033 * fixed crash when dead symlinks where encountered
1034
1035
1036 ### 18.4a4
1037
1038 * don't populate the cache on `--check` (#175)
1039
1040
1041 ### 18.4a3
1042
1043 * added a "cache"; files already reformatted that haven't changed on disk
1044   won't be reformatted again (#109)
1045
1046 * `--check` and `--diff` are no longer mutually exclusive (#149)
1047
1048 * generalized star expression handling, including double stars; this
1049   fixes multiplication making expressions "unsafe" for trailing commas (#132)
1050
1051 * *Black* no longer enforces putting empty lines behind control flow statements
1052   (#90)
1053
1054 * *Black* now splits imports like "Mode 3 + trailing comma" of isort (#127)
1055
1056 * fixed comment indentation when a standalone comment closes a block (#16, #32)
1057
1058 * fixed standalone comments receiving extra empty lines if immediately preceding
1059   a class, def, or decorator (#56, #154)
1060
1061 * fixed `--diff` not showing entire path (#130)
1062
1063 * fixed parsing of complex expressions after star and double stars in
1064   function calls (#2)
1065
1066 * fixed invalid splitting on comma in lambda arguments (#133)
1067
1068 * fixed missing splits of ternary expressions (#141)
1069
1070
1071 ### 18.4a2
1072
1073 * fixed parsing of unaligned standalone comments (#99, #112)
1074
1075 * fixed placement of dictionary unpacking inside dictionary literals (#111)
1076
1077 * Vim plugin now works on Windows, too
1078
1079 * fixed unstable formatting when encountering unnecessarily escaped quotes
1080   in a string (#120)
1081
1082
1083 ### 18.4a1
1084
1085 * added `--quiet` (#78)
1086
1087 * added automatic parentheses management (#4)
1088
1089 * added [pre-commit](https://pre-commit.com) integration (#103, #104)
1090
1091 * fixed reporting on `--check` with multiple files (#101, #102)
1092
1093 * fixed removing backslash escapes from raw strings (#100, #105)
1094
1095
1096 ### 18.4a0
1097
1098 * added `--diff` (#87)
1099
1100 * add line breaks before all delimiters, except in cases like commas, to
1101   better comply with PEP 8 (#73)
1102
1103 * standardize string literals to use double quotes (almost) everywhere
1104   (#75)
1105
1106 * fixed handling of standalone comments within nested bracketed
1107   expressions; *Black* will no longer produce super long lines or put all
1108   standalone comments at the end of the expression (#22)
1109
1110 * fixed 18.3a4 regression: don't crash and burn on empty lines with
1111   trailing whitespace (#80)
1112
1113 * fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment
1114   would cause *Black* to not emit the rest of the file (#95)
1115
1116 * when CTRL+C is pressed while formatting many files, *Black* no longer
1117   freaks out with a flurry of asyncio-related exceptions
1118
1119 * only allow up to two empty lines on module level and only single empty
1120   lines within functions (#74)
1121
1122
1123 ### 18.3a4
1124
1125 * `# fmt: off` and `# fmt: on` are implemented (#5)
1126
1127 * automatic detection of deprecated Python 2 forms of print statements
1128   and exec statements in the formatted file (#49)
1129
1130 * use proper spaces for complex expressions in default values of typed
1131   function arguments (#60)
1132
1133 * only return exit code 1 when --check is used (#50)
1134
1135 * don't remove single trailing commas from square bracket indexing
1136   (#59)
1137
1138 * don't omit whitespace if the previous factor leaf wasn't a math
1139   operator (#55)
1140
1141 * omit extra space in kwarg unpacking if it's the first argument (#46)
1142
1143 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1144   (#68)
1145
1146
1147 ### 18.3a3
1148
1149 * don't remove single empty lines outside of bracketed expressions
1150   (#19)
1151
1152 * added ability to pipe formatting from stdin to stdin (#25)
1153
1154 * restored ability to format code with legacy usage of `async` as
1155   a name (#20, #42)
1156
1157 * even better handling of numpy-style array indexing (#33, again)
1158
1159
1160 ### 18.3a2
1161
1162 * changed positioning of binary operators to occur at beginning of lines
1163   instead of at the end, following [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1164   (#21)
1165
1166 * ignore empty bracket pairs while splitting. This avoids very weirdly
1167   looking formattings (#34, #35)
1168
1169 * remove a trailing comma if there is a single argument to a call
1170
1171 * if top level functions were separated by a comment, don't put four
1172   empty lines after the upper function
1173
1174 * fixed unstable formatting of newlines with imports
1175
1176 * fixed unintentional folding of post scriptum standalone comments
1177   into last statement if it was a simple statement (#18, #28)
1178
1179 * fixed missing space in numpy-style array indexing (#33)
1180
1181 * fixed spurious space after star-based unary expressions (#31)
1182
1183
1184 ### 18.3a1
1185
1186 * added `--check`
1187
1188 * only put trailing commas in function signatures and calls if it's
1189   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
1190   only safe if there are no `*args` or `**kwargs` used in the signature
1191   or call. (#8)
1192
1193 * fixed invalid spacing of dots in relative imports (#6, #13)
1194
1195 * fixed invalid splitting after comma on unpacked variables in for-loops
1196   (#23)
1197
1198 * fixed spurious space in parenthesized set expressions (#7)
1199
1200 * fixed spurious space after opening parentheses and in default
1201   arguments (#14, #17)
1202
1203 * fixed spurious space after unary operators when the operand was
1204   a complex expression (#15)
1205
1206
1207 ### 18.3a0
1208
1209 * first published version, Happy 🍰 Day 2018!
1210
1211 * alpha quality
1212
1213 * date-versioned (see: https://calver.org/)
1214
1215
1216 ## Authors
1217
1218 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1219
1220 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1221 [Carl Meyer](mailto:carl@oddbird.net),
1222 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
1223 [Mika Naylor](mailto:mail@autophagy.io), and
1224 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
1225
1226 Multiple contributions by:
1227 * [Anthony Sottile](mailto:asottile@umich.edu)
1228 * [Artem Malyshev](mailto:proofit404@gmail.com)
1229 * [Christian Heimes](mailto:christian@python.org)
1230 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
1231 * [Eli Treuherz](mailto:eli.treuherz@cgi.com)
1232 * Hugo van Kemenade
1233 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1234 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
1235 * [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1236 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1237 * [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
1238 * [Neraste](neraste.herr10@gmail.com)
1239 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1240 * [Peter Bengtsson](mailto:mail@peterbe.com)
1241 * [Stavros Korokithakis](mailto:hi@stavros.io)
1242 * [Sunil Kapil](mailto:snlkapil@gmail.com)
1243 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)