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

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