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

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