CHANGES.md

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