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

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