]> git.madduck.net Git - etc/vim.git/blob - docs/change_log.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:

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