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

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