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_empty_tuple
  16
  17 .. autofunction:: black.is_import
  18
  19 .. autofunction:: black.is_line_short_enough
  20
  21 .. autofunction:: black.is_one_tuple
  22
  23 .. autofunction:: black.is_python36
  24
  25 .. autofunction:: black.is_split_after_delimiter
  26
  27 .. autofunction:: black.is_split_before_delimiter
  28
  29 .. autofunction:: black.is_stub_body
  30
  31 .. autofunction:: black.is_stub_suite
  32
  33 .. autofunction:: black.is_vararg
  34
  35 Formatting
  36 ----------
  37
  38 .. autofunction:: black.format_file_contents
  39
  40 .. autofunction:: black.format_file_in_place
  41
  42 .. autofunction:: black.format_stdin_to_stdout
  43
  44 .. autofunction:: black.format_str
  45
  46 .. autofunction:: black.reformat_one
  47
  48 .. autofunction:: black.schedule_formatting
  49
  50 File operations
  51 ---------------
  52
  53 .. autofunction:: black.dump_to_file
  54
  55 .. autofunction:: black.gen_python_files_in_dir
  56
  57 Parsing
  58 -------
  59
  60 .. autofunction:: black.lib2to3_parse
  61
  62 .. autofunction:: black.lib2to3_unparse
  63
  64 Split functions
  65 ---------------
  66
  67 .. autofunction:: black.delimiter_split
  68
  69 .. autofunction:: black.explode_split
  70
  71 .. autofunction:: black.left_hand_split
  72
  73 .. autofunction:: black.right_hand_split
  74
  75 .. autofunction:: black.standalone_comment_split
  76
  77 .. autofunction:: black.split_line
  78
  79 .. autofunction:: black.bracket_split_succeeded_or_raise
  80
  81 Caching
  82 -------
  83
  84 .. autofunction:: black.filter_cached
  85
  86 .. autofunction:: black.get_cache_info
  87
  88 .. autofunction:: black.read_cache
  89
  90 .. autofunction:: black.write_cache
  91
  92 Utilities
  93 ---------
  94
  95 .. py:function:: black.DebugVisitor.show(code: str) -> None
  96
  97     Pretty-print the lib2to3 AST of a given string of `code`.
  98
  99 .. autofunction:: black.diff
 100
 101 .. autofunction:: black.ensure_visible
 102
 103 .. autofunction:: black.enumerate_reversed
 104
 105 .. autofunction:: black.generate_comments
 106
 107 .. autofunction:: black.make_comment
 108
 109 .. autofunction:: black.maybe_make_parens_invisible_in_atom
 110
 111 .. autofunction:: black.max_delimiter_priority_in_atom
 112
 113 .. autofunction:: black.normalize_prefix
 114
 115 .. autofunction:: black.normalize_string_quotes
 116
 117 .. autofunction:: black.normalize_invisible_parens
 118
 119 .. autofunction:: black.preceding_leaf
 120
 121 .. autofunction:: black.sub_twice
 122
 123 .. autofunction:: black.whitespace