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

d084498f404ab4696847adbd93be0e550d2c7de5
[etc/vim.git] / CHANGES.md
1 # Change Log
2
3 ## Unreleased
4
5 ### Highlights
6
7 <!-- Include any especially major or disruptive changes here -->
8
9 ### Stable style
10
11 <!-- Changes that affect Black's stable style -->
12
13 ### Preview style
14
15 <!-- Changes that affect Black's preview style -->
16
17 - More concise formatting for dummy implementations (#3796)
18
19 ### Configuration
20
21 <!-- Changes to how Black can be configured -->
22
23 ### Packaging
24
25 <!-- Changes to how Black is packaged, such as dependency requirements -->
26
27 ### Parser
28
29 <!-- Changes to the parser or to version autodetection -->
30
31 ### Performance
32
33 <!-- Changes that improve Black's performance. -->
34
35 - Avoid importing `IPython` if notebook cells do not contain magics (#3782)
36
37 ### Output
38
39 <!-- Changes to Black's terminal output and error messages -->
40
41 ### _Blackd_
42
43 <!-- Changes to blackd -->
44
45 ### Integrations
46
47 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
48
49 - Black now has an
50   [official pre-commit mirror](https://github.com/psf/black-pre-commit-mirror). Swapping
51   `https://github.com/psf/black` to `https://github.com/psf/black-pre-commit-mirror` in
52   your `.pre-commit-config.yaml` will make Black about 2x faster (#3828)
53
54 ### Documentation
55
56 <!-- Major changes to documentation and policies. Small docs changes
57      don't need a changelog entry. -->
58
59 ## 23.7.0
60
61 ### Highlights
62
63 - Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
64   supported until further notice (#3765)
65
66 ### Stable style
67
68 - Fix a bug where an illegal trailing comma was added to return type annotations using
69   PEP 604 unions (#3735)
70 - Fix several bugs and crashes where comments in stub files were removed or mishandled
71   under some circumstances (#3745)
72 - Fix a crash with multi-line magic comments like `type: ignore` within parentheses
73   (#3740)
74 - Fix error in AST validation when _Black_ removes trailing whitespace in a type comment
75   (#3773)
76
77 ### Preview style
78
79 - Implicitly concatenated strings used as function args are no longer wrapped inside
80   parentheses (#3640)
81 - Remove blank lines between a class definition and its docstring (#3692)
82
83 ### Configuration
84
85 - The `--workers` argument to _Black_ can now be specified via the `BLACK_NUM_WORKERS`
86   environment variable (#3743)
87 - `.pytest_cache`, `.ruff_cache` and `.vscode` are now excluded by default (#3691)
88 - Fix _Black_ not honouring `pyproject.toml` settings when running `--stdin-filename`
89   and the `pyproject.toml` found isn't in the current working directory (#3719)
90 - _Black_ will now error if `exclude` and `extend-exclude` have invalid data types in
91   `pyproject.toml`, instead of silently doing the wrong thing (#3764)
92
93 ### Packaging
94
95 - Upgrade mypyc from 0.991 to 1.3 (#3697)
96 - Remove patching of Click that mitigated errors on Python 3.6 with `LANG=C` (#3768)
97
98 ### Parser
99
100 - Add support for the new PEP 695 syntax in Python 3.12 (#3703)
101
102 ### Performance
103
104 - Speed up _Black_ significantly when the cache is full (#3751)
105 - Avoid importing `IPython` in a case where we wouldn't need it (#3748)
106
107 ### Output
108
109 - Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#3728)
110 - Change verbose logging to exactly mirror _Black_'s logic for source discovery (#3749)
111
112 ### _Blackd_
113
114 - The `blackd` argument parser now shows the default values for options in their help
115   text (#3712)
116
117 ### Integrations
118
119 - Black is now tested with
120   [`PYTHONWARNDEFAULTENCODING = 1`](https://docs.python.org/3/library/io.html#io-encoding-warning)
121   (#3763)
122 - Update GitHub Action to display black output in the job summary (#3688)
123
124 ### Documentation
125
126 - Add a CITATION.cff file to the root of the repository, containing metadata on how to
127   cite this software (#3723)
128 - Update the _classes_ and _exceptions_ documentation in Developer reference to match
129   the latest code base (#3755)
130
131 ## 23.3.0
132
133 ### Highlights
134
135 This release fixes a longstanding confusing behavior in Black's GitHub action, where the
136 version of the action did not determine the version of Black being run (issue #3382). In
137 addition, there is a small bug fix around imports and a number of improvements to the
138 preview style.
139
140 Please try out the
141 [preview style](https://black.readthedocs.io/en/stable/the_black_code_style/future_style.html#preview-style)
142 with `black --preview` and tell us your feedback. All changes in the preview style are
143 expected to become part of Black's stable style in January 2024.
144
145 ### Stable style
146
147 - Import lines with `# fmt: skip` and `# fmt: off` no longer have an extra blank line
148   added when they are right after another import line (#3610)
149
150 ### Preview style
151
152 - Add trailing commas to collection literals even if there's a comment after the last
153   entry (#3393)
154 - `async def`, `async for`, and `async with` statements are now formatted consistently
155   compared to their non-async version. (#3609)
156 - `with` statements that contain two context managers will be consistently wrapped in
157   parentheses (#3589)
158 - Let string splitters respect [East Asian Width](https://www.unicode.org/reports/tr11/)
159   (#3445)
160 - Now long string literals can be split after East Asian commas and periods (`、` U+3001
161   IDEOGRAPHIC COMMA, `。` U+3002 IDEOGRAPHIC FULL STOP, & `,` U+FF0C FULLWIDTH COMMA)
162   besides before spaces (#3445)
163 - For stubs, enforce one blank line after a nested class with a body other than just
164   `...` (#3564)
165 - Improve handling of multiline strings by changing line split behavior (#1879)
166
167 ### Parser
168
169 - Added support for formatting files with invalid type comments (#3594)
170
171 ### Integrations
172
173 - Update GitHub Action to use the version of Black equivalent to action's version if
174   version input is not specified (#3543)
175 - Fix missing Python binary path in autoload script for vim (#3508)
176
177 ### Documentation
178
179 - Document that only the most recent release is supported for security issues;
180   vulnerabilities should be reported through Tidelift (#3612)
181
182 ## 23.1.0
183
184 ### Highlights
185
186 This is the first release of 2023, and following our
187 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy),
188 it comes with a number of improvements to our stable style, including improvements to
189 empty line handling, removal of redundant parentheses in several contexts, and output
190 that highlights implicitly concatenated strings better.
191
192 There are also many changes to the preview style; try out `black --preview` and give us
193 feedback to help us set the stable style for next year.
194
195 In addition to style changes, Black now automatically infers the supported Python
196 versions from your `pyproject.toml` file, removing the need to set Black's target
197 versions separately.
198
199 ### Stable style
200
201 <!-- Changes that affect Black's stable style -->
202
203 - Introduce the 2023 stable style, which incorporates most aspects of last year's
204   preview style (#3418). Specific changes:
205   - Enforce empty lines before classes and functions with sticky leading comments
206     (#3302) (22.12.0)
207   - Reformat empty and whitespace-only files as either an empty file (if no newline is
208     present) or as a single newline character (if a newline is present) (#3348)
209     (22.12.0)
210   - Implicitly concatenated strings used as function args are now wrapped inside
211     parentheses (#3307) (22.12.0)
212   - Correctly handle trailing commas that are inside a line's leading non-nested parens
213     (#3370) (22.12.0)
214   - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
215     normalized as expected (#3168) (since 22.8.0)
216   - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
217     subscript expressions with more than 1 element (#3209) (22.8.0)
218   - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
219     parentheses (#3162) (22.8.0)
220   - Fix a string merging/split issue when a comment is present in the middle of
221     implicitly concatenated strings on its own line (#3227) (22.8.0)
222   - Docstring quotes are no longer moved if it would violate the line length limit
223     (#3044, #3430) (22.6.0)
224   - Parentheses around return annotations are now managed (#2990) (22.6.0)
225   - Remove unnecessary parentheses around awaited objects (#2991) (22.6.0)
226   - Remove unnecessary parentheses in `with` statements (#2926) (22.6.0)
227   - Remove trailing newlines after code block open (#3035) (22.6.0)
228   - Code cell separators `#%%` are now standardised to `# %%` (#2919) (22.3.0)
229   - Remove unnecessary parentheses from `except` statements (#2939) (22.3.0)
230   - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945) (22.3.0)
231   - Avoid magic-trailing-comma in single-element subscripts (#2942) (22.3.0)
232 - Fix a crash when a colon line is marked between `# fmt: off` and `# fmt: on` (#3439)
233
234 ### Preview style
235
236 <!-- Changes that affect Black's preview style -->
237
238 - Format hex codes in unicode escape sequences in string literals (#2916)
239 - Add parentheses around `if`-`else` expressions (#2278)
240 - Improve performance on large expressions that contain many strings (#3467)
241 - Fix a crash in preview style with assert + parenthesized string (#3415)
242 - Fix crashes in preview style with walrus operators used in function return annotations
243   and except clauses (#3423)
244 - Fix a crash in preview advanced string processing where mixed implicitly concatenated
245   regular and f-strings start with an empty span (#3463)
246 - Fix a crash in preview advanced string processing where a standalone comment is placed
247   before a dict's value (#3469)
248 - Fix an issue where extra empty lines are added when a decorator has `# fmt: skip`
249   applied or there is a standalone comment between decorators (#3470)
250 - Do not put the closing quotes in a docstring on a separate line, even if the line is
251   too long (#3430)
252 - Long values in dict literals are now wrapped in parentheses; correspondingly
253   unnecessary parentheses around short values in dict literals are now removed; long
254   string lambda values are now wrapped in parentheses (#3440)
255 - Fix two crashes in preview style involving edge cases with docstrings (#3451)
256 - Exclude string type annotations from improved string processing; fix crash when the
257   return type annotation is stringified and spans across multiple lines (#3462)
258 - Wrap multiple context managers in parentheses when targeting Python 3.9+ (#3489)
259 - Fix several crashes in preview style with walrus operators used in `with` statements
260   or tuples (#3473)
261 - Fix an invalid quote escaping bug in f-string expressions where it produced invalid
262   code. Implicitly concatenated f-strings with different quotes can now be merged or
263   quote-normalized by changing the quotes used in expressions. (#3509)
264 - Fix crash on `await (yield)` when Black is compiled with mypyc (#3533)
265
266 ### Configuration
267
268 <!-- Changes to how Black can be configured -->
269
270 - Black now tries to infer its `--target-version` from the project metadata specified in
271   `pyproject.toml` (#3219)
272
273 ### Packaging
274
275 <!-- Changes to how Black is packaged, such as dependency requirements -->
276
277 - Upgrade mypyc from `0.971` to `0.991` so mypycified _Black_ can be built on armv7
278   (#3380)
279   - This also fixes some crashes while using compiled Black with a debug build of
280     CPython
281 - Drop specific support for the `tomli` requirement on 3.11 alpha releases, working
282   around a bug that would cause the requirement not to be installed on any non-final
283   Python releases (#3448)
284 - Black now depends on `packaging` version `22.0` or later. This is required for new
285   functionality that needs to parse part of the project metadata (#3219)
286
287 ### Output
288
289 <!-- Changes to Black's terminal output and error messages -->
290
291 - Calling `black --help` multiple times will return the same help contents each time
292   (#3516)
293 - Verbose logging now shows the values of `pyproject.toml` configuration variables
294   (#3392)
295 - Fix false symlink detection messages in verbose output due to using an incorrect
296   relative path to the project root (#3385)
297
298 ### Integrations
299
300 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
301
302 - Move 3.11 CI to normal flow now that all dependencies support 3.11 (#3446)
303 - Docker: Add new `latest_prerelease` tag automation to follow latest black alpha
304   release on docker images (#3465)
305
306 ### Documentation
307
308 <!-- Major changes to documentation and policies. Small docs changes
309      don't need a changelog entry. -->
310
311 - Expand `vim-plug` installation instructions to offer more explicit options (#3468)
312
313 ## 22.12.0
314
315 ### Preview style
316
317 <!-- Changes that affect Black's preview style -->
318
319 - Enforce empty lines before classes and functions with sticky leading comments (#3302)
320 - Reformat empty and whitespace-only files as either an empty file (if no newline is
321   present) or as a single newline character (if a newline is present) (#3348)
322 - Implicitly concatenated strings used as function args are now wrapped inside
323   parentheses (#3307)
324 - For assignment statements, prefer splitting the right hand side if the left hand side
325   fits on a single line (#3368)
326 - Correctly handle trailing commas that are inside a line's leading non-nested parens
327   (#3370)
328
329 ### Configuration
330
331 <!-- Changes to how Black can be configured -->
332
333 - Fix incorrectly applied `.gitignore` rules by considering the `.gitignore` location
334   and the relative path to the target file (#3338)
335 - Fix incorrectly ignoring `.gitignore` presence when more than one source directory is
336   specified (#3336)
337
338 ### Parser
339
340 <!-- Changes to the parser or to version autodetection -->
341
342 - Parsing support has been added for walruses inside generator expression that are
343   passed as function args (for example,
344   `any(match := my_re.match(text) for text in texts)`) (#3327).
345
346 ### Integrations
347
348 <!-- For example, Docker, GitHub Actions, pre-commit, editors -->
349
350 - Vim plugin: Optionally allow using the system installation of Black via
351   `let g:black_use_virtualenv = 0`(#3309)
352
353 ## 22.10.0
354
355 ### Highlights
356
357 - Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
358   supported until further notice.
359
360 ### Stable style
361
362 - Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
363   (#3281)
364
365 ### Preview style
366
367 - Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
368   (#3262)
369
370 ### Configuration
371
372 - `.ipynb_checkpoints` directories are now excluded by default (#3293)
373 - Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
374   while formatting (#3299)
375
376 ### Packaging
377
378 - Executables made with PyInstaller will no longer crash when formatting several files
379   at once on macOS. Native x86-64 executables for macOS are available once again.
380   (#3275)
381 - Hatchling is now used as the build backend. This will not have any effect for users
382   who install Black with its wheels from PyPI. (#3233)
383 - Faster compiled wheels are now available for CPython 3.11 (#3276)
384
385 ### _Blackd_
386
387 - Windows style (CRLF) newlines will be preserved (#3257).
388
389 ### Integrations
390
391 - Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)
392 - Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
393   option (#3282)
394 - Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
395   version (#3265)
396
397 ## 22.8.0
398
399 ### Highlights
400
401 - Python 3.11 is now supported, except for _blackd_ as aiohttp does not support 3.11 as
402   of publishing (#3234)
403 - This is the last release that supports running _Black_ on Python 3.6 (formatting 3.6
404   code will continue to be supported until further notice)
405 - Reword the stability policy to say that we may, in rare cases, make changes that
406   affect code that was not previously formatted by _Black_ (#3155)
407
408 ### Stable style
409
410 - Fix an infinite loop when using `# fmt: on/off` in the middle of an expression or code
411   block (#3158)
412 - Fix incorrect handling of `# fmt: skip` on colon (`:`) lines (#3148)
413 - Comments are no longer deleted when a line had spaces removed around power operators
414   (#2874)
415
416 ### Preview style
417
418 - Single-character closing docstring quotes are no longer moved to their own line as
419   this is invalid. This was a bug introduced in version 22.6.0. (#3166)
420 - `--skip-string-normalization` / `-S` now prevents docstring prefixes from being
421   normalized as expected (#3168)
422 - When using `--skip-magic-trailing-comma` or `-C`, trailing commas are stripped from
423   subscript expressions with more than 1 element (#3209)
424 - Implicitly concatenated strings inside a list, set, or tuple are now wrapped inside
425   parentheses (#3162)
426 - Fix a string merging/split issue when a comment is present in the middle of implicitly
427   concatenated strings on its own line (#3227)
428
429 ### _Blackd_
430
431 - `blackd` now supports enabling the preview style via the `X-Preview` header (#3217)
432
433 ### Configuration
434
435 - Black now uses the presence of debug f-strings to detect target version (#3215)
436 - Fix misdetection of project root and verbose logging of sources in cases involving
437   `--stdin-filename` (#3216)
438 - Immediate `.gitignore` files in source directories given on the command line are now
439   also respected, previously only `.gitignore` files in the project root and
440   automatically discovered directories were respected (#3237)
441
442 ### Documentation
443
444 - Recommend using BlackConnect in IntelliJ IDEs (#3150)
445
446 ### Integrations
447
448 - Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
449 - Docker: changed to a /opt/venv installation + added to PATH to be available to
450   non-root users (#3202)
451
452 ### Output
453
454 - Change from deprecated `asyncio.get_event_loop()` to create our event loop which
455   removes DeprecationWarning (#3164)
456 - Remove logging from internal `blib2to3` library since it regularly emits error logs
457   about failed caching that can and should be ignored (#3193)
458
459 ### Parser
460
461 - Type comments are now included in the AST equivalence check consistently so accidental
462   deletion raises an error. Though type comments can't be tracked when running on PyPy
463   3.7 due to standard library limitations. (#2874)
464
465 ### Performance
466
467 - Reduce Black's startup time when formatting a single file by 15-30% (#3211)
468
469 ## 22.6.0
470
471 ### Style
472
473 - Fix unstable formatting involving `#fmt: skip` and `# fmt:skip` comments (notice the
474   lack of spaces) (#2970)
475
476 ### Preview style
477
478 - Docstring quotes are no longer moved if it would violate the line length limit (#3044)
479 - Parentheses around return annotations are now managed (#2990)
480 - Remove unnecessary parentheses around awaited objects (#2991)
481 - Remove unnecessary parentheses in `with` statements (#2926)
482 - Remove trailing newlines after code block open (#3035)
483
484 ### Integrations
485
486 - Add `scripts/migrate-black.py` script to ease introduction of Black to a Git project
487   (#3038)
488
489 ### Output
490
491 - Output Python version and implementation as part of `--version` flag (#2997)
492
493 ### Packaging
494
495 - Use `tomli` instead of `tomllib` on Python 3.11 builds where `tomllib` is not
496   available (#2987)
497
498 ### Parser
499
500 - [PEP 654](https://peps.python.org/pep-0654/#except) syntax (for example,
501   `except *ExceptionGroup:`) is now supported (#3016)
502 - [PEP 646](https://peps.python.org/pep-0646) syntax (for example,
503   `Array[Batch, *Shape]` or `def fn(*args: *T) -> None`) is now supported (#3071)
504
505 ### Vim Plugin
506
507 - Fix `strtobool` function. It didn't parse true/on/false/off. (#3025)
508
509 ## 22.3.0
510
511 ### Preview style
512
513 - Code cell separators `#%%` are now standardised to `# %%` (#2919)
514 - Remove unnecessary parentheses from `except` statements (#2939)
515 - Remove unnecessary parentheses from tuple unpacking in `for` loops (#2945)
516 - Avoid magic-trailing-comma in single-element subscripts (#2942)
517
518 ### Configuration
519
520 - Do not format `__pypackages__` directories by default (#2836)
521 - Add support for specifying stable version with `--required-version` (#2832).
522 - Avoid crashing when the user has no homedir (#2814)
523 - Avoid crashing when md5 is not available (#2905)
524 - Fix handling of directory junctions on Windows (#2904)
525
526 ### Documentation
527
528 - Update pylint config documentation (#2931)
529
530 ### Integrations
531
532 - Move test to disable plugin in Vim/Neovim, which speeds up loading (#2896)
533
534 ### Output
535
536 - In verbose mode, log when _Black_ is using user-level config (#2861)
537
538 ### Packaging
539
540 - Fix Black to work with Click 8.1.0 (#2966)
541 - On Python 3.11 and newer, use the standard library's `tomllib` instead of `tomli`
542   (#2903)
543 - `black-primer`, the deprecated internal devtool, has been removed and copied to a
544   [separate repository](https://github.com/cooperlees/black-primer) (#2924)
545
546 ### Parser
547
548 - Black can now parse starred expressions in the target of `for` and `async for`
549   statements, e.g `for item in *items_1, *items_2: pass` (#2879).
550
551 ## 22.1.0
552
553 At long last, _Black_ is no longer a beta product! This is the first non-beta release
554 and the first release covered by our new
555 [stability policy](https://black.readthedocs.io/en/stable/the_black_code_style/index.html#stability-policy).
556
557 ### Highlights
558
559 - **Remove Python 2 support** (#2740)
560 - Introduce the `--preview` flag (#2752)
561
562 ### Style
563
564 - Deprecate `--experimental-string-processing` and move the functionality under
565   `--preview` (#2789)
566 - For stubs, one blank line between class attributes and methods is now kept if there's
567   at least one pre-existing blank line (#2736)
568 - Black now normalizes string prefix order (#2297)
569 - Remove spaces around power operators if both operands are simple (#2726)
570 - Work around bug that causes unstable formatting in some cases in the presence of the
571   magic trailing comma (#2807)
572 - Use parentheses for attribute access on decimal float and int literals (#2799)
573 - Don't add whitespace for attribute access on hexadecimal, binary, octal, and complex
574   literals (#2799)
575 - Treat blank lines in stubs the same inside top-level `if` statements (#2820)
576 - Fix unstable formatting with semicolons and arithmetic expressions (#2817)
577 - Fix unstable formatting around magic trailing comma (#2572)
578
579 ### Parser
580
581 - Fix mapping cases that contain as-expressions, like `case {"key": 1 | 2 as password}`
582   (#2686)
583 - Fix cases that contain multiple top-level as-expressions, like `case 1 as a, 2 as b`
584   (#2716)
585 - Fix call patterns that contain as-expressions with keyword arguments, like
586   `case Foo(bar=baz as quux)` (#2749)
587 - Tuple unpacking on `return` and `yield` constructs now implies 3.8+ (#2700)
588 - Unparenthesized tuples on annotated assignments (e.g
589   `values: Tuple[int, ...] = 1, 2, 3`) now implies 3.8+ (#2708)
590 - Fix handling of standalone `match()` or `case()` when there is a trailing newline or a
591   comment inside of the parentheses. (#2760)
592 - `from __future__ import annotations` statement now implies Python 3.7+ (#2690)
593
594 ### Performance
595
596 - Speed-up the new backtracking parser about 4X in general (enabled when
597   `--target-version` is set to 3.10 and higher). (#2728)
598 - _Black_ is now compiled with [mypyc](https://github.com/mypyc/mypyc) for an overall 2x
599   speed-up. 64-bit Windows, MacOS, and Linux (not including musl) are supported. (#1009,
600   #2431)
601
602 ### Configuration
603
604 - Do not accept bare carriage return line endings in pyproject.toml (#2408)
605 - Add configuration option (`python-cell-magics`) to format cells with custom magics in
606   Jupyter Notebooks (#2744)
607 - Allow setting custom cache directory on all platforms with environment variable
608   `BLACK_CACHE_DIR` (#2739).
609 - Enable Python 3.10+ by default, without any extra need to specify
610   `--target-version=py310`. (#2758)
611 - Make passing `SRC` or `--code` mandatory and mutually exclusive (#2804)
612
613 ### Output
614
615 - Improve error message for invalid regular expression (#2678)
616 - Improve error message when parsing fails during AST safety check by embedding the
617   underlying SyntaxError (#2693)
618 - No longer color diff headers white as it's unreadable in light themed terminals
619   (#2691)
620 - Text coloring added in the final statistics (#2712)
621 - Verbose mode also now describes how a project root was discovered and which paths will
622   be formatted. (#2526)
623
624 ### Packaging
625
626 - All upper version bounds on dependencies have been removed (#2718)
627 - `typing-extensions` is no longer a required dependency in Python 3.10+ (#2772)
628 - Set `click` lower bound to `8.0.0` (#2791)
629
630 ### Integrations
631
632 - Update GitHub action to support containerized runs (#2748)
633
634 ### Documentation
635
636 - Change protocol in pip installation instructions to `https://` (#2761)
637 - Change HTML theme to Furo primarily for its responsive design and mobile support
638   (#2793)
639 - Deprecate the `black-primer` tool (#2809)
640 - Document Python support policy (#2819)
641
642 ## 21.12b0
643
644 ### _Black_
645
646 - Fix determination of f-string expression spans (#2654)
647 - Fix bad formatting of error messages about EOF in multi-line statements (#2343)
648 - Functions and classes in blocks now have more consistent surrounding spacing (#2472)
649
650 #### Jupyter Notebook support
651
652 - Cell magics are now only processed if they are known Python cell magics. Earlier, all
653   cell magics were tokenized, leading to possible indentation errors e.g. with
654   `%%writefile`. (#2630)
655 - Fix assignment to environment variables in Jupyter Notebooks (#2642)
656
657 #### Python 3.10 support
658
659 - Point users to using `--target-version py310` if we detect 3.10-only syntax (#2668)
660 - Fix `match` statements with open sequence subjects, like `match a, b:` or
661   `match a, *b:` (#2639) (#2659)
662 - Fix `match`/`case` statements that contain `match`/`case` soft keywords multiple
663   times, like `match re.match()` (#2661)
664 - Fix `case` statements with an inline body (#2665)
665 - Fix styling of starred expressions inside `match` subject (#2667)
666 - Fix parser error location on invalid syntax in a `match` statement (#2649)
667 - Fix Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
668 - Improve parsing performance on code that uses `match` under `--target-version py310`
669   up to ~50% (#2670)
670
671 ### Packaging
672
673 - Remove dependency on `regex` (#2644) (#2663)
674
675 ## 21.11b1
676
677 ### _Black_
678
679 - Bumped regex version minimum to 2021.4.4 to fix Pattern class usage (#2621)
680
681 ## 21.11b0
682
683 ### _Black_
684
685 - Warn about Python 2 deprecation in more cases by improving Python 2 only syntax
686   detection (#2592)
687 - Add experimental PyPy support (#2559)
688 - Add partial support for the match statement. As it's experimental, it's only enabled
689   when `--target-version py310` is explicitly specified (#2586)
690 - Add support for parenthesized with (#2586)
691 - Declare support for Python 3.10 for running Black (#2562)
692
693 ### Integrations
694
695 - Fixed vim plugin with Python 3.10 by removing deprecated distutils import (#2610)
696 - The vim plugin now parses `skip_magic_trailing_comma` from pyproject.toml (#2613)
697
698 ## 21.10b0
699
700 ### _Black_
701
702 - Document stability policy, that will apply for non-beta releases (#2529)
703 - Add new `--workers` parameter (#2514)
704 - Fixed feature detection for positional-only arguments in lambdas (#2532)
705 - Bumped typed-ast version minimum to 1.4.3 for 3.10 compatibility (#2519)
706 - Fixed a Python 3.10 compatibility issue where the loop argument was still being passed
707   even though it has been removed (#2580)
708 - Deprecate Python 2 formatting support (#2523)
709
710 ### _Blackd_
711
712 - Remove dependency on aiohttp-cors (#2500)
713 - Bump required aiohttp version to 3.7.4 (#2509)
714
715 ### _Black-Primer_
716
717 - Add primer support for --projects (#2555)
718 - Print primer summary after individual failures (#2570)
719
720 ### Integrations
721
722 - Allow to pass `target_version` in the vim plugin (#1319)
723 - Install build tools in docker file and use multi-stage build to keep the image size
724   down (#2582)
725
726 ## 21.9b0
727
728 ### Packaging
729
730 - Fix missing modules in self-contained binaries (#2466)
731 - Fix missing toml extra used during installation (#2475)
732
733 ## 21.8b0
734
735 ### _Black_
736
737 - Add support for formatting Jupyter Notebook files (#2357)
738 - Move from `appdirs` dependency to `platformdirs` (#2375)
739 - Present a more user-friendly error if .gitignore is invalid (#2414)
740 - The failsafe for accidentally added backslashes in f-string expressions has been
741   hardened to handle more edge cases during quote normalization (#2437)
742 - Avoid changing a function return type annotation's type to a tuple by adding a
743   trailing comma (#2384)
744 - Parsing support has been added for unparenthesized walruses in set literals, set
745   comprehensions, and indices (#2447).
746 - Pin `setuptools-scm` build-time dependency version (#2457)
747 - Exclude typing-extensions version 3.10.0.1 due to it being broken on Python 3.10
748   (#2460)
749
750 ### _Blackd_
751
752 - Replace sys.exit(-1) with raise ImportError as it plays more nicely with tools that
753   scan installed packages (#2440)
754
755 ### Integrations
756
757 - The provided pre-commit hooks no longer specify `language_version` to avoid overriding
758   `default_language_version` (#2430)
759
760 ## 21.7b0
761
762 ### _Black_
763
764 - Configuration files using TOML features higher than spec v0.5.0 are now supported
765   (#2301)
766 - Add primer support and test for code piped into black via STDIN (#2315)
767 - Fix internal error when `FORCE_OPTIONAL_PARENTHESES` feature is enabled (#2332)
768 - Accept empty stdin (#2346)
769 - Provide a more useful error when parsing fails during AST safety checks (#2304)
770
771 ### Docker
772
773 - Add new `latest_release` tag automation to follow latest black release on docker
774   images (#2374)
775
776 ### Integrations
777
778 - The vim plugin now searches upwards from the directory containing the current buffer
779   instead of the current working directory for pyproject.toml. (#1871)
780 - The vim plugin now reads the correct string normalization option in pyproject.toml
781   (#1869)
782 - The vim plugin no longer crashes Black when there's boolean values in pyproject.toml
783   (#1869)
784
785 ## 21.6b0
786
787 ### _Black_
788
789 - Fix failure caused by `fmt: skip` and indentation (#2281)
790 - Account for += assignment when deciding whether to split string (#2312)
791 - Correct max string length calculation when there are string operators (#2292)
792 - Fixed option usage when using the `--code` flag (#2259)
793 - Do not call `uvloop.install()` when _Black_ is used as a library (#2303)
794 - Added `--required-version` option to require a specific version to be running (#2300)
795 - Fix incorrect custom breakpoint indices when string group contains fake f-strings
796   (#2311)
797 - Fix regression where `R` prefixes would be lowercased for docstrings (#2285)
798 - Fix handling of named escapes (`\N{...}`) when `--experimental-string-processing` is
799   used (#2319)
800
801 ### Integrations
802
803 - The official Black action now supports choosing what version to use, and supports the
804   major 3 OSes. (#1940)
805
806 ## 21.5b2
807
808 ### _Black_
809
810 - A space is no longer inserted into empty docstrings (#2249)
811 - Fix handling of .gitignore files containing non-ASCII characters on Windows (#2229)
812 - Respect `.gitignore` files in all levels, not only `root/.gitignore` file (apply
813   `.gitignore` rules like `git` does) (#2225)
814 - Restored compatibility with Click 8.0 on Python 3.6 when LANG=C used (#2227)
815 - Add extra uvloop install + import support if in python env (#2258)
816 - Fix --experimental-string-processing crash when matching parens are not found (#2283)
817 - Make sure to split lines that start with a string operator (#2286)
818 - Fix regular expression that black uses to identify f-expressions (#2287)
819
820 ### _Blackd_
821
822 - Add a lower bound for the `aiohttp-cors` dependency. Only 0.4.0 or higher is
823   supported. (#2231)
824
825 ### Packaging
826
827 - Release self-contained x86_64 MacOS binaries as part of the GitHub release pipeline
828   (#2198)
829 - Always build binaries with the latest available Python (#2260)
830
831 ### Documentation
832
833 - Add discussion of magic comments to FAQ page (#2272)
834 - `--experimental-string-processing` will be enabled by default in the future (#2273)
835 - Fix typos discovered by codespell (#2228)
836 - Fix Vim plugin installation instructions. (#2235)
837 - Add new Frequently Asked Questions page (#2247)
838 - Fix encoding + symlink issues preventing proper build on Windows (#2262)
839
840 ## 21.5b1
841
842 ### _Black_
843
844 - Refactor `src/black/__init__.py` into many files (#2206)
845
846 ### Documentation
847
848 - Replaced all remaining references to the
849   [`master`](https://github.com/psf/black/tree/main) branch with the
850   [`main`](https://github.com/psf/black/tree/main) branch. Some additional changes in
851   the source code were also made. (#2210)
852 - Sigificantly reorganized the documentation to make much more sense. Check them out by
853   heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
854   (#2174)
855
856 ## 21.5b0
857
858 ### _Black_
859
860 - Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
861 - Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
862   being called but with no arguments (#2182)
863
864 ### _Black-Primer_
865
866 - Add `--no-diff` to black-primer to suppress formatting changes (#2187)
867
868 ## 21.4b2
869
870 ### _Black_
871
872 - Fix crash if the user configuration directory is inaccessible. (#2158)
873
874 - Clarify
875   [circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
876   in which _Black_ may change the AST (#2159)
877
878 - Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
879   or on the command line. (#2170)
880
881 ### _Packaging_
882
883 - Install `primer.json` (used by `black-primer` by default) with black. (#2154)
884
885 ## 21.4b1
886
887 ### _Black_
888
889 - Fix crash on docstrings ending with "\\ ". (#2142)
890
891 - Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
892
893 - Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
894   in the name of the cache file. Without this fix, changes in these flags would not take
895   effect if the cache had already been populated. (#2131)
896
897 - Don't remove necessary parentheses from assignment expression containing assert /
898   return statements. (#2143)
899
900 ### _Packaging_
901
902 - Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
903
904 ## 21.4b0
905
906 ### _Black_
907
908 - Fixed a rare but annoying formatting instability created by the combination of
909   optional trailing commas inserted by `Black` and optional parentheses looking at
910   pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
911   duplicates. (#2126)
912
913 - `Black` now processes one-line docstrings by stripping leading and trailing spaces,
914   and adding a padding space when needed to break up """". (#1740)
915
916 - `Black` now cleans up leading non-breaking spaces in comments (#2092)
917
918 - `Black` now respects `--skip-string-normalization` when normalizing multiline
919   docstring quotes (#1637)
920
921 - `Black` no longer removes all empty lines between non-function code and decorators
922   when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
923
924 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
925   in if/while statements (#1655)
926
927 - Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
928   to split lines (#1824)
929
930 - fixed a crash when PWD=/ on POSIX (#1631)
931
932 - fixed "I/O operation on closed file" when using --diff (#1664)
933
934 - Prevent coloured diff output being interleaved with multiple files (#1673)
935
936 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
937
938 - Added parsing support for unparenthesized tuples and yield expressions in annotated
939   assignments (#1835)
940
941 - added `--extend-exclude` argument (PR #2005)
942
943 - speed up caching by avoiding pathlib (#1950)
944
945 - `--diff` correctly indicates when a file doesn't end in a newline (#1662)
946
947 - Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
948   (#1780)
949
950 - Lines ending with `fmt: skip` will now be not formatted (#1800)
951
952 - PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
953
954 - PR #2053: Python 2 support is now optional, install with
955   `python3 -m pip install black[python2]` to maintain support.
956
957 - Exclude `venv` directory by default (#1683)
958
959 - Fixed "Black produced code that is not equivalent to the source" when formatting
960   Python 2 docstrings (#2037)
961
962 ### _Packaging_
963
964 - Self-contained native _Black_ binaries are now provided for releases via GitHub
965   Releases (#1743)
966
967 ## 20.8b1
968
969 ### _Packaging_
970
971 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
972   older than 7.0
973
974 ## 20.8b0
975
976 ### _Black_
977
978 - re-implemented support for explicit trailing commas: now it works consistently within
979   any bracket pair, including nested structures (#1288 and duplicates)
980
981 - `Black` now reindents docstrings when reindenting code around it (#1053)
982
983 - `Black` now shows colored diffs (#1266)
984
985 - `Black` is now packaged using 'py3' tagged wheels (#1388)
986
987 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
988   (#1121)
989
990 - `Black` no longer normalizes capital R-string prefixes as those have a
991   community-accepted meaning (#1244)
992
993 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
994
995 - `Black` now works on AWS Lambda (#1141)
996
997 - added `--force-exclude` argument (#1032)
998
999 - removed deprecated `--py36` option (#1236)
1000
1001 - fixed `--diff` output when EOF is encountered (#526)
1002
1003 - fixed `# fmt: off` handling around decorators (#560)
1004
1005 - fixed unstable formatting with some `# type: ignore` comments (#1113)
1006
1007 - fixed invalid removal on organizing brackets followed by indexing (#1575)
1008
1009 - introduced `black-primer`, a CI tool that allows us to run regression tests against
1010   existing open source users of Black (#1402)
1011
1012 - introduced property-based fuzzing to our test suite based on Hypothesis and
1013   Hypothersmith (#1566)
1014
1015 - implemented experimental and disabled by default long string rewrapping (#1132),
1016   hidden under a `--experimental-string-processing` flag while it's being worked on;
1017   this is an undocumented and unsupported feature, you lose Internet points for
1018   depending on it (#1609)
1019
1020 ### Vim plugin
1021
1022 - prefer virtualenv packages over global packages (#1383)
1023
1024 ## 19.10b0
1025
1026 - added support for PEP 572 assignment expressions (#711)
1027
1028 - added support for PEP 570 positional-only arguments (#943)
1029
1030 - added support for async generators (#593)
1031
1032 - added support for pre-splitting collections by putting an explicit trailing comma
1033   inside (#826)
1034
1035 - added `black -c` as a way to format code passed from the command line (#761)
1036
1037 - --safe now works with Python 2 code (#840)
1038
1039 - fixed grammar selection for Python 2-specific code (#765)
1040
1041 - fixed feature detection for trailing commas in function definitions and call sites
1042   (#763)
1043
1044 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
1045   code now behave correctly (#1005)
1046
1047 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
1048
1049 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
1050
1051 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
1052
1053 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
1054
1055 - _Black_ no longer fails on comments in from-imports (#671)
1056
1057 - _Black_ no longer fails when the file starts with a backslash (#922)
1058
1059 - _Black_ no longer merges regular comments with type comments (#1027)
1060
1061 - _Black_ no longer splits long lines that contain type comments (#997)
1062
1063 - removed unnecessary parentheses around `yield` expressions (#834)
1064
1065 - added parentheses around long tuples in unpacking assignments (#832)
1066
1067 - added parentheses around complex powers when they are prefixed by a unary operator
1068   (#646)
1069
1070 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
1071
1072 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
1073   (#863)
1074
1075 - if _Black_ puts parenthesis around a single expression, it moves comments to the
1076   wrapped expression instead of after the brackets (#872)
1077
1078 - `blackd` now returns the version of _Black_ in the response headers (#1013)
1079
1080 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
1081   provided (#969)
1082
1083 ## 19.3b0
1084
1085 - new option `--target-version` to control which Python versions _Black_-formatted code
1086   should target (#618)
1087
1088 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
1089
1090 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
1091
1092 - long `del` statements are now split into multiple lines (#698)
1093
1094 - type comments are no longer mangled in function signatures
1095
1096 - improved performance of formatting deeply nested data structures (#509)
1097
1098 - _Black_ now properly formats multiple files in parallel on Windows (#632)
1099
1100 - _Black_ now creates cache files atomically which allows it to be used in parallel
1101   pipelines (like `xargs -P8`) (#673)
1102
1103 - _Black_ now correctly indents comments in files that were previously formatted with
1104   tabs (#262)
1105
1106 - `blackd` now supports CORS (#622)
1107
1108 ## 18.9b0
1109
1110 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
1111
1112   - numeric literals are normalized to include `_` separators on Python 3.6+ code
1113
1114   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
1115     leave numeric underscores as they were in the input
1116
1117   - code with `_` in numeric literals is recognized as Python 3.6+
1118
1119   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
1120
1121   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
1122
1123 - added `blackd`, see
1124   [its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
1125   more info (#349)
1126
1127 - adjacent string literals are now correctly split into multiple lines (#463)
1128
1129 - trailing comma is now added to single imports that don't fit on a line (#250)
1130
1131 - cache is now populated when `--check` is successful for a file which speeds up
1132   consecutive checks of properly formatted unmodified files (#448)
1133
1134 - whitespace at the beginning of the file is now removed (#399)
1135
1136 - fixed mangling [pweave](http://mpastell.com/pweave/) and
1137   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
1138
1139 - fixed unstable formatting when unpacking big tuples (#267)
1140
1141 - fixed parsing of `__future__` imports with renames (#389)
1142
1143 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
1144
1145 - fixed formatting of lambda expressions with default arguments (#468)
1146
1147 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
1148
1149 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
1150   be a bad idea (#415)
1151
1152 ## 18.6b4
1153
1154 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
1155
1156 ## 18.6b3
1157
1158 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
1159
1160 - `# fmt: off` and `# fmt: on` are now much more dependable:
1161
1162   - they now work also within bracket pairs (#329)
1163
1164   - they now correctly work across function/class boundaries (#335)
1165
1166   - they now work when an indentation block starts with empty lines or misaligned
1167     comments (#334)
1168
1169 - made Click not fail on invalid environments; note that Click is right but the
1170   likelihood we'll need to access non-ASCII file paths when dealing with Python source
1171   code is low (#277)
1172
1173 - fixed improper formatting of f-strings with quotes inside interpolated expressions
1174   (#322)
1175
1176 - fixed unnecessary slowdown when long list literals where found in a file
1177
1178 - fixed unnecessary slowdown on AST nodes with very many siblings
1179
1180 - fixed cannibalizing backslashes during string normalization
1181
1182 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
1183
1184 ## 18.6b2
1185
1186 - added `--config` (#65)
1187
1188 - added `-h` equivalent to `--help` (#316)
1189
1190 - fixed improper unmodified file caching when `-S` was used
1191
1192 - fixed extra space in string unpacking (#305)
1193
1194 - fixed formatting of empty triple quoted strings (#313)
1195
1196 - fixed unnecessary slowdown in comment placement calculation on lines without comments
1197
1198 ## 18.6b1
1199
1200 - hotfix: don't output human-facing information on stdout (#299)
1201
1202 - hotfix: don't output cake emoji on non-zero return code (#300)
1203
1204 ## 18.6b0
1205
1206 - added `--include` and `--exclude` (#270)
1207
1208 - added `--skip-string-normalization` (#118)
1209
1210 - added `--verbose` (#283)
1211
1212 - the header output in `--diff` now actually conforms to the unified diff spec
1213
1214 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1215
1216 - fixed unnecessary parentheses when a line contained multiline strings (#232)
1217
1218 - fixed stdin handling not working correctly if an old version of Click was used (#276)
1219
1220 - _Black_ now preserves line endings when formatting a file in place (#258)
1221
1222 ## 18.5b1
1223
1224 - added `--pyi` (#249)
1225
1226 - added `--py36` (#249)
1227
1228 - Python grammar pickle caches are stored with the formatting caches, making _Black_
1229   work in environments where site-packages is not user-writable (#192)
1230
1231 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
1232   fields) and the first method
1233
1234 - fixed invalid code produced when standalone comments were present in a trailer that
1235   was omitted from line splitting on a large expression (#237)
1236
1237 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
1238
1239 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
1240   in optional parentheses (#234)
1241
1242 - fixed unstable formatting when inline comments were moved around in a trailer that was
1243   omitted from line splitting on a large expression (#238)
1244
1245 - fixed extra empty line between a class declaration and the first method if no class
1246   docstring or fields are present (#219)
1247
1248 - fixed extra empty line between a function signature and an inner function or inner
1249   class (#196)
1250
1251 ## 18.5b0
1252
1253 - call chains are now formatted according to the
1254   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
1255
1256 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
1257   exploded like imports when they don't fit in a single line (#152)
1258
1259 - slices are now formatted according to PEP 8 (#178)
1260
1261 - parentheses are now also managed automatically on the right-hand side of assignments
1262   and return statements (#140)
1263
1264 - math operators now use their respective priorities for delimiting multiline
1265   expressions (#148)
1266
1267 - optional parentheses are now omitted on expressions that start or end with a bracket
1268   and only contain a single operator (#177)
1269
1270 - empty parentheses in a class definition are now removed (#145, #180)
1271
1272 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
1273   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
1274   #199)
1275
1276 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
1277   484 (#207, #210)
1278
1279 - progress when reformatting many files is now reported incrementally
1280
1281 - fixed trailers (content with brackets) being unnecessarily exploded into their own
1282   lines after a dedented closing bracket (#119)
1283
1284 - fixed an invalid trailing comma sometimes left in imports (#185)
1285
1286 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
1287   used (#183)
1288
1289 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
1290   assignments (#215)
1291
1292 - fixed not splitting long from-imports with only a single name
1293
1294 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
1295   This fixed non-deterministic formatting if trailing commas where used both in function
1296   signatures with stars and function calls with stars but the former would be
1297   reformatted to a single line.
1298
1299 - fixed crash on dealing with optional parentheses (#193)
1300
1301 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
1302   purposes
1303
1304 - fixed crash when dead symlinks where encountered
1305
1306 ## 18.4a4
1307
1308 - don't populate the cache on `--check` (#175)
1309
1310 ## 18.4a3
1311
1312 - added a "cache"; files already reformatted that haven't changed on disk won't be
1313   reformatted again (#109)
1314
1315 - `--check` and `--diff` are no longer mutually exclusive (#149)
1316
1317 - generalized star expression handling, including double stars; this fixes
1318   multiplication making expressions "unsafe" for trailing commas (#132)
1319
1320 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
1321
1322 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
1323
1324 - fixed comment indentation when a standalone comment closes a block (#16, #32)
1325
1326 - fixed standalone comments receiving extra empty lines if immediately preceding a
1327   class, def, or decorator (#56, #154)
1328
1329 - fixed `--diff` not showing entire path (#130)
1330
1331 - fixed parsing of complex expressions after star and double stars in function calls
1332   (#2)
1333
1334 - fixed invalid splitting on comma in lambda arguments (#133)
1335
1336 - fixed missing splits of ternary expressions (#141)
1337
1338 ## 18.4a2
1339
1340 - fixed parsing of unaligned standalone comments (#99, #112)
1341
1342 - fixed placement of dictionary unpacking inside dictionary literals (#111)
1343
1344 - Vim plugin now works on Windows, too
1345
1346 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
1347   (#120)
1348
1349 ## 18.4a1
1350
1351 - added `--quiet` (#78)
1352
1353 - added automatic parentheses management (#4)
1354
1355 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
1356
1357 - fixed reporting on `--check` with multiple files (#101, #102)
1358
1359 - fixed removing backslash escapes from raw strings (#100, #105)
1360
1361 ## 18.4a0
1362
1363 - added `--diff` (#87)
1364
1365 - add line breaks before all delimiters, except in cases like commas, to better comply
1366   with PEP 8 (#73)
1367
1368 - standardize string literals to use double quotes (almost) everywhere (#75)
1369
1370 - fixed handling of standalone comments within nested bracketed expressions; _Black_
1371   will no longer produce super long lines or put all standalone comments at the end of
1372   the expression (#22)
1373
1374 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
1375   (#80)
1376
1377 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
1378   _Black_ to not emit the rest of the file (#95)
1379
1380 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
1381   a flurry of asyncio-related exceptions
1382
1383 - only allow up to two empty lines on module level and only single empty lines within
1384   functions (#74)
1385
1386 ## 18.3a4
1387
1388 - `# fmt: off` and `# fmt: on` are implemented (#5)
1389
1390 - automatic detection of deprecated Python 2 forms of print statements and exec
1391   statements in the formatted file (#49)
1392
1393 - use proper spaces for complex expressions in default values of typed function
1394   arguments (#60)
1395
1396 - only return exit code 1 when --check is used (#50)
1397
1398 - don't remove single trailing commas from square bracket indexing (#59)
1399
1400 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
1401
1402 - omit extra space in kwarg unpacking if it's the first argument (#46)
1403
1404 - omit extra space in
1405   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1406   (#68)
1407
1408 ## 18.3a3
1409
1410 - don't remove single empty lines outside of bracketed expressions (#19)
1411
1412 - added ability to pipe formatting from stdin to stdin (#25)
1413
1414 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
1415
1416 - even better handling of numpy-style array indexing (#33, again)
1417
1418 ## 18.3a2
1419
1420 - changed positioning of binary operators to occur at beginning of lines instead of at
1421   the end, following
1422   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1423   (#21)
1424
1425 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
1426   formattings (#34, #35)
1427
1428 - remove a trailing comma if there is a single argument to a call
1429
1430 - if top level functions were separated by a comment, don't put four empty lines after
1431   the upper function
1432
1433 - fixed unstable formatting of newlines with imports
1434
1435 - fixed unintentional folding of post scriptum standalone comments into last statement
1436   if it was a simple statement (#18, #28)
1437
1438 - fixed missing space in numpy-style array indexing (#33)
1439
1440 - fixed spurious space after star-based unary expressions (#31)
1441
1442 ## 18.3a1
1443
1444 - added `--check`
1445
1446 - only put trailing commas in function signatures and calls if it's safe to do so. If
1447   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
1448   or `**kwargs` used in the signature or call. (#8)
1449
1450 - fixed invalid spacing of dots in relative imports (#6, #13)
1451
1452 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
1453
1454 - fixed spurious space in parenthesized set expressions (#7)
1455
1456 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
1457
1458 - fixed spurious space after unary operators when the operand was a complex expression
1459   (#15)
1460
1461 ## 18.3a0
1462
1463 - first published version, Happy 🍰 Day 2018!
1464
1465 - alpha quality
1466
1467 - date-versioned (see: <https://calver.org/>)