X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/bbf38400ceef34119e63c18c71e3316040a90a59..4809e365d43ff5f837f9dacbc1f3d04975fe35e8:/README.md?ds=sidebyside diff --git a/README.md b/README.md index a23cb61..b6218cf 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,8 @@ Options: source on standard input). -S, --skip-string-normalization Don't normalize string quotes or prefixes. + -N, --skip-numeric-underscore-normalization + Don't normalize underscores in numeric literals. --check Don't write the files back, just return the status. Return code 0 means nothing would change. Return code 1 means some files would be @@ -99,7 +101,7 @@ Options: recursive searches. On Windows, use forward slashes for directories. [default: build/|buck-out/|dist/|_build/|\.git/|\.hg/| - \.mypy_cache/|\.tox/|\.venv/] + \.mypy_cache/|\.nox/|\.tox/|\.venv/] -q, --quiet Don't emit non-error messages to stderr. Errors are still emitted, silence those with 2>/dev/null. @@ -141,7 +143,8 @@ original. This slows it down. If you're feeling confident, use *Black* reformats entire files in place. It is not configurable. It doesn't take previous formatting into account. It doesn't reformat -blocks that start with `# fmt: off` and end with `# fmt: on`. It also +blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off` +have to be on the same level of indentation. It also recognizes [YAPF](https://github.com/google/yapf)'s block comments to the same effect, as a courtesy for straddling code. @@ -235,13 +238,13 @@ the following configuration. multi_line_output=3 include_trailing_comma=True force_grid_wrap=0 -combine_as_imports=True +use_parentheses=True line_length=88 ``` The equivalent command line is: ``` -$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --combine-as --line-width=88 [ file.py ] +$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ] ``` @@ -277,7 +280,8 @@ ignore = E501 ``` You'll find *Black*'s own .flake8 config file is configured like this. -If you're curious about the reasoning behind B950, Bugbear's documentation +If you're curious about the reasoning behind B950, +[Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings) explains it. The tl;dr is "it's like highway speed limits, we won't bother you if you overdo it by a few km/h". @@ -355,8 +359,8 @@ string literals that ended up on the same line (see [#26](https://github.com/ambv/black/issues/26) for details). Why settle on double quotes? They anticipate apostrophes in English -text. They match the docstring standard described in PEP 257. An -empty string in double quotes (`""`) is impossible to confuse with +text. They match the docstring standard described in [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring). +An empty string in double quotes (`""`) is impossible to confuse with a one double-quote regardless of fonts and syntax highlighting used. On top of this, double quotes for strings are consistent with C which Python interacts a lot with. @@ -381,6 +385,11 @@ styled as `2L` instead of `2l` to avoid confusion between `l` and `1`. In Python 3.6+, *Black* adds underscores to long numeric literals to aid readability: `100000000` becomes `100_000_000`. +For regions where numerals are grouped differently (like [India](https://en.wikipedia.org/wiki/Indian_numbering_system) +and [China](https://en.wikipedia.org/wiki/Chinese_numerals#Whole_numbers)), +the `-N` or `--skip-numeric-underscore-normalization` command line option +makes *Black* preserve underscores in numeric literals. + ### Line breaks & binary operators *Black* will break a line before a binary operator when splitting a block @@ -539,6 +548,8 @@ other file. If you're running with `--verbose`, you will see a blue message if a file was found and used. +Please note `blackd` will not use `pyproject.toml` configuration. + ### Configuration format @@ -664,7 +675,7 @@ Configuration: To install with [vim-plug](https://github.com/junegunn/vim-plug): ``` -Plug 'ambv/black', +Plug 'ambv/black' ``` or with [Vundle](https://github.com/VundleVim/Vundle.vim): @@ -715,7 +726,7 @@ Use the [Python extension](https://marketplace.visualstudio.com/items?itemName=m Use [sublack plugin](https://github.com/jgirardet/sublack). -### IPython Notebook Magic +### Jupyter Notebook Magic Use [blackcellmagic](https://github.com/csurfer/blackcellmagic). @@ -781,14 +792,14 @@ Options: ### Protocol `blackd` only accepts `POST` requests at the `/` path. The body of the request -should contain the python source code to be formatted, encoded +should contain the python source code to be formatted, encoded according to the `charset` field in the `Content-Type` request header. If no `charset` is specified, `blackd` assumes `UTF-8`. There are a few HTTP headers that control how the source is formatted. These correspond to command line flags for *Black*. There is one exception to this: `X-Protocol-Version` which if present, should have the value `1`, otherwise the -request is rejected with `HTTP 501` (Not Implemented). +request is rejected with `HTTP 501` (Not Implemented). The headers controlling how code is formatted are: @@ -796,6 +807,8 @@ The headers controlling how code is formatted are: - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization` command line flag. If present and its value is not the empty string, no string normalization will be performed. + - `X-Skip-Numeric-Underscore-Normalization`: corresponds to the + `--skip-numeric-underscore-normalization` command line flag. - `X-Fast-Or-Safe`: if set to `fast`, `blackd` will act as *Black* does when passed the `--fast` command line flag. - `X-Python-Variant`: if set to `pyi`, `blackd` will act as *Black* does when @@ -926,18 +939,28 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). * 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` or `0xab`) + * 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](#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) -* code with `_` in numeric literals is recognized as Python 3.6+ (#461) +* whitespace at the beginning of the file is now removed (#399) + +* fixed mangling [pweave](http://mpastell.com/pweave/) and + [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532) * fixed unstable formatting when unpacking big tuples (#267) @@ -954,7 +977,6 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). to be a bad idea (#415) - ### 18.6b4 * hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371) @@ -1329,3 +1351,4 @@ Multiple contributions by: * [Stavros Korokithakis](mailto:hi@stavros.io) * [Sunil Kapil](mailto:snlkapil@gmail.com) * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com) +* [Chuck Wooters](mailto:chuck.wooters@microsoft.com)