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

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