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

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