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

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