]> git.madduck.net Git - etc/vim.git/blob - CHANGES.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:

Reformat docs/conf.py according to the new style
[etc/vim.git] / CHANGES.md
1 ## Change Log
2
3 ### Unreleased
4
5 #### _Black_
6
7 - re-implemented support for explicit trailing commas: now it works consistently within
8   any bracket pair, including nested structures (#1288 and duplicates)
9
10 - reindent docstrings when reindenting code around it (#1053)
11
12 - show colored diffs (#1266)
13
14 - move to 'py3' tagged wheels (#1388)
15
16 - remove deprecated `--py36` option (#1236)
17
18 - add `--force-exclude` argument (#1032)
19
20 #### Vim plugin
21
22 - prefer virtualenv packages over global packages (#1383)
23
24 ### 19.10b0
25
26 - added support for PEP 572 assignment expressions (#711)
27
28 - added support for PEP 570 positional-only arguments (#943)
29
30 - added support for async generators (#593)
31
32 - added support for pre-splitting collections by putting an explicit trailing comma
33   inside (#826)
34
35 - added `black -c` as a way to format code passed from the command line (#761)
36
37 - --safe now works with Python 2 code (#840)
38
39 - fixed grammar selection for Python 2-specific code (#765)
40
41 - fixed feature detection for trailing commas in function definitions and call sites
42   (#763)
43
44 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
45   code now behave correctly (#1005)
46
47 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
48
49 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
50
51 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
52
53 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
54
55 - _Black_ no longer fails on comments in from-imports (#671)
56
57 - _Black_ no longer fails when the file starts with a backslash (#922)
58
59 - _Black_ no longer merges regular comments with type comments (#1027)
60
61 - _Black_ no longer splits long lines that contain type comments (#997)
62
63 - removed unnecessary parentheses around `yield` expressions (#834)
64
65 - added parentheses around long tuples in unpacking assignments (#832)
66
67 - added parentheses around complex powers when they are prefixed by a unary operator
68   (#646)
69
70 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
71
72 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
73   (#863)
74
75 - if _Black_ puts parenthesis around a single expression, it moves comments to the
76   wrapped expression instead of after the brackets (#872)
77
78 - `blackd` now returns the version of _Black_ in the response headers (#1013)
79
80 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
81   provided (#969)
82
83 ### 19.3b0
84
85 - new option `--target-version` to control which Python versions _Black_-formatted code
86   should target (#618)
87
88 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
89
90 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
91
92 - long `del` statements are now split into multiple lines (#698)
93
94 - type comments are no longer mangled in function signatures
95
96 - improved performance of formatting deeply nested data structures (#509)
97
98 - _Black_ now properly formats multiple files in parallel on Windows (#632)
99
100 - _Black_ now creates cache files atomically which allows it to be used in parallel
101   pipelines (like `xargs -P8`) (#673)
102
103 - _Black_ now correctly indents comments in files that were previously formatted with
104   tabs (#262)
105
106 - `blackd` now supports CORS (#622)
107
108 ### 18.9b0
109
110 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
111
112   - numeric literals are normalized to include `_` separators on Python 3.6+ code
113
114   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
115     leave numeric underscores as they were in the input
116
117   - code with `_` in numeric literals is recognized as Python 3.6+
118
119   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
120
121   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
122
123 - added `blackd`, see [its documentation](#blackd) for more info (#349)
124
125 - adjacent string literals are now correctly split into multiple lines (#463)
126
127 - trailing comma is now added to single imports that don't fit on a line (#250)
128
129 - cache is now populated when `--check` is successful for a file which speeds up
130   consecutive checks of properly formatted unmodified files (#448)
131
132 - whitespace at the beginning of the file is now removed (#399)
133
134 - fixed mangling [pweave](http://mpastell.com/pweave/) and
135   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
136
137 - fixed unstable formatting when unpacking big tuples (#267)
138
139 - fixed parsing of `__future__` imports with renames (#389)
140
141 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
142
143 - fixed formatting of lambda expressions with default arguments (#468)
144
145 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
146
147 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
148   be a bad idea (#415)
149
150 ### 18.6b4
151
152 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
153
154 ### 18.6b3
155
156 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
157
158 - `# fmt: off` and `# fmt: on` are now much more dependable:
159
160   - they now work also within bracket pairs (#329)
161
162   - they now correctly work across function/class boundaries (#335)
163
164   - they now work when an indentation block starts with empty lines or misaligned
165     comments (#334)
166
167 - made Click not fail on invalid environments; note that Click is right but the
168   likelihood we'll need to access non-ASCII file paths when dealing with Python source
169   code is low (#277)
170
171 - fixed improper formatting of f-strings with quotes inside interpolated expressions
172   (#322)
173
174 - fixed unnecessary slowdown when long list literals where found in a file
175
176 - fixed unnecessary slowdown on AST nodes with very many siblings
177
178 - fixed cannibalizing backslashes during string normalization
179
180 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
181
182 ### 18.6b2
183
184 - added `--config` (#65)
185
186 - added `-h` equivalent to `--help` (#316)
187
188 - fixed improper unmodified file caching when `-S` was used
189
190 - fixed extra space in string unpacking (#305)
191
192 - fixed formatting of empty triple quoted strings (#313)
193
194 - fixed unnecessary slowdown in comment placement calculation on lines without comments
195
196 ### 18.6b1
197
198 - hotfix: don't output human-facing information on stdout (#299)
199
200 - hotfix: don't output cake emoji on non-zero return code (#300)
201
202 ### 18.6b0
203
204 - added `--include` and `--exclude` (#270)
205
206 - added `--skip-string-normalization` (#118)
207
208 - added `--verbose` (#283)
209
210 - the header output in `--diff` now actually conforms to the unified diff spec
211
212 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
213
214 - fixed unnecessary parentheses when a line contained multiline strings (#232)
215
216 - fixed stdin handling not working correctly if an old version of Click was used (#276)
217
218 - _Black_ now preserves line endings when formatting a file in place (#258)
219
220 ### 18.5b1
221
222 - added `--pyi` (#249)
223
224 - added `--py36` (#249)
225
226 - Python grammar pickle caches are stored with the formatting caches, making _Black_
227   work in environments where site-packages is not user-writable (#192)
228
229 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
230   fields) and the first method
231
232 - fixed invalid code produced when standalone comments were present in a trailer that
233   was omitted from line splitting on a large expression (#237)
234
235 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
236
237 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
238   in optional parentheses (#234)
239
240 - fixed unstable formatting when inline comments were moved around in a trailer that was
241   omitted from line splitting on a large expression (#238)
242
243 - fixed extra empty line between a class declaration and the first method if no class
244   docstring or fields are present (#219)
245
246 - fixed extra empty line between a function signature and an inner function or inner
247   class (#196)
248
249 ### 18.5b0
250
251 - call chains are now formatted according to the
252   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
253
254 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
255   exploded like imports when they don't fit in a single line (#152)
256
257 - slices are now formatted according to PEP 8 (#178)
258
259 - parentheses are now also managed automatically on the right-hand side of assignments
260   and return statements (#140)
261
262 - math operators now use their respective priorities for delimiting multiline
263   expressions (#148)
264
265 - optional parentheses are now omitted on expressions that start or end with a bracket
266   and only contain a single operator (#177)
267
268 - empty parentheses in a class definition are now removed (#145, #180)
269
270 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
271   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
272   #199)
273
274 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
275   484 (#207, #210)
276
277 - progress when reformatting many files is now reported incrementally
278
279 - fixed trailers (content with brackets) being unnecessarily exploded into their own
280   lines after a dedented closing bracket (#119)
281
282 - fixed an invalid trailing comma sometimes left in imports (#185)
283
284 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
285   used (#183)
286
287 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
288   assignments (#215)
289
290 - fixed not splitting long from-imports with only a single name
291
292 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
293   This fixed non-deterministic formatting if trailing commas where used both in function
294   signatures with stars and function calls with stars but the former would be
295   reformatted to a single line.
296
297 - fixed crash on dealing with optional parentheses (#193)
298
299 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
300   purposes
301
302 - fixed crash when dead symlinks where encountered
303
304 ### 18.4a4
305
306 - don't populate the cache on `--check` (#175)
307
308 ### 18.4a3
309
310 - added a "cache"; files already reformatted that haven't changed on disk won't be
311   reformatted again (#109)
312
313 - `--check` and `--diff` are no longer mutually exclusive (#149)
314
315 - generalized star expression handling, including double stars; this fixes
316   multiplication making expressions "unsafe" for trailing commas (#132)
317
318 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
319
320 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
321
322 - fixed comment indentation when a standalone comment closes a block (#16, #32)
323
324 - fixed standalone comments receiving extra empty lines if immediately preceding a
325   class, def, or decorator (#56, #154)
326
327 - fixed `--diff` not showing entire path (#130)
328
329 - fixed parsing of complex expressions after star and double stars in function calls
330   (#2)
331
332 - fixed invalid splitting on comma in lambda arguments (#133)
333
334 - fixed missing splits of ternary expressions (#141)
335
336 ### 18.4a2
337
338 - fixed parsing of unaligned standalone comments (#99, #112)
339
340 - fixed placement of dictionary unpacking inside dictionary literals (#111)
341
342 - Vim plugin now works on Windows, too
343
344 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
345   (#120)
346
347 ### 18.4a1
348
349 - added `--quiet` (#78)
350
351 - added automatic parentheses management (#4)
352
353 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
354
355 - fixed reporting on `--check` with multiple files (#101, #102)
356
357 - fixed removing backslash escapes from raw strings (#100, #105)
358
359 ### 18.4a0
360
361 - added `--diff` (#87)
362
363 - add line breaks before all delimiters, except in cases like commas, to better comply
364   with PEP 8 (#73)
365
366 - standardize string literals to use double quotes (almost) everywhere (#75)
367
368 - fixed handling of standalone comments within nested bracketed expressions; _Black_
369   will no longer produce super long lines or put all standalone comments at the end of
370   the expression (#22)
371
372 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
373   (#80)
374
375 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
376   _Black_ to not emit the rest of the file (#95)
377
378 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
379   a flurry of asyncio-related exceptions
380
381 - only allow up to two empty lines on module level and only single empty lines within
382   functions (#74)
383
384 ### 18.3a4
385
386 - `# fmt: off` and `# fmt: on` are implemented (#5)
387
388 - automatic detection of deprecated Python 2 forms of print statements and exec
389   statements in the formatted file (#49)
390
391 - use proper spaces for complex expressions in default values of typed function
392   arguments (#60)
393
394 - only return exit code 1 when --check is used (#50)
395
396 - don't remove single trailing commas from square bracket indexing (#59)
397
398 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
399
400 - omit extra space in kwarg unpacking if it's the first argument (#46)
401
402 - omit extra space in
403   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
404   (#68)
405
406 ### 18.3a3
407
408 - don't remove single empty lines outside of bracketed expressions (#19)
409
410 - added ability to pipe formatting from stdin to stdin (#25)
411
412 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
413
414 - even better handling of numpy-style array indexing (#33, again)
415
416 ### 18.3a2
417
418 - changed positioning of binary operators to occur at beginning of lines instead of at
419   the end, following
420   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
421   (#21)
422
423 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
424   formattings (#34, #35)
425
426 - remove a trailing comma if there is a single argument to a call
427
428 - if top level functions were separated by a comment, don't put four empty lines after
429   the upper function
430
431 - fixed unstable formatting of newlines with imports
432
433 - fixed unintentional folding of post scriptum standalone comments into last statement
434   if it was a simple statement (#18, #28)
435
436 - fixed missing space in numpy-style array indexing (#33)
437
438 - fixed spurious space after star-based unary expressions (#31)
439
440 ### 18.3a1
441
442 - added `--check`
443
444 - only put trailing commas in function signatures and calls if it's safe to do so. If
445   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
446   or `**kwargs` used in the signature or call. (#8)
447
448 - fixed invalid spacing of dots in relative imports (#6, #13)
449
450 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
451
452 - fixed spurious space in parenthesized set expressions (#7)
453
454 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
455
456 - fixed spurious space after unary operators when the operand was a complex expression
457   (#15)
458
459 ### 18.3a0
460
461 - first published version, Happy 🍰 Day 2018!
462
463 - alpha quality
464
465 - date-versioned (see: https://calver.org/)