]> git.madduck.net Git - etc/vim.git/blob - 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:

20aa956dd85bed47307c598d458bfef8d96cf25c
[etc/vim.git] / docs / usage_and_configuration / the_basics.md
1 # The basics
2
3 Foundational knowledge on using and configuring Black.
4
5 _Black_ is a well-behaved Unix-style command-line tool:
6
7 - it does nothing if it finds no sources to format;
8 - it will read from standard input and write to standard output if `-` is used as the
9   filename;
10 - it only outputs messages to users on standard error;
11 - exits with code 0 unless an internal error occurred or a CLI option prompted it.
12
13 ## Usage
14
15 To get started right away with sensible defaults:
16
17 ```sh
18 black {source_file_or_directory}
19 ```
20
21 You can run _Black_ as a package if running it as a script doesn't work:
22
23 ```sh
24 python -m black {source_file_or_directory}
25 ```
26
27 ### Command line options
28
29 The CLI options of _Black_ can be displayed by expanding the view below or by running
30 `black --help`. While _Black_ has quite a few knobs these days, it is still opinionated
31 so style options are deliberately limited and rarely added.
32
33 <details>
34
35 <summary>CLI reference</summary>
36
37 ```{program-output} black --help
38
39 ```
40
41 </details>
42
43 ### Code input alternatives
44
45 #### Standard Input
46
47 _Black_ supports formatting code via stdin, with the result being printed to stdout.
48 Just let _Black_ know with `-` as the path.
49
50 ```console
51 $ echo "print ( 'hello, world' )" | black -
52 print("hello, world")
53 reformatted -
54 All done! ✨ 🍰 ✨
55 1 file reformatted.
56 ```
57
58 **Tip:** if you need _Black_ to treat stdin input as a file passed directly via the CLI,
59 use `--stdin-filename`. Useful to make sure _Black_ will respect the `--force-exclude`
60 option on some editors that rely on using stdin.
61
62 #### As a string
63
64 You can also pass code as a string using the `-c` / `--code` option.
65
66 ```console
67 $ black --code "print ( 'hello, world' )"
68 print("hello, world")
69 ```
70
71 ### Writeback and reporting
72
73 By default _Black_ reformats the files given and/or found in place. Sometimes you need
74 _Black_ to just tell you what it _would_ do without actually rewriting the Python files.
75
76 There's two variations to this mode that are independently enabled by their respective
77 flags. Both variations can be enabled at once.
78
79 #### Exit code
80
81 Passing `--check` will make _Black_ exit with:
82
83 - code 0 if nothing would change;
84 - code 1 if some files would be reformatted; or
85 - code 123 if there was an internal error
86
87 ```console
88 $ black test.py --check
89 All done! ✨ 🍰 ✨
90 1 file would be left unchanged.
91 $ echo $?
92 0
93
94 $ black test.py --check
95 would reformat test.py
96 Oh no! 💥 💔 💥
97 1 file would be reformatted.
98 $ echo $?
99 1
100
101 $ black test.py --check
102 error: cannot format test.py: INTERNAL ERROR: Black produced code that is not equivalent to the source.  Please report a bug on https://github.com/psf/black/issues.  This diff might be helpful: /tmp/blk_kjdr1oog.log
103 Oh no! 💥 💔 💥
104 1 file would fail to reformat.
105 $ echo $?
106 123
107 ```
108
109 #### Diffs
110
111 Passing `--diff` will make _Black_ print out diffs that indicate what changes _Black_
112 would've made. They are printed to stdout so capturing them is simple.
113
114 If you'd like colored diffs, you can enable them with the `--color`.
115
116 ```console
117 $ black test.py --diff
118 --- test.py     2021-03-08 22:23:40.848954 +0000
119 +++ test.py     2021-03-08 22:23:47.126319 +0000
120 @@ -1 +1 @@
121 -print ( 'hello, world' )
122 +print("hello, world")
123 would reformat test.py
124 All done! ✨ 🍰 ✨
125 1 file would be reformatted.
126 ```
127
128 ### Output verbosity
129
130 _Black_ in general tries to produce the right amount of output, balancing between
131 usefulness and conciseness. By default, _Black_ emits files modified and error messages,
132 plus a short summary.
133
134 ```console
135 $ black src/
136 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
137 reformatted src/black_primer/lib.py
138 reformatted src/blackd/__init__.py
139 reformatted src/black/__init__.py
140 Oh no! 💥 💔 💥
141 3 files reformatted, 2 files left unchanged, 1 file failed to reformat.
142 ```
143
144 Passing `-v` / `--verbose` will cause _Black_ to also emit messages about files that
145 were not changed or were ignored due to exclusion patterns. If _Black_ is using a
146 configuration file, a blue message detailing which one it is using will be emitted.
147
148 ```console
149 $ black src/ -v
150 Using configuration from /tmp/pyproject.toml.
151 src/blib2to3 ignored: matches the --extend-exclude regular expression
152 src/_black_version.py wasn't modified on disk since last run.
153 src/black/__main__.py wasn't modified on disk since last run.
154 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
155 reformatted src/black_primer/lib.py
156 reformatted src/blackd/__init__.py
157 reformatted src/black/__init__.py
158 Oh no! 💥 💔 💥
159 3 files reformatted, 2 files left unchanged, 1 file failed to reformat
160 ```
161
162 Passing `-q` / `--quiet` will cause _Black_ to stop emitting all non-critial output.
163 Error messages will still be emitted (which can silenced by `2>/dev/null`).
164
165 ```console
166 $ black src/ -q
167 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
168 ```
169
170 ### Versions
171
172 You can check the version of _Black_ you have installed using the `--version` flag.
173
174 ```console
175 $ black --version
176 black, version 22.10.0
177 ```
178
179 An option to require a specific version to be running is also provided.
180
181 ```console
182 $ black --required-version 21.9b0 -c "format = 'this'"
183 format = "this"
184 $ black --required-version 31.5b2 -c "still = 'beta?!'"
185 Oh no! 💥 💔 💥 The required version does not match the running version!
186 ```
187
188 This is useful for example when running _Black_ in multiple environments that haven't
189 necessarily installed the correct version. This option can be set in a configuration
190 file for consistent results across environments.
191
192 ## Configuration via a file
193
194 _Black_ is able to read project-specific default values for its command line options
195 from a `pyproject.toml` file. This is especially useful for specifying custom
196 `--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
197 project.
198
199 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
200 "No". _Black_ is all about sensible defaults. Applying those defaults will have your
201 code in compliance with many other _Black_ formatted projects.
202
203 ### What on Earth is a `pyproject.toml` file?
204
205 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines `pyproject.toml` as a
206 configuration file to store build system requirements for Python projects. With the help
207 of tools like [Poetry](https://python-poetry.org/),
208 [Flit](https://flit.readthedocs.io/en/latest/), or
209 [Hatch](https://hatch.pypa.io/latest/) it can fully replace the need for `setup.py` and
210 `setup.cfg` files.
211
212 ### Where _Black_ looks for the file
213
214 By default _Black_ looks for `pyproject.toml` starting from the common base directory of
215 all files and directories passed on the command line. If it's not there, it looks in
216 parent directories. It stops looking when it finds the file, or a `.git` directory, or a
217 `.hg` directory, or the root of the file system, whichever comes first.
218
219 If you're formatting standard input, _Black_ will look for configuration starting from
220 the current working directory.
221
222 You can use a "global" configuration, stored in a specific location in your home
223 directory. This will be used as a fallback configuration, that is, it will be used if
224 and only if _Black_ doesn't find any configuration as mentioned above. Depending on your
225 operating system, this configuration file should be stored as:
226
227 - Windows: `~\.black`
228 - Unix-like (Linux, MacOS, etc.): `$XDG_CONFIG_HOME/black` (`~/.config/black` if the
229   `XDG_CONFIG_HOME` environment variable is not set)
230
231 Note that these are paths to the TOML file itself (meaning that they shouldn't be named
232 as `pyproject.toml`), not directories where you store the configuration. Here, `~`
233 refers to the path to your home directory. On Windows, this will be something like
234 `C:\\Users\UserName`.
235
236 You can also explicitly specify the path to a particular file that you want with
237 `--config`. In this situation _Black_ will not look for any other file.
238
239 If you're running with `--verbose`, you will see a blue message if a file was found and
240 used.
241
242 Please note `blackd` will not use `pyproject.toml` configuration.
243
244 ### Configuration format
245
246 As the file extension suggests, `pyproject.toml` is a
247 [TOML](https://github.com/toml-lang/toml) file. It contains separate sections for
248 different tools. _Black_ is using the `[tool.black]` section. The option keys are the
249 same as long names of options on the command line.
250
251 Note that you have to use single-quoted strings in TOML for regular expressions. It's
252 the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
253 expressions by Black. Use `[ ]` to denote a significant space character.
254
255 <details>
256 <summary>Example <code>pyproject.toml</code></summary>
257
258 ```toml
259 [tool.black]
260 line-length = 88
261 target-version = ['py37']
262 include = '\.pyi?$'
263 # 'extend-exclude' excludes files or directories in addition to the defaults
264 extend-exclude = '''
265 # A regex preceded with ^/ will apply only to files and directories
266 # in the root of the project.
267 (
268   ^/foo.py    # exclude a file named foo.py in the root of the project
269   | .*_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
270 )
271 '''
272 ```
273
274 </details>
275
276 ### Lookup hierarchy
277
278 Command-line options have defaults that you can see in `--help`. A `pyproject.toml` can
279 override those defaults. Finally, options provided by the user on the command line
280 override both.
281
282 _Black_ will only ever use one `pyproject.toml` file during an entire run. It doesn't
283 look for multiple files, and doesn't compose configuration from different levels of the
284 file hierarchy.
285
286 ## Next steps
287
288 You've probably noted that not all of the options you can pass to _Black_ have been
289 covered. Don't worry, the rest will be covered in a later section.
290
291 A good next step would be configuring auto-discovery so `black .` is all you need
292 instead of laborously listing every file or directory. You can get started by heading
293 over to [File collection and discovery](./file_collection_and_discovery.md).
294
295 Another good choice would be setting up an
296 [integration with your editor](../integrations/editors.md) of choice or with
297 [pre-commit for source version control](../integrations/source_version_control.md).