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

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