X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/ecb3d8c472a369bdf04ec22adad3ef4793183bc1..9e15cacc6708a7b0dd4d86c943b591bb66c28e29:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 8a70883..61cb88a 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@

Build Status -Documentation Status +Documentation Status Coverage Status -License: MIT -PyPI +License: MIT +PyPI Code style: black

@@ -29,13 +29,13 @@ possible. --- *Contents:* **[Installation and usage](#installation-and-usage)** | -**[The *Black* code style](#the-black-code-style)** | +**[Code style](#the-black-code-style)** | +**[pyproject.toml](#pyprojecttoml)** | **[Editor integration](#editor-integration)** | **[Version control integration](#version-control-integration)** | **[Ignoring unmodified files](#ignoring-unmodified-files)** | **[Testimonials](#testimonials)** | **[Show your style](#show-your-style)** | -**[License](#license)** | **[Contributing](#contributing-to-black)** | **[Change Log](#change-log)** | **[Authors](#authors)** @@ -60,7 +60,7 @@ black {source_file_or_directory} ### Command line options -Black doesn't provide many options. You can list them by running +*Black* doesn't provide many options. You can list them by running `black --help`: ```text @@ -99,7 +99,11 @@ Options: -q, --quiet Don't emit non-error messages to stderr. Errors are still emitted, silence those with 2>/dev/null. + -v, --verbose Also emit messages to stderr about files + that were not changed or were ignored due to + --exclude=. --version Show the version and exit. + --config PATH Read configuration from PATH. --help Show this message and exit. ``` @@ -484,6 +488,98 @@ a future version of the formatter: * use `float` instead of `Union[int, float]`. +## pyproject.toml + +*Black* is able to read project-specific default values for its +command line options from a `pyproject.toml` file. This is +especially useful for specifying custom `--include` and `--exclude` +patterns for your project. + +**Pro-tip**: If you're asking yourself "Do I need to configure anything?" +the answer is "No". *Black* is all about sensible defaults. + + +### What on Earth is a `pyproject.toml` file? + +[PEP 518](https://www.python.org/dev/peps/pep-0518/) defines +`pyproject.toml` as a configuration file to store build system +requirements for Python projects. With the help of tools +like [Poetry](https://poetry.eustace.io/) or +[Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the +need for `setup.py` and `setup.cfg` files. + + +### Where *Black* looks for the file + +By default *Black* looks for `pyproject.toml` starting from the common +base directory of all files and directories passed on the command line. +If it's not there, it looks in parent directories. It stops looking +when it finds the file, or a `.git` directory, or a `.hg` directory, +or the root of the file system, whichever comes first. + +If you're formatting standard input, *Black* will look for configuration +starting from the current working directory. + +You can also explicitly specify the path to a particular file that you +want with `--config`. In this situation *Black* will not look for any +other file. + +If you're running with `--verbose`, you will see a blue message if +a file was found and used. + + +### Configuration format + +As the file extension suggests, `pyproject.toml` is a [TOML](https://github.com/toml-lang/toml) file. It contains separate +sections for different tools. *Black* is using the `[tool.black]` +section. The option keys are the same as long names of options on +the command line. + +Note that you have to use single-quoted strings in TOML for regular +expressions. It's the equivalent of r-strings in Python. Multiline +strings are treated as verbose regular expressions by Black. Use `[ ]` +to denote a significant space character. + +
+Example `pyproject.toml` + +```toml +[tool.black] +line-length = 88 +py36 = true +include = '\.pyi?$' +exclude = ''' +/( + \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | buck-out + | build + | dist + + # The following are specific to Black, you probably don't want those. + | blib2to3 + | tests/data +)/ +''' +``` + +
+ +### Lookup hierarchy + +Command-line options have defaults that you can see in `--help`. +A `pyproject.toml` can override those defaults. Finally, options +provided by the user on the command line override both. + +*Black* will only ever use one `pyproject.toml` file during an entire +run. It doesn't look for multiple files, and doesn't compose +configuration from different levels of the file hierarchy. + + ## Editor integration ### Emacs @@ -539,6 +635,7 @@ Commands and shortcuts: Configuration: * `g:black_fast` (defaults to `0`) * `g:black_linelength` (defaults to `88`) +* `g:black_skip_string_normalization` (defaults to `0`) * `g:black_virtualenv` (defaults to `~/.vim/black`) To install with [vim-plug](https://github.com/junegunn/vim-plug): @@ -573,7 +670,7 @@ The plugin will use it. To run *Black* on save, add the following line to `.vimrc` or `init.vim`: ``` -autocmd BufWritePost *.py execute ':Black' +autocmd BufWritePre *.py execute ':Black' ``` **How to get Vim with Python 3.6?** @@ -586,7 +683,8 @@ to do this. ### Visual Studio Code -Use [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode). +Use the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)). ### SublimeText 3 @@ -599,6 +697,14 @@ Use [sublack plugin](https://github.com/jgirardet/sublack). Use [blackcellmagic](https://github.com/csurfer/blackcellmagic). +### Python Language Server + +If your editor supports the [Language Server Protocol](https://langserver.org/) +(Atom, Sublime Text, Visual Studio Code and many more), you can use +the [Python Language Server](https://github.com/palantir/python-language-server) with the +[pyls-black](https://github.com/rupert/pyls-black) plugin. + + ### Other editors Atom/Nuclide integration is planned by the author, others will @@ -607,7 +713,7 @@ require external contributions. Patches welcome! ✨ 🍰 ✨ Any tool that can pipe code through *Black* using its stdio mode (just -[use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)). +[use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)). The formatted code will be returned on stdout (unless `--check` was passed). *Black* will still emit messages on stderr but that shouldn't affect your use case. @@ -626,23 +732,25 @@ repos: rev: stable hooks: - id: black - args: [--line-length=88, --safe] language_version: python3.6 ``` Then run `pre-commit install` and you're ready to go. -`args` in the above config is optional but shows you how you can change -the line length if you really need to. If you're already using Python -3.7, switch the `language_version` accordingly. Finally, `stable` is a tag -that is pinned to the latest release on PyPI. If you'd rather run on -master, this is also an option. +Avoid using `args` in the hook. Instead, store necessary configuration +in `pyproject.toml` so that editors and command-line usage of Black all +behave consistently for your project. See *Black*'s own `pyproject.toml` +for an example. + +If you're already using Python 3.7, switch the `language_version` +accordingly. Finally, `stable` is a tag that is pinned to the latest +release on PyPI. If you'd rather run on master, this is also an option. ## Ignoring unmodified files *Black* remembers files it has already formatted, unless the `--diff` flag is used or code is passed via standard input. This information is stored per-user. The exact -location of the file depends on the black version and the system on which black +location of the file depends on the *Black* version and the system on which *Black* is run. The file is non-portable. The standard location on common operating systems is: @@ -655,7 +763,7 @@ is: **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips): -> Black is opinionated so you don't have to be. +> *Black* is opinionated so you don't have to be. **Hynek Schlawack**, [creator of `attrs`](http://www.attrs.org/), core developer of Twisted and CPython: @@ -680,6 +788,12 @@ Use the badge in your project's README.md: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) ``` +Using the badge in README.rst: +``` +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/ambv/black +``` + Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) @@ -688,7 +802,7 @@ Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style MIT -## Contributing to Black +## Contributing to *Black* In terms of inspiration, *Black* is about as configurable as *gofmt*. This is deliberate. @@ -706,15 +820,87 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log +### 18.8b0 + +* fix parsing of `__future__` imports with renames (#389) +* fix scope of `# fmt: off` when directly preceding `yield` and other nodes (#385) + +### 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 @@ -820,10 +1006,10 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * 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 +* *Black* no longer enforces putting empty lines behind control flow statements (#90) -* Black now splits imports like "Mode 3 + trailing comma" of isort (#127) +* *Black* now splits imports like "Mode 3 + trailing comma" of isort (#127) * fixed comment indentation when a standalone comment closes a block (#16, #32) @@ -876,16 +1062,16 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). (#75) * fixed handling of standalone comments within nested bracketed - expressions; Black will no longer produce super long lines or put all + 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) + would cause *Black* to not emit the rest of the file (#95) -* when CTRL+C is pressed while formatting many files, Black no longer +* 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 @@ -932,7 +1118,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ### 18.3a2 * changed positioning of binary operators to occur at beginning of lines - instead of at the end, following [a recent change to PEP8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b) + 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 @@ -1006,22 +1192,9 @@ Multiple contributions by: * [Jonas Obrist](mailto:ojiidotch@gmail.com) * [Luka Sterbic](mailto:luka.sterbic@gmail.com) * [Miguel Gaiowski](mailto:miggaiowski@gmail.com) +* [Neraste](neraste.herr10@gmail.com) * [Osaetin Daniel](mailto:osaetindaniel@gmail.com) +* [Peter Bengtsson](mailto:mail@peterbe.com) * [Stavros Korokithakis](mailto:hi@stavros.io) * [Sunil Kapil](mailto:snlkapil@gmail.com) * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com) - ---- - -*Contents:* -**[Installation and Usage](#installation-and-usage)** | -**[The *Black* code style](#the-black-code-style)** | -**[Editor integration](#editor-integration)** | -**[Version control integration](#version-control-integration)** | -**[Ignoring unmodified files](#ignoring-unmodified-files)** | -**[Testimonials](#testimonials)** | -**[Show your style](#show-your-style)** | -**[License](#license)** | -**[Contributing](#contributing-to-black)** | -**[Change Log](#change-log)** | -**[Authors](#authors)**