CHANGES.md

   1 ## Change Log
   2
   3 ### Unreleased
   4
   5 #### _Black_
   6
   7 - `Black` now respects `--skip-string-normalization` when normalizing multiline
   8   docstring quotes (#1637)
   9
  10 - `Black` no longer removes all empty lines between non-function code and decorators
  11   when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
  12
  13 - `Black` no longer adds an incorrect space after a parenthesized assignment expression
  14   in if/while statements (#1655)
  15
  16 - fixed a crash when PWD=/ on POSIX (#1631)
  17
  18 - fixed "I/O operation on closed file" when using --diff (#1664)
  19
  20 - Prevent coloured diff output being interleaved with multiple files (#1673)
  21
  22 - Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
  23
  24 - Added parsing support for unparenthesized tuples and yield expressions in annotated
  25   assignments (#1835)
  26
  27 - use lowercase hex strings (#1692)
  28
  29 #### _Packaging_
  30
  31 - Self-contained native _Black_ binaries are now provided for releases via GitHub
  32   Releases (#1743)
  33
  34 ### 20.8b1
  35
  36 #### _Packaging_
  37
  38 - explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
  39   older than 7.0
  40
  41 ### 20.8b0
  42
  43 #### _Black_
  44
  45 - re-implemented support for explicit trailing commas: now it works consistently within
  46   any bracket pair, including nested structures (#1288 and duplicates)
  47
  48 - `Black` now reindents docstrings when reindenting code around it (#1053)
  49
  50 - `Black` now shows colored diffs (#1266)
  51
  52 - `Black` is now packaged using 'py3' tagged wheels (#1388)
  53
  54 - `Black` now supports Python 3.8 code, e.g. star expressions in return statements
  55   (#1121)
  56
  57 - `Black` no longer normalizes capital R-string prefixes as those have a
  58   community-accepted meaning (#1244)
  59
  60 - `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
  61
  62 - `Black` now works on AWS Lambda (#1141)
  63
  64 - added `--force-exclude` argument (#1032)
  65
  66 - removed deprecated `--py36` option (#1236)
  67
  68 - fixed `--diff` output when EOF is encountered (#526)
  69
  70 - fixed `# fmt: off` handling around decorators (#560)
  71
  72 - fixed unstable formatting with some `# type: ignore` comments (#1113)
  73
  74 - fixed invalid removal on organizing brackets followed by indexing (#1575)
  75
  76 - introduced `black-primer`, a CI tool that allows us to run regression tests against
  77   existing open source users of Black (#1402)
  78
  79 - introduced property-based fuzzing to our test suite based on Hypothesis and
  80   Hypothersmith (#1566)
  81
  82 - implemented experimental and disabled by default long string rewrapping (#1132),
  83   hidden under a `--experimental-string-processing` flag while it's being worked on;
  84   this is an undocumented and unsupported feature, you lose Internet points for
  85   depending on it (#1609)
  86
  87 #### Vim plugin
  88
  89 - prefer virtualenv packages over global packages (#1383)
  90
  91 ### 19.10b0
  92
  93 - added support for PEP 572 assignment expressions (#711)
  94
  95 - added support for PEP 570 positional-only arguments (#943)
  96
  97 - added support for async generators (#593)
  98
  99 - added support for pre-splitting collections by putting an explicit trailing comma
 100   inside (#826)
 101
 102 - added `black -c` as a way to format code passed from the command line (#761)
 103
 104 - --safe now works with Python 2 code (#840)
 105
 106 - fixed grammar selection for Python 2-specific code (#765)
 107
 108 - fixed feature detection for trailing commas in function definitions and call sites
 109   (#763)
 110
 111 - `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
 112   code now behave correctly (#1005)
 113
 114 - _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
 115
 116 - _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
 117
 118 - _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
 119
 120 - _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
 121
 122 - _Black_ no longer fails on comments in from-imports (#671)
 123
 124 - _Black_ no longer fails when the file starts with a backslash (#922)
 125
 126 - _Black_ no longer merges regular comments with type comments (#1027)
 127
 128 - _Black_ no longer splits long lines that contain type comments (#997)
 129
 130 - removed unnecessary parentheses around `yield` expressions (#834)
 131
 132 - added parentheses around long tuples in unpacking assignments (#832)
 133
 134 - added parentheses around complex powers when they are prefixed by a unary operator
 135   (#646)
 136
 137 - fixed bug that led _Black_ format some code with a line length target of 1 (#762)
 138
 139 - _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
 140   (#863)
 141
 142 - if _Black_ puts parenthesis around a single expression, it moves comments to the
 143   wrapped expression instead of after the brackets (#872)
 144
 145 - `blackd` now returns the version of _Black_ in the response headers (#1013)
 146
 147 - `blackd` can now output the diff of formats on source code when the `X-Diff` header is
 148   provided (#969)
 149
 150 ### 19.3b0
 151
 152 - new option `--target-version` to control which Python versions _Black_-formatted code
 153   should target (#618)
 154
 155 - deprecated `--py36` (use `--target-version=py36` instead) (#724)
 156
 157 - _Black_ no longer normalizes numeric literals to include `_` separators (#696)
 158
 159 - long `del` statements are now split into multiple lines (#698)
 160
 161 - type comments are no longer mangled in function signatures
 162
 163 - improved performance of formatting deeply nested data structures (#509)
 164
 165 - _Black_ now properly formats multiple files in parallel on Windows (#632)
 166
 167 - _Black_ now creates cache files atomically which allows it to be used in parallel
 168   pipelines (like `xargs -P8`) (#673)
 169
 170 - _Black_ now correctly indents comments in files that were previously formatted with
 171   tabs (#262)
 172
 173 - `blackd` now supports CORS (#622)
 174
 175 ### 18.9b0
 176
 177 - numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
 178
 179   - numeric literals are normalized to include `_` separators on Python 3.6+ code
 180
 181   - added `--skip-numeric-underscore-normalization` to disable the above behavior and
 182     leave numeric underscores as they were in the input
 183
 184   - code with `_` in numeric literals is recognized as Python 3.6+
 185
 186   - most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
 187
 188   - hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
 189
 190 - added `blackd`, see [its documentation](#blackd) for more info (#349)
 191
 192 - adjacent string literals are now correctly split into multiple lines (#463)
 193
 194 - trailing comma is now added to single imports that don't fit on a line (#250)
 195
 196 - cache is now populated when `--check` is successful for a file which speeds up
 197   consecutive checks of properly formatted unmodified files (#448)
 198
 199 - whitespace at the beginning of the file is now removed (#399)
 200
 201 - fixed mangling [pweave](http://mpastell.com/pweave/) and
 202   [Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
 203
 204 - fixed unstable formatting when unpacking big tuples (#267)
 205
 206 - fixed parsing of `__future__` imports with renames (#389)
 207
 208 - fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
 209
 210 - fixed formatting of lambda expressions with default arguments (#468)
 211
 212 - fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
 213
 214 - note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
 215   be a bad idea (#415)
 216
 217 ### 18.6b4
 218
 219 - hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
 220
 221 ### 18.6b3
 222
 223 - typing stub files (`.pyi`) now have blank lines added after constants (#340)
 224
 225 - `# fmt: off` and `# fmt: on` are now much more dependable:
 226
 227   - they now work also within bracket pairs (#329)
 228
 229   - they now correctly work across function/class boundaries (#335)
 230
 231   - they now work when an indentation block starts with empty lines or misaligned
 232     comments (#334)
 233
 234 - made Click not fail on invalid environments; note that Click is right but the
 235   likelihood we'll need to access non-ASCII file paths when dealing with Python source
 236   code is low (#277)
 237
 238 - fixed improper formatting of f-strings with quotes inside interpolated expressions
 239   (#322)
 240
 241 - fixed unnecessary slowdown when long list literals where found in a file
 242
 243 - fixed unnecessary slowdown on AST nodes with very many siblings
 244
 245 - fixed cannibalizing backslashes during string normalization
 246
 247 - fixed a crash due to symbolic links pointing outside of the project directory (#338)
 248
 249 ### 18.6b2
 250
 251 - added `--config` (#65)
 252
 253 - added `-h` equivalent to `--help` (#316)
 254
 255 - fixed improper unmodified file caching when `-S` was used
 256
 257 - fixed extra space in string unpacking (#305)
 258
 259 - fixed formatting of empty triple quoted strings (#313)
 260
 261 - fixed unnecessary slowdown in comment placement calculation on lines without comments
 262
 263 ### 18.6b1
 264
 265 - hotfix: don't output human-facing information on stdout (#299)
 266
 267 - hotfix: don't output cake emoji on non-zero return code (#300)
 268
 269 ### 18.6b0
 270
 271 - added `--include` and `--exclude` (#270)
 272
 273 - added `--skip-string-normalization` (#118)
 274
 275 - added `--verbose` (#283)
 276
 277 - the header output in `--diff` now actually conforms to the unified diff spec
 278
 279 - fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
 280
 281 - fixed unnecessary parentheses when a line contained multiline strings (#232)
 282
 283 - fixed stdin handling not working correctly if an old version of Click was used (#276)
 284
 285 - _Black_ now preserves line endings when formatting a file in place (#258)
 286
 287 ### 18.5b1
 288
 289 - added `--pyi` (#249)
 290
 291 - added `--py36` (#249)
 292
 293 - Python grammar pickle caches are stored with the formatting caches, making _Black_
 294   work in environments where site-packages is not user-writable (#192)
 295
 296 - _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
 297   fields) and the first method
 298
 299 - fixed invalid code produced when standalone comments were present in a trailer that
 300   was omitted from line splitting on a large expression (#237)
 301
 302 - fixed optional parentheses being removed within `# fmt: off` sections (#224)
 303
 304 - fixed invalid code produced when stars in very long imports were incorrectly wrapped
 305   in optional parentheses (#234)
 306
 307 - fixed unstable formatting when inline comments were moved around in a trailer that was
 308   omitted from line splitting on a large expression (#238)
 309
 310 - fixed extra empty line between a class declaration and the first method if no class
 311   docstring or fields are present (#219)
 312
 313 - fixed extra empty line between a function signature and an inner function or inner
 314   class (#196)
 315
 316 ### 18.5b0
 317
 318 - call chains are now formatted according to the
 319   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
 320
 321 - data structure literals (tuples, lists, dictionaries, and sets) are now also always
 322   exploded like imports when they don't fit in a single line (#152)
 323
 324 - slices are now formatted according to PEP 8 (#178)
 325
 326 - parentheses are now also managed automatically on the right-hand side of assignments
 327   and return statements (#140)
 328
 329 - math operators now use their respective priorities for delimiting multiline
 330   expressions (#148)
 331
 332 - optional parentheses are now omitted on expressions that start or end with a bracket
 333   and only contain a single operator (#177)
 334
 335 - empty parentheses in a class definition are now removed (#145, #180)
 336
 337 - string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
 338   only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
 339   #199)
 340
 341 - typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
 342   484 (#207, #210)
 343
 344 - progress when reformatting many files is now reported incrementally
 345
 346 - fixed trailers (content with brackets) being unnecessarily exploded into their own
 347   lines after a dedented closing bracket (#119)
 348
 349 - fixed an invalid trailing comma sometimes left in imports (#185)
 350
 351 - fixed non-deterministic formatting when multiple pairs of removable parentheses were
 352   used (#183)
 353
 354 - fixed multiline strings being unnecessarily wrapped in optional parentheses in long
 355   assignments (#215)
 356
 357 - fixed not splitting long from-imports with only a single name
 358
 359 - fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
 360   This fixed non-deterministic formatting if trailing commas where used both in function
 361   signatures with stars and function calls with stars but the former would be
 362   reformatted to a single line.
 363
 364 - fixed crash on dealing with optional parentheses (#193)
 365
 366 - fixed "is", "is not", "in", and "not in" not considered operators for splitting
 367   purposes
 368
 369 - fixed crash when dead symlinks where encountered
 370
 371 ### 18.4a4
 372
 373 - don't populate the cache on `--check` (#175)
 374
 375 ### 18.4a3
 376
 377 - added a "cache"; files already reformatted that haven't changed on disk won't be
 378   reformatted again (#109)
 379
 380 - `--check` and `--diff` are no longer mutually exclusive (#149)
 381
 382 - generalized star expression handling, including double stars; this fixes
 383   multiplication making expressions "unsafe" for trailing commas (#132)
 384
 385 - _Black_ no longer enforces putting empty lines behind control flow statements (#90)
 386
 387 - _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
 388
 389 - fixed comment indentation when a standalone comment closes a block (#16, #32)
 390
 391 - fixed standalone comments receiving extra empty lines if immediately preceding a
 392   class, def, or decorator (#56, #154)
 393
 394 - fixed `--diff` not showing entire path (#130)
 395
 396 - fixed parsing of complex expressions after star and double stars in function calls
 397   (#2)
 398
 399 - fixed invalid splitting on comma in lambda arguments (#133)
 400
 401 - fixed missing splits of ternary expressions (#141)
 402
 403 ### 18.4a2
 404
 405 - fixed parsing of unaligned standalone comments (#99, #112)
 406
 407 - fixed placement of dictionary unpacking inside dictionary literals (#111)
 408
 409 - Vim plugin now works on Windows, too
 410
 411 - fixed unstable formatting when encountering unnecessarily escaped quotes in a string
 412   (#120)
 413
 414 ### 18.4a1
 415
 416 - added `--quiet` (#78)
 417
 418 - added automatic parentheses management (#4)
 419
 420 - added [pre-commit](https://pre-commit.com) integration (#103, #104)
 421
 422 - fixed reporting on `--check` with multiple files (#101, #102)
 423
 424 - fixed removing backslash escapes from raw strings (#100, #105)
 425
 426 ### 18.4a0
 427
 428 - added `--diff` (#87)
 429
 430 - add line breaks before all delimiters, except in cases like commas, to better comply
 431   with PEP 8 (#73)
 432
 433 - standardize string literals to use double quotes (almost) everywhere (#75)
 434
 435 - fixed handling of standalone comments within nested bracketed expressions; _Black_
 436   will no longer produce super long lines or put all standalone comments at the end of
 437   the expression (#22)
 438
 439 - fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
 440   (#80)
 441
 442 - fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
 443   _Black_ to not emit the rest of the file (#95)
 444
 445 - when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
 446   a flurry of asyncio-related exceptions
 447
 448 - only allow up to two empty lines on module level and only single empty lines within
 449   functions (#74)
 450
 451 ### 18.3a4
 452
 453 - `# fmt: off` and `# fmt: on` are implemented (#5)
 454
 455 - automatic detection of deprecated Python 2 forms of print statements and exec
 456   statements in the formatted file (#49)
 457
 458 - use proper spaces for complex expressions in default values of typed function
 459   arguments (#60)
 460
 461 - only return exit code 1 when --check is used (#50)
 462
 463 - don't remove single trailing commas from square bracket indexing (#59)
 464
 465 - don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
 466
 467 - omit extra space in kwarg unpacking if it's the first argument (#46)
 468
 469 - omit extra space in
 470   [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
 471   (#68)
 472
 473 ### 18.3a3
 474
 475 - don't remove single empty lines outside of bracketed expressions (#19)
 476
 477 - added ability to pipe formatting from stdin to stdin (#25)
 478
 479 - restored ability to format code with legacy usage of `async` as a name (#20, #42)
 480
 481 - even better handling of numpy-style array indexing (#33, again)
 482
 483 ### 18.3a2
 484
 485 - changed positioning of binary operators to occur at beginning of lines instead of at
 486   the end, following
 487   [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
 488   (#21)
 489
 490 - ignore empty bracket pairs while splitting. This avoids very weirdly looking
 491   formattings (#34, #35)
 492
 493 - remove a trailing comma if there is a single argument to a call
 494
 495 - if top level functions were separated by a comment, don't put four empty lines after
 496   the upper function
 497
 498 - fixed unstable formatting of newlines with imports
 499
 500 - fixed unintentional folding of post scriptum standalone comments into last statement
 501   if it was a simple statement (#18, #28)
 502
 503 - fixed missing space in numpy-style array indexing (#33)
 504
 505 - fixed spurious space after star-based unary expressions (#31)
 506
 507 ### 18.3a1
 508
 509 - added `--check`
 510
 511 - only put trailing commas in function signatures and calls if it's safe to do so. If
 512   the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
 513   or `**kwargs` used in the signature or call. (#8)
 514
 515 - fixed invalid spacing of dots in relative imports (#6, #13)
 516
 517 - fixed invalid splitting after comma on unpacked variables in for-loops (#23)
 518
 519 - fixed spurious space in parenthesized set expressions (#7)
 520
 521 - fixed spurious space after opening parentheses and in default arguments (#14, #17)
 522
 523 - fixed spurious space after unary operators when the operand was a complex expression
 524   (#15)
 525
 526 ### 18.3a0
 527
 528 - first published version, Happy 🍰 Day 2018!
 529
 530 - alpha quality
 531
 532 - date-versioned (see: https://calver.org/)