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

a898efa88ad70b26b83545695c2de1ccaafc03fe
[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="http://black.readthedocs.io/en/latest/?badge=latest"><img alt="Documentation Status" src="http://readthedocs.org/projects/black/badge/?version=latest"></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="http://black.readthedocs.io/en/latest/_static/license.svg"></a>
9 <a href="https://pypi.python.org/pypi/black"><img alt="PyPI" src="http://black.readthedocs.io/en/latest/_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 cease control over minutiae of hand-formatting.  In return,
18 *Black* gives you speed, determinism, and freedom from `pycodestyle`
19 nagging about formatting.  You will save time and mental energy for
20 more important matters.
21
22 Blackened code looks the same regardless of the project you're reading.
23 Formatting becomes transparent after a while and you can focus on the
24 content instead.
25
26 *Black* makes code review faster by producing the smallest diffs
27 possible.
28
29
30 ## Installation and Usage
31
32 ### Installation
33
34 *Black* can be installed by running `pip install black`.  It requires
35 Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
36
37
38 ### Usage
39
40 To get started right away with sensible defaults:
41
42 ```
43 black {source_file_or_directory}
44 ```
45
46 ### Command line options
47
48 Black doesn't provide many options.  You can list them by running
49 `black --help`:
50
51 ```text
52 black [OPTIONS] [SRC]...
53
54 Options:
55   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
56   --check                     Don't write the files back, just return the
57                               status.  Return code 0 means nothing would
58                               change.  Return code 1 means some files would be
59                               reformatted.  Return code 123 means there was an
60                               internal error.
61   --diff                      Don't write the files back, just output a diff
62                               for each file on stdout.
63   --fast / --safe             If --fast given, skip temporary sanity checks.
64                               [default: --safe]
65   --version                   Show the version and exit.
66   --help                      Show this message and exit.
67 ```
68
69 *Black* is a well-behaved Unix-style command-line tool:
70 * it does nothing if no sources are passed to it;
71 * it will read from standard input and write to standard output if `-`
72   is used as the filename;
73 * it only outputs messages to users on standard error;
74 * exits with code 0 unless an internal error occured (or `--check` was
75   used).
76
77
78 ### NOTE: This is an early pre-release
79
80 *Black* can already successfully format itself and the standard library.
81 It also sports a decent test suite.  However, it is still very new.
82 Things will probably be wonky for a while. This is made explicit by the
83 "Alpha" trove classifier, as well as by the "a" in the version number.
84 What this means for you is that **until the formatter becomes stable,
85 you should expect some formatting to change in the future**.
86
87 Also, as a temporary safety measure, *Black* will check that the
88 reformatted code still produces a valid AST that is equivalent to the
89 original.  This slows it down.  If you're feeling confident, use
90 ``--fast``.
91
92
93 ## The *Black* code style
94
95 *Black* reformats entire files in place.  It is not configurable.  It
96 doesn't take previous formatting into account.  It doesn't reformat
97 blocks that start with `# fmt: off` and end with `# fmt: on`.  It also
98 recognizes [YAPF](https://github.com/google/yapf)'s block comments to
99 the same effect, as a courtesy for straddling code.
100
101
102 ### How *Black* wraps lines
103
104 *Black* ignores previous formatting and applies uniform horizontal
105 and vertical whitespace to your code.  The rules for horizontal
106 whitespace are pretty obvious and can be summarized as: do whatever
107 makes `pycodestyle` happy.  The coding style used by *Black* can be
108 viewed as a strict subset of PEP 8.
109
110 As for vertical whitespace, *Black* tries to render one full expression
111 or simple statement per line.  If this fits the allotted line length,
112 great.
113 ```py3
114 # in:
115
116 l = [1,
117      2,
118      3,
119 ]
120
121 # out:
122
123 l = [1, 2, 3]
124 ```
125
126 If not, *Black* will look at the contents of the first outer matching
127 brackets and put that in a separate indented line.
128 ```py3
129 # in:
130
131 l = [[n for n in list_bosses()], [n for n in list_employees()]]
132
133 # out:
134
135 l = [
136     [n for n in list_bosses()], [n for n in list_employees()]
137 ]
138 ```
139
140 If that still doesn't fit the bill, it will decompose the internal
141 expression further using the same rule, indenting matching brackets
142 every time.  If the contents of the matching brackets pair are
143 comma-separated (like an argument list, or a dict literal, and so on)
144 then *Black* will first try to keep them on the same line with the
145 matching brackets.  If that doesn't work, it will put all of them in
146 separate lines.
147 ```py3
148 # in:
149
150 def very_important_function(template: str, *variables, file: os.PathLike, debug: bool = False):
151     """Applies `variables` to the `template` and writes to `file`."""
152     with open(file, 'w') as f:
153         ...
154
155 # out:
156
157 def very_important_function(
158     template: str,
159     *variables,
160     file: os.PathLike,
161     debug: bool = False,
162 ):
163     """Applies `variables` to the `template` and writes to `file`."""
164     with open(file, "w") as f:
165         ...
166 ```
167
168 You might have noticed that closing brackets are always dedented and
169 that a trailing comma is always added.  Such formatting produces smaller
170 diffs; when you add or remove an element, it's always just one line.
171 Also, having the closing bracket dedented provides a clear delimiter
172 between two distinct sections of the code that otherwise share the same
173 indentation level (like the arguments list and the docstring in the
174 example above).
175
176
177 ### Line length
178
179 You probably noticed the peculiar default line length.  *Black* defaults
180 to 88 characters per line, which happens to be 10% over 80.  This number
181 was found to produce significantly shorter files than sticking with 80
182 (the most popular), or even 79 (used by the standard library).  In
183 general, [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
184
185 If you're paid by the line of code you write, you can pass
186 `--line-length` with a lower number.  *Black* will try to respect that.
187 However, sometimes it won't be able to without breaking other rules.  In
188 those rare cases, auto-formatted code will exceed your allotted limit.
189
190 You can also increase it, but remember that people with sight disabilities
191 find it harder to work with line lengths exceeding 100 characters.
192 It also adversely affects side-by-side diff review  on typical screen
193 resolutions.  Long lines also make it harder to present code neatly
194 in documentation or talk slides.
195
196 If you're using Flake8, you can bump `max-line-length` to 88 and forget
197 about it.  Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
198 B950 warning instead of E501 and keep the max line length at 80 which
199 you are probably already using.  You'd do it like this:
200 ```ini
201 [flake8]
202 max-line-length = 80
203 ...
204 select = C,E,F,W,B,B950
205 ignore = E501
206 ```
207
208 You'll find *Black*'s own .flake8 config file is configured like this.
209 If you're curious about the reasoning behind B950, Bugbear's documentation
210 explains it.  The tl;dr is "it's like highway speed limits, we won't
211 bother you if you overdo it by a few km/h".
212
213
214 ### Empty lines
215
216 *Black* avoids spurious vertical whitespace.  This is in the spirit of
217 PEP 8 which says that in-function vertical whitespace should only be
218 used sparingly.  One exception is control flow statements: *Black* will
219 always emit an extra empty line after ``return``, ``raise``, ``break``,
220 ``continue``, and ``yield``.  This is to make changes in control flow
221 more prominent to readers of your code.
222
223 *Black* will allow single empty lines inside functions, and single and
224 double empty lines on module level left by the original editors, except
225 when they're within parenthesized expressions.  Since such expressions
226 are always reformatted to fit minimal space, this whitespace is lost.
227
228 It will also insert proper spacing before and after function definitions.
229 It's one line before and after inner functions and two lines before and
230 after module-level functions.  *Black* will put those empty lines also
231 between the function definition and any standalone comments that
232 immediately precede the given function.  If you want to comment on the
233 entire function, use a docstring or put a leading comment in the function
234 body.
235
236
237 ### Trailing commas
238
239 *Black* will add trailing commas to expressions that are split
240 by comma where each element is on its own line.  This includes function
241 signatures.
242
243 Unnecessary trailing commas are removed if an expression fits in one
244 line.  This makes it 1% more likely that your line won't exceed the
245 allotted line length limit.  Moreover, in this scenario, if you added
246 another argument to your call, you'd probably fit it in the same line
247 anyway.  That doesn't make diffs any larger.
248
249 One exception to removing trailing commas is tuple expressions with
250 just one element.  In this case *Black* won't touch the single trailing
251 comma as this would unexpectedly change the underlying data type.  Note
252 that this is also the case when commas are used while indexing.  This is
253 a tuple in disguise: ```numpy_array[3, ]```.
254
255 One exception to adding trailing commas is function signatures
256 containing `*`, `*args`, or `**kwargs`.  In this case a trailing comma
257 is only safe to use on Python 3.6.  *Black* will detect if your file is
258 already 3.6+ only and use trailing commas in this situation.  If you
259 wonder how it knows, it looks for f-strings and existing use of trailing
260 commas in function signatures that have stars in them.  In other words,
261 if you'd like a trailing comma in this situation and *Black* didn't
262 recognize it was safe to do so, put it there manually and *Black* will
263 keep it.
264
265 ### Strings
266
267 *Black* prefers double quotes (`"` and `"""`), but only if this does not
268 result in more escaping. It will remove escape sequences as necessary as
269 part of moving to the other type of quote. This applies to all kinds of
270 prefixed strings, including *raw-strings* (`r""`), *byte literals* (`b""`),
271 and *formatted strings* (`f""`). The approach above strikes a good balance
272 between consistency and legibility.
273
274
275 ## Editor integration
276
277 ### Emacs
278
279 Use [proofit404/blacken](https://github.com/proofit404/blacken).
280
281
282 ### Vim
283
284 Commands and shortcuts:
285
286 * `,=` or `:Black` to format the entire file (ranges not supported);
287 * `:BlackUpgrade` to upgrade *Black* inside the virtualenv;
288 * `:BlackVersion` to get the current version of *Black* inside the
289   virtualenv.
290
291 Configuration:
292 * `g:black_fast` (defaults to `0`)
293 * `g:black_linelength` (defaults to `88`)
294 * `g:black_virtualenv` (defaults to `~/.vim/black`)
295
296 To install, copy the plugin from [vim/plugin/black.vim](https://github.com/ambv/black/tree/master/vim/plugin/black.vim).
297 Let me know if this requires any changes to work with Vim 8's builtin
298 `packadd`, or Pathogen, or Vundle, and so on.
299
300 This plugin **requires Vim 7.0+ built with Python 3.6+ support**.  It
301 needs Python 3.6 to be able to run *Black* inside the Vim process which
302 is much faster than calling an external command.
303
304 On first run, the plugin creates its own virtualenv using the right
305 Python version and automatically installs *Black*. You can upgrade it later
306 by calling `:BlackUpgrade` and restarting Vim.
307
308 If you need to do anything special to make your virtualenv work and
309 install *Black* (for example you want to run a version from master), just
310 create a virtualenv manually and point `g:black_virtualenv` to it.
311 The plugin will use it.
312
313 **How to get Vim with Python 3.6?**
314 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
315 On macOS with HomeBrew run: `brew install vim --with-python3`.
316 When building Vim from source, use:
317 `./configure --enable-python3interp=yes`. There's many guides online how
318 to do this.
319
320
321 ### Visual Studio Code
322
323 Use [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode).
324
325
326 ### Other editors
327
328 Atom/Nuclide integration is planned by the author, others will
329 require external contributions.
330
331 Patches welcome! ✨ 🍰 ✨
332
333 Any tool that can pipe code through *Black* using its stdio mode (just
334 [use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
335 The formatted code will be returned on stdout (unless `--check` was
336 passed).  *Black* will still emit messages on stderr but that shouldn't
337 affect your use case.
338
339 This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
340
341
342 ## Testimonials
343
344 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
345
346 > Black is opinionated so you don't have to be.
347
348 **Hynek Schlawack**, [creator of `attrs`](http://www.attrs.org/), core
349 developer of Twisted and CPython:
350
351 > An auto-formatter that doesn't suck is all I want for Xmas!
352
353 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
354
355 > At least the name is good.
356
357 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
358 and [`pipenv`](https://docs.pipenv.org/):
359
360 > This vastly improves the formatting of our code. Thanks a ton!
361
362
363 ## Show your style
364
365 Use the badge in your project's README.md:
366
367 ```markdown
368 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
369 ```
370
371 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
372
373
374 ## License
375
376 MIT
377
378
379 ## Contributing to Black
380
381 In terms of inspiration, *Black* is about as configurable as *gofmt* and
382 *rustfmt* are.  This is deliberate.
383
384 Bug reports and fixes are always welcome!  However, before you suggest a
385 new feature or configuration knob, ask yourself why you want it.  If it
386 enables better integration with some workflow, fixes an inconsistency,
387 speeds things up, and so on - go for it!  On the other hand, if your
388 answer is "because I don't like a particular formatting" then you're not
389 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
390 You can still try but prepare to be disappointed.
391
392 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
393
394
395 ## Change Log
396
397 ### 18.3a5 (unreleased)
398
399 * added `--diff` (#87)
400
401 * add line breaks before all delimiters, except in cases like commas, to better
402   comply with PEP 8 (#73)
403
404 * fixed handling of standalone comments within nested bracketed
405   expressions; Black will no longer produce super long lines or put all
406   standalone comments at the end of the expression (#22)
407
408 * fixed 18.3a4 regression: don't crash and burn on empty lines with
409   trailing whitespace (#80)
410
411 * when CTRL+C is pressed while formatting many files, Black no longer
412   freaks out with a flurry of asyncio-related exceptions
413
414 * only allow up to two empty lines on module level and only single empty
415   lines within functions (#74)
416
417
418 ### 18.3a4
419
420 * `# fmt: off` and `# fmt: on` are implemented (#5)
421
422 * automatic detection of deprecated Python 2 forms of print statements
423   and exec statements in the formatted file (#49)
424
425 * use proper spaces for complex expressions in default values of typed
426   function arguments (#60)
427
428 * only return exit code 1 when --check is used (#50)
429
430 * don't remove single trailing commas from square bracket indexing
431   (#59)
432
433 * don't omit whitespace if the previous factor leaf wasn't a math
434   operator (#55)
435
436 * omit extra space in kwarg unpacking if it's the first argument (#46)
437
438 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
439   (#68)
440
441
442 ### 18.3a3
443
444 * don't remove single empty lines outside of bracketed expressions
445   (#19)
446
447 * added ability to pipe formatting from stdin to stdin (#25)
448
449 * restored ability to format code with legacy usage of `async` as
450   a name (#20, #42)
451
452 * even better handling of numpy-style array indexing (#33, again)
453
454
455 ### 18.3a2
456
457 * changed positioning of binary operators to occur at beginning of lines
458   instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
459   (#21)
460
461 * ignore empty bracket pairs while splitting. This avoids very weirdly
462   looking formattings (#34, #35)
463
464 * remove a trailing comma if there is a single argument to a call
465
466 * if top level functions were separated by a comment, don't put four
467   empty lines after the upper function
468
469 * fixed unstable formatting of newlines with imports
470
471 * fixed unintentional folding of post scriptum standalone comments
472   into last statement if it was a simple statement (#18, #28)
473
474 * fixed missing space in numpy-style array indexing (#33)
475
476 * fixed spurious space after star-based unary expressions (#31)
477
478
479 ### 18.3a1
480
481 * added `--check`
482
483 * only put trailing commas in function signatures and calls if it's
484   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
485   only safe if there are no `*args` or `**kwargs` used in the signature
486   or call. (#8)
487
488 * fixed invalid spacing of dots in relative imports (#6, #13)
489
490 * fixed invalid splitting after comma on unpacked variables in for-loops
491   (#23)
492
493 * fixed spurious space in parenthesized set expressions (#7)
494
495 * fixed spurious space after opening parentheses and in default
496   arguments (#14, #17)
497
498 * fixed spurious space after unary operators when the operand was
499   a complex expression (#15)
500
501
502 ### 18.3a0
503
504 * first published version, Happy 🍰 Day 2018!
505
506 * alpha quality
507
508 * date-versioned (see: https://calver.org/)
509
510
511 ## Authors
512
513 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
514
515 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com)
516 and [Carl Meyer](mailto:carl@oddbird.net).
517
518 Multiple contributions by:
519 * [Artem Malyshev](mailto:proofit404@gmail.com)
520 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
521 * [Eli Treuherz](mailto:eli.treuherz@cgi.com)
522 * Hugo van Kemenade
523 * [Mika Naylor](mailto:mail@autophagy.io)
524 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)