]>
git.madduck.net Git - etc/vim.git/blobdiff - docs/usage_and_configuration/the_basics.md
madduck's git repository
Every one of the projects in this repository is available at the canonical
URL git://git.madduck.net/madduck/pub/<projectpath> — see
each project's metadata for the exact URL.
All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@ git. madduck. net .
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
SSH access, as well as push access can be individually
arranged .
If you use my repositories frequently, consider adding the following
snippet to ~/.gitconfig and using the third clone URL listed for each
project:
[url "git://git.madduck.net/madduck/"]
insteadOf = madduck:
#### `-t`, `--target-version`
#### `-t`, `--target-version`
-Python versions that should be supported by Black's output. You should include all
-versions that your code supports. If you support Python 3.7 through 3.10, you should
-write:
+Python versions that should be supported by Black's output. You can run `black --help`
+and look for the `--target-version` option to see the full list of supported versions.
+You should include all versions that your code supports. If you support Python 3.8
+through 3.11, you should write:
-$ black -t py37 -t py38 -t py39 -t py310
+$ black -t py38 -t py39 -t py310 -t py311
```
In a [configuration file](#configuration-via-a-file), you can write:
```toml
```
In a [configuration file](#configuration-via-a-file), you can write:
```toml
-target-versions = ["py37", "py38", "py39", "py310 "]
+target-version = ["py38", "py39", "py310", "py311 "]
```
_Black_ uses this option to decide what grammar to use to parse your code. In addition,
```
_Black_ uses this option to decide what grammar to use to parse your code. In addition,
```console
$ black test.py --diff
```console
$ black test.py --diff
---- test.py 2021-03-08 22:23:40.848954 +00 00
-+++ test.py 2021-03-08 22:23:47.126319 +00 00
+--- test.py 2021-03-08 22:23:40.848954+00: 00
++++ test.py 2021-03-08 22:23:47.126319+00: 00
@@ -1 +1 @@
-print ( 'hello, world' )
+print("hello, world")
@@ -1 +1 @@
-print ( 'hello, world' )
+print("hello, world")
```console
$ black --version
```console
$ black --version
-black, 23.3.0 (compiled: yes)
-$ black --required-version 23.3.0 -c "format = 'this'"
+black, 23.9.1 (compiled: yes)
+$ black --required-version 23.9.1 -c "format = 'this'"
format = "this"
$ black --required-version 31.5b2 -c "still = 'beta?!'"
Oh no! 💥 💔 💥 The required version does not match the running version!
format = "this"
$ black --required-version 31.5b2 -c "still = 'beta?!'"
Oh no! 💥 💔 💥 The required version does not match the running version!
#### `-W`, `--workers`
When _Black_ formats multiple files, it may use a process pool to speed up formatting.
#### `-W`, `--workers`
When _Black_ formats multiple files, it may use a process pool to speed up formatting.
-This option controls the number of parallel workers.
+This option controls the number of parallel workers. This can also be specified via the
+`BLACK_NUM_WORKERS` environment variable.
```console
$ black --version
```console
$ black --version
Show available command-line options and exit.
Show available command-line options and exit.
+### Environment variable options
+
+_Black_ supports the following configuration via environment variables.
+
+#### `BLACK_CACHE_DIR`
+
+The directory where _Black_ should store its cache.
+
+#### `BLACK_NUM_WORKERS`
+
+The number of parallel workers _Black_ should use. The command line option `-W` /
+`--workers` takes precedence over this environment variable.
+
### Code input alternatives
_Black_ supports formatting code via stdin, with the result being printed to stdout.
### Code input alternatives
_Black_ supports formatting code via stdin, with the result being printed to stdout.
projects / etc / vim.git / blobdiff