docs/faq.md

   1 # Frequently Asked Questions
   2
   3 The most common questions and issues users face are aggregated to this FAQ.
   4
   5 ```{contents}
   6 :local:
   7 :backlinks: none
   8 ```
   9
  10 ## Does Black have an API?
  11
  12 Not yet. _Black_ is fundamentally a command line tool. Many
  13 [integrations](integrations/index.rst) are provided, but a Python interface is not one
  14 of them. A simple API is being [planned](https://github.com/psf/black/issues/779)
  15 though.
  16
  17 ## Is Black safe to use?
  18
  19 Yes, for the most part. _Black_ is strictly about formatting, nothing else. But because
  20 _Black_ is still in [beta](index.rst), some edges are still a bit rough. To combat
  21 issues, the equivalence of code after formatting is
  22 [checked](the_black_code_style/current_style.md#ast-before-and-after-formatting) with
  23 limited special cases where the code is allowed to differ. If issues are found, an error
  24 is raised and the file is left untouched. Magical comments that influence linters and
  25 other tools, such as `# noqa`, may be moved by _Black_. See below for more details.
  26
  27 ## How stable is Black's style?
  28
  29 Quite stable. _Black_ aims to enforce one style and one style only, with some room for
  30 pragmatism. However, _Black_ is still in beta so style changes are both planned and
  31 still proposed on the issue tracker. See
  32 [The Black Code Style](the_black_code_style/index.rst) for more details.
  33
  34 ## Why is my file not formatted?
  35
  36 Most likely because it is ignored in `.gitignore` or excluded with configuration. See
  37 [file collection and discovery](usage_and_configuration/file_collection_and_discovery.md)
  38 for details.
  39
  40 ## Why is my Jupyter Notebook cell not formatted?
  41
  42 _Black_ is timid about formatting Jupyter Notebooks. Cells containing any of the
  43 following will not be formatted:
  44
  45 - automagics (e.g. `pip install black`)
  46 - multiline magics, e.g.:
  47
  48   ```python
  49   %timeit f(1, \
  50           2, \
  51           3)
  52   ```
  53
  54 - code which `IPython`'s `TransformerManager` would transform magics into, e.g.:
  55
  56   ```python
  57   get_ipython().system('ls')
  58   ```
  59
  60 - invalid syntax, as it can't be safely distinguished from automagics in the absence of
  61   a running `IPython` kernel.
  62
  63 ## Why are Flake8's E203 and W503 violated?
  64
  65 Because they go against PEP 8. E203 falsely triggers on list
  66 [slices](the_black_code_style/current_style.md#slices), and adhering to W503 hinders
  67 readability because operators are misaligned. Disable W503 and enable the
  68 disabled-by-default counterpart W504. E203 should be disabled while changes are still
  69 [discussed](https://github.com/PyCQA/pycodestyle/issues/373).
  70
  71 ## Does Black support Python 2?
  72
  73 For formatting, yes! [Install](getting_started.md#installation) with the `python2` extra
  74 to format Python 2 files too! There are no current plans to drop support, but most
  75 likely it is bound to happen. Sometime. Eventually. In terms of running _Black_ though,
  76 Python 3.6 or newer is required.
  77
  78 ## Why does my linter or typechecker complain after I format my code?
  79
  80 Some linters and other tools use magical comments (e.g., `# noqa`, `# type: ignore`) to
  81 influence their behavior. While Black does its best to recognize such comments and leave
  82 them in the right place, this detection is not and cannot be perfect. Therefore, you'll
  83 sometimes have to manually move these comments to the right place after you format your
  84 codebase with _Black_.