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