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

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