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

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