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

8187c8c62683b696bb3bb0931f67322b72ad08c5
[etc/vim.git] / README.md
1 # black
2
3 [![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) ![License: MIT](https://img.shields.io/github/license/ambv/black.svg) ![PyPI](https://img.shields.io/pypi/v/black.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
4
5 > Any color you like.
6
7
8 *Black* is the uncompromising Python code formatter.  By using it, you
9 agree to cease control over minutiae of hand-formatting.  In return,
10 *Black* gives you speed, determinism, and freedom from `pycodestyle`
11 nagging about formatting.  You will save time and mental energy for
12 more important matters.
13
14 Blackened code looks the same regardless of the project you're reading.
15 Formatting becomes transparent after a while and you can focus on the
16 content instead.
17
18 *Black* makes code review faster by producing the smallest diffs
19 possible.
20
21
22 ## NOTE: This is an early pre-release
23
24 *Black* can already successfully format itself and the standard library.
25 It also sports a decent test suite.  However, it is still very new.
26 Things will probably be wonky for a while. This is made explicit by the
27 "Alpha" trove classifier, as well as by the "a" in the version number.
28 What this means for you is that **until the formatter becomes stable,
29 you should expect some formatting to change in the future**.
30
31 Also, as a temporary safety measure, *Black* will check that the
32 reformatted code still produces a valid AST that is equivalent to the
33 original.  This slows it down.  If you're feeling confident, use
34 ``--fast``.
35
36
37 ## Installation
38
39 *Black* can be installed by running `pip install black`.  It requires
40 Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
41 *Black* is able to parse all of the new syntax supported on Python 3.6
42 but also *effectively all* the Python 2 syntax at the same time.
43
44
45 ## Usage
46
47
48 ```
49 black [OPTIONS] [SRC]...
50
51 Options:
52   -l, --line-length INTEGER   Where to wrap around.  [default: 88]
53   --check                     Don't write back the files, just return the
54                               status.  Return code 0 means nothing would
55                               change.  Return code 1 means some files would be
56                               reformatted.  Return code 123 means there was an
57                               internal error.
58   --fast / --safe             If --fast given, skip temporary sanity checks.
59                               [default: --safe]
60   --version                   Show the version and exit.
61   --help                      Show this message and exit.
62 ```
63
64 `Black` is a well-behaved Unix-style command-line tool:
65 * it does nothing if no sources are passed to it;
66 * it will read from standard input and write to standard output if `-`
67   is used as the filename;
68 * it only outputs messages to users on standard error;
69 * exits with code 0 unless an internal error occured (or `--check` was
70   used).
71
72
73 ## The philosophy behind *Black*
74
75 *Black* reformats entire files in place.  It is not configurable.  It
76 doesn't take previous formatting into account.  It doesn't reformat
77 blocks that start with `# fmt: off` and end with `# fmt: on`.  It also
78 recognizes [YAPF](https://github.com/google/yapf)'s block comments to
79 the same effect, as a courtesy for straddling code.
80
81
82 ### How *Black* formats files
83
84 *Black* ignores previous formatting and applies uniform horizontal
85 and vertical whitespace to your code.  The rules for horizontal
86 whitespace are pretty obvious and can be summarized as: do whatever
87 makes `pycodestyle` happy.
88
89 As for vertical whitespace, *Black* tries to render one full expression
90 or simple statement per line.  If this fits the allotted line length,
91 great.
92 ```py3
93 # in:
94
95 l = [1,
96      2,
97      3,
98 ]
99
100 # out:
101
102 l = [1, 2, 3]
103 ```
104
105 If not, *Black* will look at the contents of the first outer matching
106 brackets and put that in a separate indented line.
107 ```py3
108 # in:
109
110 l = [[n for n in list_bosses()], [n for n in list_employees()]]
111
112 # out:
113
114 l = [
115     [n for n in list_bosses()], [n for n in list_employees()]
116 ]
117 ```
118
119 If that still doesn't fit the bill, it will decompose the internal
120 expression further using the same rule, indenting matching brackets
121 every time.  If the contents of the matching brackets pair are
122 comma-separated (like an argument list, or a dict literal, and so on)
123 then *Black* will first try to keep them on the same line with the
124 matching brackets.  If that doesn't work, it will put all of them in
125 separate lines.
126 ```py3
127 # in:
128
129 def very_important_function(template: str, *variables, file: os.PathLike, debug: bool = False):
130     """Applies `variables` to the `template` and writes to `file`."""
131     with open(file, 'w') as f:
132         ...
133
134 # out:
135
136 def very_important_function(
137     template: str,
138     *variables,
139     file: os.PathLike,
140     debug: bool = False,
141 ):
142     """Applies `variables` to the `template` and writes to `file`."""
143     with open(file, 'w') as f:
144         ...
145 ```
146
147 You might have noticed that closing brackets are always dedented and
148 that a trailing comma is always added.  Such formatting produces smaller
149 diffs; when you add or remove an element, it's always just one line.
150 Also, having the closing bracket dedented provides a clear delimiter
151 between two distinct sections of the code that otherwise share the same
152 indentation level (like the arguments list and the docstring in the
153 example above).
154
155 Unnecessary trailing commas are removed if an expression fits in one
156 line.  This makes it 1% more likely that your line won't exceed the
157 allotted line length limit.
158
159 *Black* avoids spurious vertical whitespace.  This is in the spirit of
160 PEP 8 which says that in-function vertical whitespace should only be
161 used sparingly.  One exception is control flow statements: *Black* will
162 always emit an extra empty line after ``return``, ``raise``, ``break``,
163 ``continue``, and ``yield``.  This is to make changes in control flow
164 more prominent to readers of your code.
165
166 That's it.  The rest of the whitespace formatting rules follow PEP 8 and
167 are designed to keep `pycodestyle` quiet.
168
169
170 ### Line length
171
172 You probably noticed the peculiar default line length.  *Black* defaults
173 to 88 characters per line, which happens to be 10% over 80.  This number
174 was found to produce significantly shorter files than sticking with 80
175 (the most popular), or even 79 (used by the standard library).  In
176 general, [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
177
178 If you're paid by the line of code you write, you can pass
179 `--line-length` with a lower number.  *Black* will try to respect that.
180 However, sometimes it won't be able to without breaking other rules.  In
181 those rare cases, auto-formatted code will exceed your allotted limit.
182
183 You can also increase it, but remember that people with sight disabilities
184 find it harder to work with line lengths exceeding 100 characters.
185 It also adversely affects side-by-side diff review  on typical screen
186 resolutions.  Long lines also make it harder to present code neatly
187 in documentation or talk slides.
188
189 If you're using Flake8, you can bump `max-line-length` to 88 and forget
190 about it.  Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
191 B950 warning instead of E501 and keep the max line length at 80 which
192 you are probably already using.  You'd do it like this:
193 ```ini
194 [flake8]
195 max-line-length = 80
196 ...
197 select = C,E,F,W,B,B950
198 ignore = E501
199 ```
200
201 You'll find *Black*'s own .flake8 config file is configured like this.
202 If you're curious about the reasoning behind B950, Bugbear's documentation
203 explains it.  The tl;dr is "it's like highway speed limits, we won't
204 bother you if you overdo it by a few km/h".
205
206
207 ### Empty lines
208
209 *Black* will allow single empty lines left by the original editors,
210 except when they're added within parenthesized expressions.  Since such
211 expressions are always reformatted to fit minimal space, this whitespace
212 is lost.
213
214 It will also insert proper spacing before and after function definitions.
215 It's one line before and after inner functions and two lines before and
216 after module-level functions.  *Black* will put those empty lines also
217 between the function definition and any standalone comments that
218 immediately precede the given function.  If you want to comment on the
219 entire function, use a docstring or put a leading comment in the function
220 body.
221
222
223 ### Editor integration
224
225 * Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode)
226
227 Any tool that can pipe code through *Black* using its stdio mode (just
228 [use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
229 The formatted code will be returned on stdout (unless `--check` was
230 passed).  *Black* will still emit messages on stderr but that shouldn't
231 affect your use case.
232
233 There is currently no integration with any other text editors. Vim and
234 Atom/Nuclide integration is planned by the author, others will require
235 external contributions.
236
237 Patches welcome! ✨ 🍰 ✨
238
239
240 ## Testimonials
241
242 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
243
244 > Black is opinionated so you don't have to be.
245
246 **Hynek Schlawack**, [creator of `attrs`](http://www.attrs.org/), core
247 developer of Twisted and CPython:
248
249 > An auto-formatter that doesn't suck is all I want for Xmas!
250
251 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
252
253 > At least the name is good.
254
255 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
256 and [`pipenv`](https://docs.pipenv.org/):
257
258 > This vastly improves the formatting of our code. Thanks a ton!
259
260
261 ## Show your style
262
263 Use the badge in your project's README.md:
264
265 ```markdown
266 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
267 ```
268
269 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
270
271
272 ## License
273
274 MIT
275
276
277 ## Contributing
278
279 In terms of inspiration, *Black* is about as configurable as *gofmt* and
280 *rustfmt* are.  This is deliberate.
281
282 Bug reports and fixes are always welcome!  However, before you suggest a
283 new feature or configuration knob, ask yourself why you want it.  If it
284 enables better integration with some workflow, fixes an inconsistency,
285 speeds things up, and so on - go for it!  On the other hand, if your
286 answer is "because I don't like a particular formatting" then you're not
287 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
288 You can still try but prepare to be disappointed.
289
290 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
291
292
293 ## Change Log
294
295 ### 18.3a4 (unreleased)
296
297 * `# fmt: off` and `# fmt: on` are implemented (#5)
298
299 * automatic detection of deprecated Python 2 forms of print statements
300   and exec statements in the formatted file (#49)
301
302 * use proper spaces for complex expressions in default values of typed
303   function arguments (#60)
304
305 * only return exit code 1 when --check is used (#50)
306
307 * don't remove single trailing commas from square bracket indexing
308   (#59)
309
310 * don't omit whitespace if the previous factor leaf wasn't a math
311   operator (#55)
312
313 * omit extra space in kwarg unpacking if it's the first argument (#46)
314
315 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
316   (#68)
317
318
319 ### 18.3a3
320
321 * don't remove single empty lines outside of bracketed expressions
322   (#19)
323
324 * added ability to pipe formatting from stdin to stdin (#25)
325
326 * restored ability to format code with legacy usage of `async` as
327   a name (#20, #42)
328
329 * even better handling of numpy-style array indexing (#33, again)
330
331
332 ### 18.3a2
333
334 * changed positioning of binary operators to occur at beginning of lines
335   instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
336   (#21)
337
338 * ignore empty bracket pairs while splitting. This avoids very weirdly
339   looking formattings (#34, #35)
340
341 * remove a trailing comma if there is a single argument to a call
342
343 * if top level functions were separated by a comment, don't put four
344   empty lines after the upper function
345
346 * fixed unstable formatting of newlines with imports
347
348 * fixed unintentional folding of post scriptum standalone comments
349   into last statement if it was a simple statement (#18, #28)
350
351 * fixed missing space in numpy-style array indexing (#33)
352
353 * fixed spurious space after star-based unary expressions (#31)
354
355
356 ### 18.3a1
357
358 * added `--check`
359
360 * only put trailing commas in function signatures and calls if it's
361   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
362   only safe if there are no `*args` or `**kwargs` used in the signature
363   or call. (#8)
364
365 * fixed invalid spacing of dots in relative imports (#6, #13)
366
367 * fixed invalid splitting after comma on unpacked variables in for-loops
368   (#23)
369
370 * fixed spurious space in parenthesized set expressions (#7)
371
372 * fixed spurious space after opening parentheses and in default
373   arguments (#14, #17)
374
375 * fixed spurious space after unary operators when the operand was
376   a complex expression (#15)
377
378
379 ### 18.3a0
380
381 * first published version, Happy 🍰 Day 2018!
382
383 * alpha quality
384
385 * date-versioned (see: https://calver.org/)
386
387
388 ## Authors
389
390 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).