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

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