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