]> git.madduck.net Git - etc/vim.git/blob - .vim/bundle/black/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:

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