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

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