Skip to content

Releases: psf/black

25.9.0

19 Sep 00:27
af0ba72
Compare
Choose a tag to compare

Highlights

  • Remove support for pre-python 3.7 await/async as soft keywords/variable names
    (#4676)

Stable style

  • Fix crash while formatting a long del statement containing tuples (#4628)
  • Fix crash while formatting expressions using the walrus operator in complex with
    statements (#4630)
  • Handle # fmt: skip followed by a comment at the end of file (#4635)
  • Fix crash when a tuple appears in the as clause of a with statement (#4634)
  • Fix crash when tuple is used as a context manager inside a with statement (#4646)
  • Fix crash when formatting a \ followed by a \r followed by a comment (#4663)
  • Fix crash on a \\r\n (#4673)
  • Fix crash on await ... (where ... is a literal Ellipsis) (#4676)
  • Fix crash on parenthesized expression inside a type parameter bound (#4684)
  • Fix crash when using line ranges excluding indented single line decorated items
    (#4670)

Preview style

  • Fix a bug where one-liner functions/conditionals marked with # fmt: skip would still
    be formatted (#4552)
  • Improve multiline_string_handling with ternaries and dictionaries (#4657)
  • Fix a bug where string_processing would not split f-strings directly after
    expressions (#4680)
  • Wrap the in clause of comprehensions across lines if necessary (#4699)
  • Remove parentheses around multiple exception types in except and except* without
    as. (#4720)
  • Add \r style newlines to the potential newlines to normalize file newlines both from
    and to (#4710)

Parser

  • Rewrite tokenizer to improve performance and compliance (#4536)
  • Fix bug where certain unusual expressions (e.g., lambdas) were not accepted in type
    parameter bounds and defaults. (#4602)

Performance

  • Avoid using an extra process when running with only one worker (#4734)

Integrations

  • Fix the version check in the vim file to reject Python 3.8 (#4567)
  • Enhance GitHub Action psf/black to read Black version from an additional section in
    pyproject.toml: [project.dependency-groups] (#4606)
  • Build gallery docker image with python3-slim and reduce image size (#4686)

Documentation

  • Add FAQ entry for windows emoji not displaying (#4714)

25.1.0

29 Jan 04:15
8a737e7
Compare
Choose a tag to compare

Highlights

This release introduces the new 2025 stable style (#4558), stabilizing
the following changes:

  • Normalize casing of Unicode escape characters in strings to lowercase (#2916)
  • Fix inconsistencies in whether certain strings are detected as docstrings (#4095)
  • Consistently add trailing commas to typed function parameters (#4164)
  • Remove redundant parentheses in if guards for case blocks (#4214)
  • Add parentheses to if clauses in case blocks when the line is too long (#4269)
  • Whitespace before # fmt: skip comments is no longer normalized (#4146)
  • Fix line length computation for certain expressions that involve the power operator (#4154)
  • Check if there is a newline before the terminating quotes of a docstring (#4185)
  • Fix type annotation spacing between * and more complex type variable tuple (#4440)

The following changes were not in any previous release:

  • Remove parentheses around sole list items (#4312)
  • Generic function definitions are now formatted more elegantly: parameters are
    split over multiple lines first instead of type parameter definitions (#4553)

Stable style

  • Fix formatting cells in IPython notebooks with magic methods and starting or trailing
    empty lines (#4484)
  • Fix crash when formatting with statements containing tuple generators/unpacking
    (#4538)

Preview style

  • Fix/remove string merging changing f-string quotes on f-strings with internal quotes
    (#4498)
  • Collapse multiple empty lines after an import into one (#4489)
  • Prevent string_processing and wrap_long_dict_values_in_parens from removing
    parentheses around long dictionary values (#4377)
  • Move wrap_long_dict_values_in_parens from the unstable to preview style (#4561)

Packaging

  • Store license identifier inside the License-Expression metadata field, see
    PEP 639. (#4479)

Performance

  • Speed up the is_fstring_start function in Black's tokenizer (#4541)

Integrations

  • If using stdin with --stdin-filename set to a force excluded path, stdin won't be
    formatted. (#4539)

24.10.0

07 Oct 19:20
1b2427a
Compare
Choose a tag to compare

24.10.0

Highlights

  • Black is now officially tested with Python 3.13 and provides Python 3.13
    mypyc-compiled wheels. (#4436) (#4449)
  • Black will issue an error when used with Python 3.12.5, due to an upstream memory
    safety issue in Python 3.12.5 that can cause Black's AST safety checks to fail. Please
    use Python 3.12.6 or Python 3.12.4 instead. (#4447)
  • Black no longer supports running with Python 3.8 (#4452)

Stable style

  • Fix crashes involving comments in parenthesised return types or X | Y style unions.
    (#4453)
  • Fix skipping Jupyter cells with unknown %% magic (#4462)

Preview style

  • Fix type annotation spacing between * and more complex type variable tuple (i.e. def fn(*args: *tuple[*Ts, T]) -> None: pass) (#4440)

Caching

  • Fix bug where the cache was shared between runs with and without --unstable (#4466)

Packaging

  • Upgrade version of mypyc used to 1.12 beta (#4450) (#4449)
  • blackd now requires a newer version of aiohttp. (#4451)

Output

  • Added Python target version information on parse error (#4378)
  • Add information about Black version to internal error messages (#4457)

24.8.0

02 Aug 17:42
b965c2a
Compare
Choose a tag to compare

Stable style

  • Fix crash when # fmt: off is used before a closing parenthesis or bracket. (#4363)

Packaging

  • Packaging metadata updated: docs are explictly linked, the issue tracker is now also
    linked. This improves the PyPI listing for Black. (#4345)

Parser

  • Fix regression where Black failed to parse a multiline f-string containing another
    multiline string (#4339)
  • Fix regression where Black failed to parse an escaped single quote inside an f-string
    (#4401)
  • Fix bug with Black incorrectly parsing empty lines with a backslash (#4343)
  • Fix bugs with Black's tokenizer not handling \{ inside f-strings very well (#4422)
  • Fix incorrect line numbers in the tokenizer for certain tokens within f-strings
    (#4423)

Performance

  • Improve performance when a large directory is listed in .gitignore (#4415)

Blackd

  • Fix blackd (and all extras installs) for docker container (#4357)

24.4.2

26 Apr 00:31
3702ba2
Compare
Choose a tag to compare

This is a bugfix release to fix two regressions in the new f-string parser introduced in
24.4.1.

Parser

  • Fix regression where certain complex f-strings failed to parse (#4332)

Performance

  • Fix bad performance on certain complex string literals (#4331)

24.4.1

24 Apr 15:17
e7fb048
Compare
Choose a tag to compare

24.4.1

Highlights

  • Add support for the new Python 3.12 f-string syntax introduced by PEP 701 (#3822)

Stable style

  • Fix crash involving indented dummy functions containing newlines (#4318)

Parser

  • Add support for type parameter defaults, a new syntactic feature added to Python 3.13
    by PEP 696 (#4327)

Integrations

  • Github Action now works even when git archive is skipped (#4313)

24.4.0

12 Apr 20:13
8fe6270
Compare
Choose a tag to compare

Stable style

  • Fix unwanted crashes caused by AST equivalency check (#4290)

Preview style

  • if guards in case blocks are now wrapped in parentheses when the line is too long.
    (#4269)
  • Stop moving multiline strings to a new line unless inside brackets (#4289)

Integrations

  • Add a new option use_pyproject to the GitHub Action psf/black. This will read the
    Black version from pyproject.toml. (#4294)

24.3.0

15 Mar 19:35
552baf8
Compare
Choose a tag to compare

Highlights

This release is a milestone: it fixes Black's first CVE security vulnerability. If you
run Black on untrusted input, or if you habitually put thousands of leading tab
characters in your docstrings, you are strongly encouraged to upgrade immediately to fix
CVE-2024-21503.

This release also fixes a bug in Black's AST safety check that allowed Black to make
incorrect changes to certain f-strings that are valid in Python 3.12 and higher.

Stable style

  • Don't move comments along with delimiters, which could cause crashes (#4248)
  • Strengthen AST safety check to catch more unsafe changes to strings. Previous versions
    of Black would incorrectly format the contents of certain unusual f-strings containing
    nested strings with the same quote type. Now, Black will crash on such strings until
    support for the new f-string syntax is implemented. (#4270)
  • Fix a bug where line-ranges exceeding the last code line would not work as expected
    (#4273)

Performance

  • Fix catastrophic performance on docstrings that contain large numbers of leading tab
    characters. This fixes
    CVE-2024-21503.
    (#4278)

Documentation

  • Note what happens when --check is used with --quiet (#4236)

24.2.0

12 Feb 20:20
6fdf8a4
Compare
Choose a tag to compare

24.2.0

Stable style

  • Fixed a bug where comments where mistakenly removed along with redundant parentheses
    (#4218)

Preview style

  • Move the hug_parens_with_braces_and_square_brackets feature to the unstable style
    due to an outstanding crash and proposed formatting tweaks (#4198)
  • Fixed a bug where base expressions caused inconsistent formatting of ** in tenary
    expression (#4154)
  • Checking for newline before adding one on docstring that is almost at the line limit
    (#4185)
  • Remove redundant parentheses in case statement if guards (#4214).

Configuration

  • Fix issue where Black would ignore input files in the presence of symlinks (#4222)
  • Black now ignores pyproject.toml that is missing a tool.black section when
    discovering project root and configuration. Since Black continues to use version
    control as an indicator of project root, this is expected to primarily change behavior
    for users in a monorepo setup (desirably). If you wish to preserve previous behavior,
    simply add an empty [tool.black] to the previously discovered pyproject.toml
    (#4204)

Output

  • Black will swallow any SyntaxWarnings or DeprecationWarnings produced by the ast
    module when performing equivalence checks (#4189)

Integrations

  • Add a JSONSchema and provide a validate-pyproject entry-point (#4181)

24.1.1

28 Jan 05:28
e026c93
Compare
Choose a tag to compare

24.1.1

Bugfix release to fix a bug that made Black unusable on certain file systems
with strict limits on path length.

Preview style

  • Consistently add trailing comma on typed parameters (#4164)

Configuration

  • Shorten the length of the name of the cache file to fix crashes on file systems that
    do not support long paths (#4176)