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

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