docs/reference/reference_functions.rst

   1 *Black* functions
   2 =================
   3
   4 *Contents are subject to change.*
   5
   6 .. currentmodule:: black
   7
   8 Assertions and checks
   9 ---------------------
  10
  11 .. autofunction:: black.assert_equivalent
  12
  13 .. autofunction:: black.assert_stable
  14
  15 .. autofunction:: black.is_delimiter
  16
  17 .. autofunction:: black.is_import
  18
  19 .. autofunction:: black.is_python36
  20
  21 Formatting
  22 ----------
  23
  24 .. autofunction:: black.format_file_contents
  25
  26 .. autofunction:: black.format_file_in_place
  27
  28 .. autofunction:: black.format_stdin_to_stdout
  29
  30 .. autofunction:: black.format_str
  31
  32 .. autofunction:: black.schedule_formatting
  33
  34 File operations
  35 ---------------
  36
  37 .. autofunction:: black.dump_to_file
  38
  39 .. autofunction:: black.gen_python_files_in_dir
  40
  41 Parsing
  42 -------
  43
  44 .. autofunction:: black.lib2to3_parse
  45
  46 .. autofunction:: black.lib2to3_unparse
  47
  48 Split functions
  49 ---------------
  50
  51 .. autofunction:: black.delimiter_split
  52
  53 .. autofunction:: black.left_hand_split
  54
  55 .. autofunction:: black.right_hand_split
  56
  57 .. autofunction:: black.split_line
  58
  59 .. autofunction:: black.bracket_split_succeeded_or_raise
  60
  61 Utilities
  62 ---------
  63
  64 .. py:function:: black.DebugVisitor.show(code: str) -> None
  65
  66     Pretty-print the lib2to3 AST of a given string of `code`.
  67
  68 .. autofunction:: black.diff
  69
  70 .. autofunction:: black.generate_comments
  71
  72 .. autofunction:: black.make_comment
  73
  74 .. autofunction:: black.normalize_prefix
  75
  76 .. autofunction:: black.preceding_leaf
  77
  78 .. autofunction:: black.whitespace