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 no sources are passed to it;
   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 `--check` was used).
  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 _Black_ has quite a few knobs these days, although _Black_ is opinionated so style
  30 configuration options are deliberately limited and rarely added. You can list them by
  31 running `black --help`.
  32
  33 <details>
  34
  35 <summary>Help output</summary>
  36
  37 ```{program-output} black --help
  38
  39 ```
  40
  41 </details>
  42
  43 ## Configuration via a file
  44
  45 _Black_ is able to read project-specific default values for its command line options
  46 from a `pyproject.toml` file. This is especially useful for specifying custom
  47 `--include` and `--exclude`/`--force-exclude`/`--extend-exclude` patterns for your
  48 project.
  49
  50 **Pro-tip**: If you're asking yourself "Do I need to configure anything?" the answer is
  51 "No". _Black_ is all about sensible defaults. Applying those defaults will have your
  52 code in compliance with many other _Black_ formatted projects.
  53
  54 ### What on Earth is a `pyproject.toml` file?
  55
  56 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines `pyproject.toml` as a
  57 configuration file to store build system requirements for Python projects. With the help
  58 of tools like [Poetry](https://python-poetry.org/) or
  59 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the need for
  60 `setup.py` and `setup.cfg` files.
  61
  62 ### Where _Black_ looks for the file
  63
  64 By default _Black_ looks for `pyproject.toml` starting from the common base directory of
  65 all files and directories passed on the command line. If it's not there, it looks in
  66 parent directories. It stops looking when it finds the file, or a `.git` directory, or a
  67 `.hg` directory, or the root of the file system, whichever comes first.
  68
  69 If you're formatting standard input, _Black_ will look for configuration starting from
  70 the current working directory.
  71
  72 You can use a "global" configuration, stored in a specific location in your home
  73 directory. This will be used as a fallback configuration, that is, it will be used if
  74 and only if _Black_ doesn't find any configuration as mentioned above. Depending on your
  75 operating system, this configuration file should be stored as:
  76
  77 - Windows: `~\.black`
  78 - Unix-like (Linux, MacOS, etc.): `$XDG_CONFIG_HOME/black` (`~/.config/black` if the
  79   `XDG_CONFIG_HOME` environment variable is not set)
  80
  81 Note that these are paths to the TOML file itself (meaning that they shouldn't be named
  82 as `pyproject.toml`), not directories where you store the configuration. Here, `~`
  83 refers to the path to your home directory. On Windows, this will be something like
  84 `C:\\Users\UserName`.
  85
  86 You can also explicitly specify the path to a particular file that you want with
  87 `--config`. In this situation _Black_ will not look for any other file.
  88
  89 If you're running with `--verbose`, you will see a blue message if a file was found and
  90 used.
  91
  92 Please note `blackd` will not use `pyproject.toml` configuration.
  93
  94 ### Configuration format
  95
  96 As the file extension suggests, `pyproject.toml` is a
  97 [TOML](https://github.com/toml-lang/toml) file. It contains separate sections for
  98 different tools. _Black_ is using the `[tool.black]` section. The option keys are the
  99 same as long names of options on the command line.
 100
 101 Note that you have to use single-quoted strings in TOML for regular expressions. It's
 102 the equivalent of r-strings in Python. Multiline strings are treated as verbose regular
 103 expressions by Black. Use `[ ]` to denote a significant space character.
 104
 105 <details>
 106 <summary>Example <code>pyproject.toml</code></summary>
 107
 108 ```toml
 109 [tool.black]
 110 line-length = 88
 111 target-version = ['py37']
 112 include = '\.pyi?$'
 113 extend-exclude = '''
 114 # A regex preceded with ^/ will apply only to files and directories
 115 # in the root of the project.
 116 ^/foo.py  # exclude a file named foo.py in the root of the project (in addition to the defaults)
 117 '''
 118 ```
 119
 120 </details>
 121
 122 ### Lookup hierarchy
 123
 124 Command-line options have defaults that you can see in `--help`. A `pyproject.toml` can
 125 override those defaults. Finally, options provided by the user on the command line
 126 override both.
 127
 128 _Black_ will only ever use one `pyproject.toml` file during an entire run. It doesn't
 129 look for multiple files, and doesn't compose configuration from different levels of the
 130 file hierarchy.
 131
 132 ## Next steps
 133
 134 You've probably noted that not all of the options you can pass to _Black_ have been
 135 covered. Don't worry, the rest will be covered in a later section.
 136
 137 A good next step would be configuring auto-discovery so `black .` is all you need
 138 instead of laborously listing every file or directory. You can get started by heading
 139 over to [File collection and discovery](./file_collection_and_discovery.md).
 140
 141 Another good choice would be setting up an
 142 [integration with your editor](../integrations/editors.md) of choice or with
 143 [pre-commit for source version control](../integrations/source_version_control.md).