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

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