docs/change_log.md

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