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

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