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

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