docs/contributing/reference/reference_classes.rst

   1 *Black* classes
   2 ===============
   3
   4 *Contents are subject to change.*
   5
   6 Black Classes
   7 ~~~~~~~~~~~~~~
   8
   9 .. currentmodule:: black
  10
  11 :class:`BracketTracker`
  12 -----------------------
  13
  14 .. autoclass:: black.brackets.BracketTracker
  15     :members:
  16
  17 :class:`Line`
  18 -------------
  19
  20 .. autoclass:: black.lines.Line
  21     :members:
  22     :special-members: __str__, __bool__
  23
  24 :class:`RHSResult`
  25 -------------------------
  26
  27 .. autoclass:: black.lines.RHSResult
  28     :members:
  29
  30 :class:`LinesBlock`
  31 -------------------------
  32
  33 .. autoclass:: black.lines.LinesBlock
  34     :members:
  35
  36 :class:`EmptyLineTracker`
  37 -------------------------
  38
  39 .. autoclass:: black.lines.EmptyLineTracker
  40     :members:
  41
  42 :class:`LineGenerator`
  43 ----------------------
  44
  45 .. autoclass:: black.linegen.LineGenerator
  46     :show-inheritance:
  47     :members:
  48
  49 :class:`ProtoComment`
  50 ---------------------
  51
  52 .. autoclass:: black.comments.ProtoComment
  53     :members:
  54
  55 :class:`Mode`
  56 ---------------------
  57
  58 .. autoclass:: black.mode.Mode
  59     :members:
  60
  61 :class:`Report`
  62 ---------------
  63
  64 .. autoclass:: black.report.Report
  65     :members:
  66     :special-members: __str__
  67
  68 :class:`Ok`
  69 ---------------
  70
  71 .. autoclass:: black.rusty.Ok
  72     :show-inheritance:
  73     :members:
  74
  75 :class:`Err`
  76 ---------------
  77
  78 .. autoclass:: black.rusty.Err
  79     :show-inheritance:
  80     :members:
  81
  82 :class:`Visitor`
  83 ----------------
  84
  85 .. autoclass:: black.nodes.Visitor
  86     :show-inheritance:
  87     :members:
  88
  89 :class:`StringTransformer`
  90 ----------------------------
  91
  92 .. autoclass:: black.trans.StringTransformer
  93     :show-inheritance:
  94     :members:
  95
  96 :class:`CustomSplit`
  97 ----------------------------
  98
  99 .. autoclass:: black.trans.CustomSplit
 100     :members:
 101
 102 :class:`CustomSplitMapMixin`
 103 -----------------------------
 104
 105 .. autoclass:: black.trans.CustomSplitMapMixin
 106     :show-inheritance:
 107     :members:
 108
 109 :class:`StringMerger`
 110 ----------------------
 111
 112 .. autoclass:: black.trans.StringMerger
 113     :show-inheritance:
 114     :members:
 115
 116 :class:`StringParenStripper`
 117 -----------------------------
 118
 119 .. autoclass:: black.trans.StringParenStripper
 120     :show-inheritance:
 121     :members:
 122
 123 :class:`BaseStringSplitter`
 124 -----------------------------
 125
 126 .. autoclass:: black.trans.BaseStringSplitter
 127     :show-inheritance:
 128     :members:
 129
 130 :class:`StringSplitter`
 131 -----------------------------
 132
 133 .. autoclass:: black.trans.StringSplitter
 134     :show-inheritance:
 135     :members:
 136
 137 :class:`StringParenWrapper`
 138 -----------------------------
 139
 140 .. autoclass:: black.trans.StringParenWrapper
 141     :show-inheritance:
 142     :members:
 143
 144 :class:`StringParser`
 145 -----------------------------
 146
 147 .. autoclass:: black.trans.StringParser
 148     :members:
 149
 150 :class:`DebugVisitor`
 151 ------------------------
 152
 153 .. autoclass:: black.debug.DebugVisitor
 154     :show-inheritance:
 155     :members:
 156
 157 :class:`Replacement`
 158 ------------------------
 159
 160 .. autoclass:: black.handle_ipynb_magics.Replacement
 161     :members:
 162
 163 :class:`CellMagic`
 164 ------------------------
 165
 166 .. autoclass:: black.handle_ipynb_magics.CellMagic
 167     :members:
 168
 169 :class:`CellMagicFinder`
 170 ------------------------
 171
 172 .. autoclass:: black.handle_ipynb_magics.CellMagicFinder
 173     :show-inheritance:
 174     :members:
 175
 176 :class:`OffsetAndMagic`
 177 ------------------------
 178
 179 .. autoclass:: black.handle_ipynb_magics.OffsetAndMagic
 180     :members:
 181
 182 :class:`MagicFinder`
 183 ------------------------
 184
 185 .. autoclass:: black.handle_ipynb_magics.MagicFinder
 186     :show-inheritance:
 187     :members:
 188
 189 :class:`Cache`
 190 ------------------------
 191
 192 .. autoclass:: black.cache.Cache
 193     :show-inheritance:
 194     :members:
 195
 196 Enum Classes
 197 ~~~~~~~~~~~~~
 198
 199 Classes inherited from Python `Enum <https://docs.python.org/3/library/enum.html#enum.Enum>`_ class.
 200
 201 :class:`Changed`
 202 ----------------
 203
 204 .. autoclass:: black.report.Changed
 205     :show-inheritance:
 206     :members:
 207
 208 :class:`WriteBack`
 209 ------------------
 210
 211 .. autoclass:: black.WriteBack
 212     :show-inheritance:
 213     :members:
 214
 215 :class:`TargetVersion`
 216 ----------------------
 217
 218 .. autoclass:: black.mode.TargetVersion
 219     :show-inheritance:
 220     :members:
 221
 222 :class:`Feature`
 223 ------------------
 224
 225 .. autoclass:: black.mode.Feature
 226     :show-inheritance:
 227     :members:
 228
 229 :class:`Preview`
 230 ------------------
 231
 232 .. autoclass:: black.mode.Preview
 233     :show-inheritance:
 234     :members: