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 (labels/exit-code)=
  80
  81 #### Exit code
  82
  83 Passing `--check` will make _Black_ exit with:
  84
  85 - code 0 if nothing would change;
  86 - code 1 if some files would be reformatted; or
  87 - code 123 if there was an internal error
  88
  89 ```console
  90 $ black test.py --check
  91 All done! ✨ 🍰 ✨
  92 1 file would be left unchanged.
  93 $ echo $?
  94 0
  95
  96 $ black test.py --check
  97 would reformat test.py
  98 Oh no! 💥 💔 💥
  99 1 file would be reformatted.
 100 $ echo $?
 101 1
 102
 103 $ black test.py --check
 104 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
 105 Oh no! 💥 💔 💥
 106 1 file would fail to reformat.
 107 $ echo $?
 108 123
 109 ```
 110
 111 #### Diffs
 112
 113 Passing `--diff` will make _Black_ print out diffs that indicate what changes _Black_
 114 would've made. They are printed to stdout so capturing them is simple.
 115
 116 If you'd like colored diffs, you can enable them with the `--color`.
 117
 118 ```console
 119 $ black test.py --diff
 120 --- test.py     2021-03-08 22:23:40.848954 +0000
 121 +++ test.py     2021-03-08 22:23:47.126319 +0000
 122 @@ -1 +1 @@
 123 -print ( 'hello, world' )
 124 +print("hello, world")
 125 would reformat test.py
 126 All done! ✨ 🍰 ✨
 127 1 file would be reformatted.
 128 ```
 129
 130 ### Output verbosity
 131
 132 _Black_ in general tries to produce the right amount of output, balancing between
 133 usefulness and conciseness. By default, _Black_ emits files modified and error messages,
 134 plus a short summary.
 135
 136 ```console
 137 $ black src/
 138 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
 139 reformatted src/black_primer/lib.py
 140 reformatted src/blackd/__init__.py
 141 reformatted src/black/__init__.py
 142 Oh no! 💥 💔 💥
 143 3 files reformatted, 2 files left unchanged, 1 file failed to reformat.
 144 ```
 145
 146 Passing `-v` / `--verbose` will cause _Black_ to also emit messages about files that
 147 were not changed or were ignored due to exclusion patterns. If _Black_ is using a
 148 configuration file, a blue message detailing which one it is using will be emitted.
 149
 150 ```console
 151 $ black src/ -v
 152 Using configuration from /tmp/pyproject.toml.
 153 src/blib2to3 ignored: matches the --extend-exclude regular expression
 154 src/_black_version.py wasn't modified on disk since last run.
 155 src/black/__main__.py wasn't modified on disk since last run.
 156 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
 157 reformatted src/black_primer/lib.py
 158 reformatted src/blackd/__init__.py
 159 reformatted src/black/__init__.py
 160 Oh no! 💥 💔 💥
 161 3 files reformatted, 2 files left unchanged, 1 file failed to reformat
 162 ```
 163
 164 Passing `-q` / `--quiet` will cause _Black_ to stop emitting all non-critial output.
 165 Error messages will still be emitted (which can silenced by `2>/dev/null`).
 166
 167 ```console
 168 $ black src/ -q
 169 error: cannot format src/black_primer/cli.py: Cannot parse: 5:6: mport asyncio
 170 ```
 171
 172 ### Versions
 173
 174 You can check the version of _Black_ you have installed using the `--version` flag.
 175
 176 ```console
 177 $ black --version
 178 black, version 22.12.0
 179 ```
 180
 181 An option to require a specific version to be running is also provided.
 182
 183 ```console
 184 $ black --required-version 21.9b0 -c "format = 'this'"
 185 format = "this"
 186 $ black --required-version 31.5b2 -c "still = 'beta?!'"
 187 Oh no! 💥 💔 💥 The required version does not match the running version!
 188 ```
 189
 190 This is useful for example when running _Black_ in multiple environments that haven't
 191 necessarily installed the correct version. This option can be set in a configuration
 192 file for consistent results across environments.
 193
 194 ## Configuration via a file
 195
 196 _Black_ is able to read project-specific default values for its command line options
 197 from a `pyproject.toml` file. This is especially useful for specifying custom
 198 `--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
 199 project.
 200
 201 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
 202 "No". _Black_ is all about sensible defaults. Applying those defaults will have your
 203 code in compliance with many other _Black_ formatted projects.
 204
 205 ### What on Earth is a `pyproject.toml` file?
 206
 207 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines `pyproject.toml` as a
 208 configuration file to store build system requirements for Python projects. With the help
 209 of tools like [Poetry](https://python-poetry.org/),
 210 [Flit](https://flit.readthedocs.io/en/latest/), or
 211 [Hatch](https://hatch.pypa.io/latest/) it can fully replace the need for `setup.py` and
 212 `setup.cfg` files.
 213
 214 ### Where _Black_ looks for the file
 215
 216 By default _Black_ looks for `pyproject.toml` starting from the common base directory of
 217 all files and directories passed on the command line. If it's not there, it looks in
 218 parent directories. It stops looking when it finds the file, or a `.git` directory, or a
 219 `.hg` directory, or the root of the file system, whichever comes first.
 220
 221 If you're formatting standard input, _Black_ will look for configuration starting from
 222 the current working directory.
 223
 224 You can use a "global" configuration, stored in a specific location in your home
 225 directory. This will be used as a fallback configuration, that is, it will be used if
 226 and only if _Black_ doesn't find any configuration as mentioned above. Depending on your
 227 operating system, this configuration file should be stored as:
 228
 229 - Windows: `~\.black`
 230 - Unix-like (Linux, MacOS, etc.): `$XDG_CONFIG_HOME/black` (`~/.config/black` if the
 231   `XDG_CONFIG_HOME` environment variable is not set)
 232
 233 Note that these are paths to the TOML file itself (meaning that they shouldn't be named
 234 as `pyproject.toml`), not directories where you store the configuration. Here, `~`
 235 refers to the path to your home directory. On Windows, this will be something like
 236 `C:\\Users\UserName`.
 237
 238 You can also explicitly specify the path to a particular file that you want with
 239 `--config`. In this situation _Black_ will not look for any other file.
 240
 241 If you're running with `--verbose`, you will see a blue message if a file was found and
 242 used.
 243
 244 Please note `blackd` will not use `pyproject.toml` configuration.
 245
 246 ### Configuration format
 247
 248 As the file extension suggests, `pyproject.toml` is a
 249 [TOML](https://github.com/toml-lang/toml) file. It contains separate sections for
 250 different tools. _Black_ is using the `[tool.black]` section. The option keys are the
 251 same as long names of options on the command line.
 252
 253 Note that you have to use single-quoted strings in TOML for regular expressions. It's
 254 the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
 255 expressions by Black. Use `[ ]` to denote a significant space character.
 256
 257 <details>
 258 <summary>Example <code>pyproject.toml</code></summary>
 259
 260 ```toml
 261 [tool.black]
 262 line-length = 88
 263 target-version = ['py37']
 264 include = '\.pyi?$'
 265 # 'extend-exclude' excludes files or directories in addition to the defaults
 266 extend-exclude = '''
 267 # A regex preceded with ^/ will apply only to files and directories
 268 # in the root of the project.
 269 (
 270   ^/foo.py    # exclude a file named foo.py in the root of the project
 271   | .*_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
 272 )
 273 '''
 274 ```
 275
 276 </details>
 277
 278 ### Lookup hierarchy
 279
 280 Command-line options have defaults that you can see in `--help`. A `pyproject.toml` can
 281 override those defaults. Finally, options provided by the user on the command line
 282 override both.
 283
 284 _Black_ will only ever use one `pyproject.toml` file during an entire run. It doesn't
 285 look for multiple files, and doesn't compose configuration from different levels of the
 286 file hierarchy.
 287
 288 ## Next steps
 289
 290 You've probably noted that not all of the options you can pass to _Black_ have been
 291 covered. Don't worry, the rest will be covered in a later section.
 292
 293 A good next step would be configuring auto-discovery so `black .` is all you need
 294 instead of laborously listing every file or directory. You can get started by heading
 295 over to [File collection and discovery](./file_collection_and_discovery.md).
 296
 297 Another good choice would be setting up an
 298 [integration with your editor](../integrations/editors.md) of choice or with
 299 [pre-commit for source version control](../integrations/source_version_control.md).