pyproject.toml

   1 # SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 [tool.autopep8]
   4 # Configuration for `autopep8`, allowing the command: autopep8 .
   5 # to reformat all source files.
   6 #
   7 # NOTE: the settings defined here map directly to command line arguments
   8 # which will override these settings when passed in to autopep8.
   9
  10 max_line_length = 120
  11
  12 ignore = [
  13     # Info: Use `isinstance()` instead of comparing types directly.
  14     # Why disable? Changes code logic, in rare cases we want to compare exact types.
  15     "E721",
  16     # Info: Fix bare except.
  17     # Why disable? Disruptive, leave our exceptions alone.
  18     "E722",
  19     # Info: Fix module level import not at top of file.
  20     # Why disable? Re-ordering imports is disruptive and breaks some scripts
  21     # that need to check if a module has already been loaded in the case of reloading.
  22     "E402",
  23     # Info: Fix various deprecated code (via lib2to3)
  24     # Why disable? Does nothing besides incorrectly adding a duplicate import,
  25     # could be reported as a bug except this is likely to be removed soon, see:
  26     # https://github.com/python/cpython/issues/84540.
  27     "W690",
  28 ]
  29
  30 # Use aggressive as many useful edits are disabled unless it's enabled.
  31 # Any edits which are overly disruptive or risky can be removed in the `ignore` list.
  32 aggressive = 2
  33
  34 # Exclude:
  35 # - `./extern/` because it's maintained separately.
  36 # - `./tools/svn_rev_map/` contains data-files which are slow to re-format and don't benefit from formatting.
  37 # - `./scripts/addons*` because it is an external repository.
  38 #   which can contain their own configuration and be handled separately.
  39 # - `./scripts/modules/rna_manual_reference.py` because it's a generated data-file.
  40 exclude = """
  41 extern/*,
  42 scripts/addons_core/*,
  43 scripts/modules/rna_manual_reference.py,
  44 tools/svn_rev_map/sha1_to_rev.py,
  45 tools/svn_rev_map/rev_to_sha1.py,
  46 """
  47
  48 # Omit settings such as `jobs`, `in_place` & `recursive` as they can cause editor utilities that auto-format on save
  49 # to fail if the STDIN/STDOUT is used for formatting (which isn't compatible with these options).
  50
  51 # Black shouldn't be used as a formatter. But if it's accidentally
  52 # used, it certainly shouldn't change all the quote marks around
  53 # strings. This simply makes such a mistake easier to recover from.
  54 [tool.black]
  55 skip-string-normalization = true
  56 line-length = 120