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

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