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

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