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

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