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

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