
I know I know, this is the second reorganization of the docs. I'm not saying the first one was bad or anything... but.. actually wait nah, *it was bad*. Anyway, welcome to probably my biggest commit. The main thing with this reorganization was to introduce nesting to the documentation! Having all of the docs be part of the main TOC was becoming too much. There wasn't much room to expand either. Finally, the old setup required a documentation generation step which was just annoying. The goals of this reorganization was to: 1. Significantly restructure the docs to be discoverable and understandable 2. Add room for further docs (like guides or contributing docs) 3. Get rid of the doc generation step (it was slow and frustrating) 4. Unblock other improvements and also just make contributing to the docs easier Another important change with this is that we are no longer using GitHub as a documentation host. While GitHub does support Markdown based docs actually pretty well, the lack of any features outside of GitHub Flavoured Markdown is quite limiting. ReadTheDocs is just much better suited for documentation. You can use reST, MyST, CommonMark, and all of their great features like toctrees and admonitions. Related to this change, we're adopting MyST as our flavour of Markdown. MyST introduces neat syntax extensions to Markdown that pretty much gives us the best of both worlds. The ease of use and simplicity of MD and the flexibility and expressiveness of reST. Also recommonmark is deprecated now. This switch was possible now we don't use GH as a docs host. MyST docs have to be built to really be usable / pretty, so the MD docs are going to look pretty bad on GH, but that's fine now! Another thing that should be noted is that the README has been stripped of most content since it was confusing. Users would read the README and then think some feature or bug was fixed already and is available in a release when in reality, they weren't. They were reading effectively the latest docs without knowing. See also: https://github.com/psf/black/issues/1759 FYI: CommonMark is a rationalized version of Markdown syntax -- Commit history before merge: * Switch to MyST-Parser + doc config cleanup recommonmark is being deprecated in favour of MyST-Parser. This change is welcomed, especially since MyST-Parser has syntax extensions for the Commonmark standard. Effectively we get to use a language that's powerful and expressive like ReST, but get the simplicity of Markdown. The rest of this effort will be using some MyST features. This reorganization efforts aims to remove as much duplication as possible. The regeneration step once needed is gone, significantly simplifing our Sphinx documentation configuration. * Tell pipenv we replaced recommonmark for MyST-Parser Also update `docs/requirements.txt` * Delete all auto generated content * Switch prettier for mdformat (plus a few plugins) **FYI: THIS WAS EFFECTIVELY REVERTED, SEE THIRD TO LAST COMMIT** prettier doesn't support MyST's syntax extensions which are going to be used in this reorganization effort so we have to switch formatter. Unfortanately mdformat's style is different from prettier's so time to reformat the whole repo too. We're excluding .github/ISSUE_TEMPLATE because I have no idea whether its changes are safe, so let's play it safe. * Fix the heading levels in CHANGES.md + a link MyST-Parser / sphinx's linkcheck complains otherwise. * Move reference docs into a docs/contributing dir They're for contributors of Black anyway. Also added a note in the summary document warning about the lack of attention the reference has been dealing with. * Rewrite and setup the new landing page + main TOC - add some more detail about Black's beta status - add licensing info - add external links in the main TOC for GitHub, PyPI, and IRC - prepare main TOC for new structure * Break out AUTHORS into its own file Not only was the AUTHORS list quite long, this makes it easy to include it in the Sphinx docs with just a simple symlink. * Add license to docs via a simple include Yes the document is orphaned but it is linked to in the landing page (docs/index.rst). * Add "The Black Code Style" section This mostly was a restructuring commit, there has been a few updates but not many. The main goal was to split "current style" and "planned changes to the style that haven't happened yet" to avoid confusion. * Add "Getting Started" page This is basically a quick start + even more. This commit is certainly one of most creatively involved in this effort. * Add "Usage and Configuration" section This commit was as much restructuring as new content. Instead of being in one giant file, usage and configuration documentation can expand without bloating a single file. * Add "Integrations" section Just a restructuring commit ... * Add "Guides" section This is a promising area of documentation that could easily grow in the future, let's prepare for that! * Add "Contributing" section This is also another area that I expect to see significant growth in. Contributors to Black could definitely do with some more specific docs that clears up certain parts of our slightly confusing project (it's only confusing because we're getting big and old!). * Rewrite CONTRIBUTING.md to just point to RTD * Rewrite README.md to delegate most info to RTD * Address feedback + a lot of corrections and edits I know I said I wanted to do these after landing this but given there's going to be no time between this being merged and a release getting pushed, I want these changes to make it in. - drop the number flag for mdformat - to reduce diffs, see also: https://mdformat.readthedocs.io/en/stable/users/style.html#ordered-lists - the GH issue templates should be safe by mdformat, so get rid of the exclude - clarify our configuration position - i.e. stop claiming we don't have many options, instead say we want as little formatting knobs as possible - lots and lots of punctuation, spelling, and grammar corrections (thanks Jelle!) - use RTD as the source for the CHANGELOG too - visual style cleanups - add docs about our .gitignore behaviour - expand GHA Action docs - clarify we want the PR number in the CHANGELOG entry - claify Black's behaviour for with statements post Python 3.9 - italicize a bunch of "Black"s Thank you goes to Jelle, Taneli (hukkinj1 on GH), Felix (felix-hilden on GH), and Wouter (wbolster on GH) for the feedback! * Merge remote-tracking branch 'upstream/master' into reorganize-docs-v2 merge conflicts suck, although these ones weren't too bad. * Add changelog entry + fix merge conflict resolution error I consider this important enough to be worthy of a changelog entry :) * Merge branch 'master' into reorganize-docs-v2 Co-authored-by: Łukasz Langa <lukasz@langa.pl> * Actually let's continue using prettier Prettier works fine for all of the default MyST syntax so let's not rock the boat as much. Dropping the mdformat commit was merge-conflict filled so here's additional commit instead. * Address Cooper's, Taneli's, and Jelle's feedback Lots of wording improvements by Cooper. Taneli suggested to disable the enabled by default MyST syntax not supported by Prettier and I agreed. And Jelle found one more spelling error! * More minor fixes
627 lines
20 KiB
Markdown
627 lines
20 KiB
Markdown
# Change Log
|
|
|
|
## Unreleased
|
|
|
|
### _Black_
|
|
|
|
- Refactor `src/black/__init__.py` into many files (#2206)
|
|
|
|
### Documentation
|
|
|
|
- Sigificantly reorganized the documentation to make much more sense. Check them out by
|
|
heading over to [the stable docs on RTD](https://black.readthedocs.io/en/stable/).
|
|
(#2174)
|
|
|
|
## 21.5b0
|
|
|
|
### _Black_
|
|
|
|
- Set `--pyi` mode if `--stdin-filename` ends in `.pyi` (#2169)
|
|
- Stop detecting target version as Python 3.9+ with pre-PEP-614 decorators that are
|
|
being called but with no arguments (#2182)
|
|
|
|
### _Black-Primer_
|
|
|
|
- Add `--no-diff` to black-primer to suppress formatting changes (#2187)
|
|
|
|
## 21.4b2
|
|
|
|
### _Black_
|
|
|
|
- Fix crash if the user configuration directory is inaccessible. (#2158)
|
|
|
|
- Clarify
|
|
[circumstances](https://github.com/psf/black/blob/master/docs/the_black_code_style.md#pragmatism)
|
|
in which _Black_ may change the AST (#2159)
|
|
|
|
- Allow `.gitignore` rules to be overridden by specifying `exclude` in `pyproject.toml`
|
|
or on the command line. (#2170)
|
|
|
|
### _Packaging_
|
|
|
|
- Install `primer.json` (used by `black-primer` by default) with black. (#2154)
|
|
|
|
## 21.4b1
|
|
|
|
### _Black_
|
|
|
|
- Fix crash on docstrings ending with "\\ ". (#2142)
|
|
|
|
- Fix crash when atypical whitespace is cleaned out of dostrings (#2120)
|
|
|
|
- Reflect the `--skip-magic-trailing-comma` and `--experimental-string-processing` flags
|
|
in the name of the cache file. Without this fix, changes in these flags would not take
|
|
effect if the cache had already been populated. (#2131)
|
|
|
|
- Don't remove necessary parentheses from assignment expression containing assert /
|
|
return statements. (#2143)
|
|
|
|
### _Packaging_
|
|
|
|
- Bump pathspec to >= 0.8.1 to solve invalid .gitignore exclusion handling
|
|
|
|
## 21.4b0
|
|
|
|
### _Black_
|
|
|
|
- Fixed a rare but annoying formatting instability created by the combination of
|
|
optional trailing commas inserted by `Black` and optional parentheses looking at
|
|
pre-existing "magic" trailing commas. This fixes issue #1629 and all of its many many
|
|
duplicates. (#2126)
|
|
|
|
- `Black` now processes one-line docstrings by stripping leading and trailing spaces,
|
|
and adding a padding space when needed to break up """". (#1740)
|
|
|
|
- `Black` now cleans up leading non-breaking spaces in comments (#2092)
|
|
|
|
- `Black` now respects `--skip-string-normalization` when normalizing multiline
|
|
docstring quotes (#1637)
|
|
|
|
- `Black` no longer removes all empty lines between non-function code and decorators
|
|
when formatting typing stubs. Now `Black` enforces a single empty line. (#1646)
|
|
|
|
- `Black` no longer adds an incorrect space after a parenthesized assignment expression
|
|
in if/while statements (#1655)
|
|
|
|
- Added `--skip-magic-trailing-comma` / `-C` to avoid using trailing commas as a reason
|
|
to split lines (#1824)
|
|
|
|
- fixed a crash when PWD=/ on POSIX (#1631)
|
|
|
|
- fixed "I/O operation on closed file" when using --diff (#1664)
|
|
|
|
- Prevent coloured diff output being interleaved with multiple files (#1673)
|
|
|
|
- Added support for PEP 614 relaxed decorator syntax on python 3.9 (#1711)
|
|
|
|
- Added parsing support for unparenthesized tuples and yield expressions in annotated
|
|
assignments (#1835)
|
|
|
|
- added `--extend-exclude` argument (PR #2005)
|
|
|
|
- speed up caching by avoiding pathlib (#1950)
|
|
|
|
- `--diff` correctly indicates when a file doesn't end in a newline (#1662)
|
|
|
|
- Added `--stdin-filename` argument to allow stdin to respect `--force-exclude` rules
|
|
(#1780)
|
|
|
|
- Lines ending with `fmt: skip` will now be not formatted (#1800)
|
|
|
|
- PR #2053: Black no longer relies on typed-ast for Python 3.8 and higher
|
|
|
|
- PR #2053: Python 2 support is now optional, install with
|
|
`python3 -m pip install black[python2]` to maintain support.
|
|
|
|
- Exclude `venv` directory by default (#1683)
|
|
|
|
- Fixed "Black produced code that is not equivalent to the source" when formatting
|
|
Python 2 docstrings (#2037)
|
|
|
|
### _Packaging_
|
|
|
|
- Self-contained native _Black_ binaries are now provided for releases via GitHub
|
|
Releases (#1743)
|
|
|
|
## 20.8b1
|
|
|
|
### _Packaging_
|
|
|
|
- explicitly depend on Click 7.1.2 or newer as `Black` no longer works with versions
|
|
older than 7.0
|
|
|
|
## 20.8b0
|
|
|
|
### _Black_
|
|
|
|
- re-implemented support for explicit trailing commas: now it works consistently within
|
|
any bracket pair, including nested structures (#1288 and duplicates)
|
|
|
|
- `Black` now reindents docstrings when reindenting code around it (#1053)
|
|
|
|
- `Black` now shows colored diffs (#1266)
|
|
|
|
- `Black` is now packaged using 'py3' tagged wheels (#1388)
|
|
|
|
- `Black` now supports Python 3.8 code, e.g. star expressions in return statements
|
|
(#1121)
|
|
|
|
- `Black` no longer normalizes capital R-string prefixes as those have a
|
|
community-accepted meaning (#1244)
|
|
|
|
- `Black` now uses exit code 2 when specified configuration file doesn't exit (#1361)
|
|
|
|
- `Black` now works on AWS Lambda (#1141)
|
|
|
|
- added `--force-exclude` argument (#1032)
|
|
|
|
- removed deprecated `--py36` option (#1236)
|
|
|
|
- fixed `--diff` output when EOF is encountered (#526)
|
|
|
|
- fixed `# fmt: off` handling around decorators (#560)
|
|
|
|
- fixed unstable formatting with some `# type: ignore` comments (#1113)
|
|
|
|
- fixed invalid removal on organizing brackets followed by indexing (#1575)
|
|
|
|
- introduced `black-primer`, a CI tool that allows us to run regression tests against
|
|
existing open source users of Black (#1402)
|
|
|
|
- introduced property-based fuzzing to our test suite based on Hypothesis and
|
|
Hypothersmith (#1566)
|
|
|
|
- implemented experimental and disabled by default long string rewrapping (#1132),
|
|
hidden under a `--experimental-string-processing` flag while it's being worked on;
|
|
this is an undocumented and unsupported feature, you lose Internet points for
|
|
depending on it (#1609)
|
|
|
|
### Vim plugin
|
|
|
|
- prefer virtualenv packages over global packages (#1383)
|
|
|
|
## 19.10b0
|
|
|
|
- added support for PEP 572 assignment expressions (#711)
|
|
|
|
- added support for PEP 570 positional-only arguments (#943)
|
|
|
|
- added support for async generators (#593)
|
|
|
|
- added support for pre-splitting collections by putting an explicit trailing comma
|
|
inside (#826)
|
|
|
|
- added `black -c` as a way to format code passed from the command line (#761)
|
|
|
|
- --safe now works with Python 2 code (#840)
|
|
|
|
- fixed grammar selection for Python 2-specific code (#765)
|
|
|
|
- fixed feature detection for trailing commas in function definitions and call sites
|
|
(#763)
|
|
|
|
- `# fmt: off`/`# fmt: on` comment pairs placed multiple times within the same block of
|
|
code now behave correctly (#1005)
|
|
|
|
- _Black_ no longer crashes on Windows machines with more than 61 cores (#838)
|
|
|
|
- _Black_ no longer crashes on standalone comments prepended with a backslash (#767)
|
|
|
|
- _Black_ no longer crashes on `from` ... `import` blocks with comments (#829)
|
|
|
|
- _Black_ no longer crashes on Python 3.7 on some platform configurations (#494)
|
|
|
|
- _Black_ no longer fails on comments in from-imports (#671)
|
|
|
|
- _Black_ no longer fails when the file starts with a backslash (#922)
|
|
|
|
- _Black_ no longer merges regular comments with type comments (#1027)
|
|
|
|
- _Black_ no longer splits long lines that contain type comments (#997)
|
|
|
|
- removed unnecessary parentheses around `yield` expressions (#834)
|
|
|
|
- added parentheses around long tuples in unpacking assignments (#832)
|
|
|
|
- added parentheses around complex powers when they are prefixed by a unary operator
|
|
(#646)
|
|
|
|
- fixed bug that led _Black_ format some code with a line length target of 1 (#762)
|
|
|
|
- _Black_ no longer introduces quotes in f-string subexpressions on string boundaries
|
|
(#863)
|
|
|
|
- if _Black_ puts parenthesis around a single expression, it moves comments to the
|
|
wrapped expression instead of after the brackets (#872)
|
|
|
|
- `blackd` now returns the version of _Black_ in the response headers (#1013)
|
|
|
|
- `blackd` can now output the diff of formats on source code when the `X-Diff` header is
|
|
provided (#969)
|
|
|
|
## 19.3b0
|
|
|
|
- new option `--target-version` to control which Python versions _Black_-formatted code
|
|
should target (#618)
|
|
|
|
- deprecated `--py36` (use `--target-version=py36` instead) (#724)
|
|
|
|
- _Black_ no longer normalizes numeric literals to include `_` separators (#696)
|
|
|
|
- long `del` statements are now split into multiple lines (#698)
|
|
|
|
- type comments are no longer mangled in function signatures
|
|
|
|
- improved performance of formatting deeply nested data structures (#509)
|
|
|
|
- _Black_ now properly formats multiple files in parallel on Windows (#632)
|
|
|
|
- _Black_ now creates cache files atomically which allows it to be used in parallel
|
|
pipelines (like `xargs -P8`) (#673)
|
|
|
|
- _Black_ now correctly indents comments in files that were previously formatted with
|
|
tabs (#262)
|
|
|
|
- `blackd` now supports CORS (#622)
|
|
|
|
## 18.9b0
|
|
|
|
- numeric literals are now formatted by _Black_ (#452, #461, #464, #469):
|
|
|
|
- numeric literals are normalized to include `_` separators on Python 3.6+ code
|
|
|
|
- added `--skip-numeric-underscore-normalization` to disable the above behavior and
|
|
leave numeric underscores as they were in the input
|
|
|
|
- code with `_` in numeric literals is recognized as Python 3.6+
|
|
|
|
- most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
|
|
|
|
- hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
|
|
|
|
- added `blackd`, see
|
|
[its documentation](https://github.com/psf/black/blob/18.9b0/README.md#blackd) for
|
|
more info (#349)
|
|
|
|
- adjacent string literals are now correctly split into multiple lines (#463)
|
|
|
|
- trailing comma is now added to single imports that don't fit on a line (#250)
|
|
|
|
- cache is now populated when `--check` is successful for a file which speeds up
|
|
consecutive checks of properly formatted unmodified files (#448)
|
|
|
|
- whitespace at the beginning of the file is now removed (#399)
|
|
|
|
- fixed mangling [pweave](http://mpastell.com/pweave/) and
|
|
[Spyder IDE](https://www.spyder-ide.org/) special comments (#532)
|
|
|
|
- fixed unstable formatting when unpacking big tuples (#267)
|
|
|
|
- fixed parsing of `__future__` imports with renames (#389)
|
|
|
|
- fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
|
|
|
|
- fixed formatting of lambda expressions with default arguments (#468)
|
|
|
|
- fixed `async for` statements: _Black_ no longer breaks them into separate lines (#372)
|
|
|
|
- note: the Vim plugin stopped registering `,=` as a default chord as it turned out to
|
|
be a bad idea (#415)
|
|
|
|
## 18.6b4
|
|
|
|
- hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
|
|
|
|
## 18.6b3
|
|
|
|
- typing stub files (`.pyi`) now have blank lines added after constants (#340)
|
|
|
|
- `# fmt: off` and `# fmt: on` are now much more dependable:
|
|
|
|
- they now work also within bracket pairs (#329)
|
|
|
|
- they now correctly work across function/class boundaries (#335)
|
|
|
|
- they now work when an indentation block starts with empty lines or misaligned
|
|
comments (#334)
|
|
|
|
- made Click not fail on invalid environments; note that Click is right but the
|
|
likelihood we'll need to access non-ASCII file paths when dealing with Python source
|
|
code is low (#277)
|
|
|
|
- fixed improper formatting of f-strings with quotes inside interpolated expressions
|
|
(#322)
|
|
|
|
- fixed unnecessary slowdown when long list literals where found in a file
|
|
|
|
- fixed unnecessary slowdown on AST nodes with very many siblings
|
|
|
|
- fixed cannibalizing backslashes during string normalization
|
|
|
|
- fixed a crash due to symbolic links pointing outside of the project directory (#338)
|
|
|
|
## 18.6b2
|
|
|
|
- added `--config` (#65)
|
|
|
|
- added `-h` equivalent to `--help` (#316)
|
|
|
|
- fixed improper unmodified file caching when `-S` was used
|
|
|
|
- fixed extra space in string unpacking (#305)
|
|
|
|
- fixed formatting of empty triple quoted strings (#313)
|
|
|
|
- fixed unnecessary slowdown in comment placement calculation on lines without comments
|
|
|
|
## 18.6b1
|
|
|
|
- hotfix: don't output human-facing information on stdout (#299)
|
|
|
|
- hotfix: don't output cake emoji on non-zero return code (#300)
|
|
|
|
## 18.6b0
|
|
|
|
- added `--include` and `--exclude` (#270)
|
|
|
|
- added `--skip-string-normalization` (#118)
|
|
|
|
- added `--verbose` (#283)
|
|
|
|
- the header output in `--diff` now actually conforms to the unified diff spec
|
|
|
|
- fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
|
|
|
|
- fixed unnecessary parentheses when a line contained multiline strings (#232)
|
|
|
|
- fixed stdin handling not working correctly if an old version of Click was used (#276)
|
|
|
|
- _Black_ now preserves line endings when formatting a file in place (#258)
|
|
|
|
## 18.5b1
|
|
|
|
- added `--pyi` (#249)
|
|
|
|
- added `--py36` (#249)
|
|
|
|
- Python grammar pickle caches are stored with the formatting caches, making _Black_
|
|
work in environments where site-packages is not user-writable (#192)
|
|
|
|
- _Black_ now enforces a PEP 257 empty line after a class-level docstring (and/or
|
|
fields) and the first method
|
|
|
|
- fixed invalid code produced when standalone comments were present in a trailer that
|
|
was omitted from line splitting on a large expression (#237)
|
|
|
|
- fixed optional parentheses being removed within `# fmt: off` sections (#224)
|
|
|
|
- fixed invalid code produced when stars in very long imports were incorrectly wrapped
|
|
in optional parentheses (#234)
|
|
|
|
- fixed unstable formatting when inline comments were moved around in a trailer that was
|
|
omitted from line splitting on a large expression (#238)
|
|
|
|
- fixed extra empty line between a class declaration and the first method if no class
|
|
docstring or fields are present (#219)
|
|
|
|
- fixed extra empty line between a function signature and an inner function or inner
|
|
class (#196)
|
|
|
|
## 18.5b0
|
|
|
|
- call chains are now formatted according to the
|
|
[fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface) style (#67)
|
|
|
|
- data structure literals (tuples, lists, dictionaries, and sets) are now also always
|
|
exploded like imports when they don't fit in a single line (#152)
|
|
|
|
- slices are now formatted according to PEP 8 (#178)
|
|
|
|
- parentheses are now also managed automatically on the right-hand side of assignments
|
|
and return statements (#140)
|
|
|
|
- math operators now use their respective priorities for delimiting multiline
|
|
expressions (#148)
|
|
|
|
- optional parentheses are now omitted on expressions that start or end with a bracket
|
|
and only contain a single operator (#177)
|
|
|
|
- empty parentheses in a class definition are now removed (#145, #180)
|
|
|
|
- string prefixes are now standardized to lowercase and `u` is removed on Python 3.6+
|
|
only code and Python 2.7+ code with the `unicode_literals` future import (#188, #198,
|
|
#199)
|
|
|
|
- typing stub files (`.pyi`) are now formatted in a style that is consistent with PEP
|
|
484 (#207, #210)
|
|
|
|
- progress when reformatting many files is now reported incrementally
|
|
|
|
- fixed trailers (content with brackets) being unnecessarily exploded into their own
|
|
lines after a dedented closing bracket (#119)
|
|
|
|
- fixed an invalid trailing comma sometimes left in imports (#185)
|
|
|
|
- fixed non-deterministic formatting when multiple pairs of removable parentheses were
|
|
used (#183)
|
|
|
|
- fixed multiline strings being unnecessarily wrapped in optional parentheses in long
|
|
assignments (#215)
|
|
|
|
- fixed not splitting long from-imports with only a single name
|
|
|
|
- fixed Python 3.6+ file discovery by also looking at function calls with unpacking.
|
|
This fixed non-deterministic formatting if trailing commas where used both in function
|
|
signatures with stars and function calls with stars but the former would be
|
|
reformatted to a single line.
|
|
|
|
- fixed crash on dealing with optional parentheses (#193)
|
|
|
|
- fixed "is", "is not", "in", and "not in" not considered operators for splitting
|
|
purposes
|
|
|
|
- fixed crash when dead symlinks where encountered
|
|
|
|
## 18.4a4
|
|
|
|
- don't populate the cache on `--check` (#175)
|
|
|
|
## 18.4a3
|
|
|
|
- added a "cache"; files already reformatted that haven't changed on disk won't be
|
|
reformatted again (#109)
|
|
|
|
- `--check` and `--diff` are no longer mutually exclusive (#149)
|
|
|
|
- generalized star expression handling, including double stars; this fixes
|
|
multiplication making expressions "unsafe" for trailing commas (#132)
|
|
|
|
- _Black_ no longer enforces putting empty lines behind control flow statements (#90)
|
|
|
|
- _Black_ now splits imports like "Mode 3 + trailing comma" of isort (#127)
|
|
|
|
- fixed comment indentation when a standalone comment closes a block (#16, #32)
|
|
|
|
- fixed standalone comments receiving extra empty lines if immediately preceding a
|
|
class, def, or decorator (#56, #154)
|
|
|
|
- fixed `--diff` not showing entire path (#130)
|
|
|
|
- fixed parsing of complex expressions after star and double stars in function calls
|
|
(#2)
|
|
|
|
- fixed invalid splitting on comma in lambda arguments (#133)
|
|
|
|
- fixed missing splits of ternary expressions (#141)
|
|
|
|
## 18.4a2
|
|
|
|
- fixed parsing of unaligned standalone comments (#99, #112)
|
|
|
|
- fixed placement of dictionary unpacking inside dictionary literals (#111)
|
|
|
|
- Vim plugin now works on Windows, too
|
|
|
|
- fixed unstable formatting when encountering unnecessarily escaped quotes in a string
|
|
(#120)
|
|
|
|
## 18.4a1
|
|
|
|
- added `--quiet` (#78)
|
|
|
|
- added automatic parentheses management (#4)
|
|
|
|
- added [pre-commit](https://pre-commit.com) integration (#103, #104)
|
|
|
|
- fixed reporting on `--check` with multiple files (#101, #102)
|
|
|
|
- fixed removing backslash escapes from raw strings (#100, #105)
|
|
|
|
## 18.4a0
|
|
|
|
- added `--diff` (#87)
|
|
|
|
- add line breaks before all delimiters, except in cases like commas, to better comply
|
|
with PEP 8 (#73)
|
|
|
|
- standardize string literals to use double quotes (almost) everywhere (#75)
|
|
|
|
- fixed handling of standalone comments within nested bracketed expressions; _Black_
|
|
will no longer produce super long lines or put all standalone comments at the end of
|
|
the expression (#22)
|
|
|
|
- fixed 18.3a4 regression: don't crash and burn on empty lines with trailing whitespace
|
|
(#80)
|
|
|
|
- fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment would cause
|
|
_Black_ to not emit the rest of the file (#95)
|
|
|
|
- when CTRL+C is pressed while formatting many files, _Black_ no longer freaks out with
|
|
a flurry of asyncio-related exceptions
|
|
|
|
- only allow up to two empty lines on module level and only single empty lines within
|
|
functions (#74)
|
|
|
|
## 18.3a4
|
|
|
|
- `# fmt: off` and `# fmt: on` are implemented (#5)
|
|
|
|
- automatic detection of deprecated Python 2 forms of print statements and exec
|
|
statements in the formatted file (#49)
|
|
|
|
- use proper spaces for complex expressions in default values of typed function
|
|
arguments (#60)
|
|
|
|
- only return exit code 1 when --check is used (#50)
|
|
|
|
- don't remove single trailing commas from square bracket indexing (#59)
|
|
|
|
- don't omit whitespace if the previous factor leaf wasn't a math operator (#55)
|
|
|
|
- omit extra space in kwarg unpacking if it's the first argument (#46)
|
|
|
|
- omit extra space in
|
|
[Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
|
|
(#68)
|
|
|
|
## 18.3a3
|
|
|
|
- don't remove single empty lines outside of bracketed expressions (#19)
|
|
|
|
- added ability to pipe formatting from stdin to stdin (#25)
|
|
|
|
- restored ability to format code with legacy usage of `async` as a name (#20, #42)
|
|
|
|
- even better handling of numpy-style array indexing (#33, again)
|
|
|
|
## 18.3a2
|
|
|
|
- changed positioning of binary operators to occur at beginning of lines instead of at
|
|
the end, following
|
|
[a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
|
|
(#21)
|
|
|
|
- ignore empty bracket pairs while splitting. This avoids very weirdly looking
|
|
formattings (#34, #35)
|
|
|
|
- remove a trailing comma if there is a single argument to a call
|
|
|
|
- if top level functions were separated by a comment, don't put four empty lines after
|
|
the upper function
|
|
|
|
- fixed unstable formatting of newlines with imports
|
|
|
|
- fixed unintentional folding of post scriptum standalone comments into last statement
|
|
if it was a simple statement (#18, #28)
|
|
|
|
- fixed missing space in numpy-style array indexing (#33)
|
|
|
|
- fixed spurious space after star-based unary expressions (#31)
|
|
|
|
## 18.3a1
|
|
|
|
- added `--check`
|
|
|
|
- only put trailing commas in function signatures and calls if it's safe to do so. If
|
|
the file is Python 3.6+ it's always safe, otherwise only safe if there are no `*args`
|
|
or `**kwargs` used in the signature or call. (#8)
|
|
|
|
- fixed invalid spacing of dots in relative imports (#6, #13)
|
|
|
|
- fixed invalid splitting after comma on unpacked variables in for-loops (#23)
|
|
|
|
- fixed spurious space in parenthesized set expressions (#7)
|
|
|
|
- fixed spurious space after opening parentheses and in default arguments (#14, #17)
|
|
|
|
- fixed spurious space after unary operators when the operand was a complex expression
|
|
(#15)
|
|
|
|
## 18.3a0
|
|
|
|
- first published version, Happy 🍰 Day 2018!
|
|
|
|
- alpha quality
|
|
|
|
- date-versioned (see: <https://calver.org/>)
|