docs/contributing/reference/reference_classes.rst

   1 *Black* classes
   2 ===============
   3
   4 *Contents are subject to change.*
   5
   6 .. currentmodule:: black
   7
   8 :class:`BracketTracker`
   9 -----------------------
  10
  11 .. autoclass:: black.brackets.BracketTracker
  12     :members:
  13
  14 :class:`EmptyLineTracker`
  15 -------------------------
  16
  17 .. autoclass:: black.EmptyLineTracker
  18     :members:
  19
  20 :class:`Line`
  21 -------------
  22
  23 .. autoclass:: black.Line
  24     :members:
  25     :special-members: __str__, __bool__
  26
  27 :class:`LineGenerator`
  28 ----------------------
  29
  30 .. autoclass:: black.LineGenerator
  31     :show-inheritance:
  32     :members:
  33
  34 :class:`ProtoComment`
  35 ---------------------
  36
  37 .. autoclass:: black.comments.ProtoComment
  38     :members:
  39
  40 :class:`Report`
  41 ---------------
  42
  43 .. autoclass:: black.Report
  44     :members:
  45     :special-members: __str__
  46
  47 :class:`Visitor`
  48 ----------------
  49
  50 .. autoclass:: black.nodes.Visitor
  51     :show-inheritance:
  52     :members:
  53
  54 Enums
  55 =====
  56
  57 :class:`Changed`
  58 ----------------
  59
  60 .. autoclass:: black.Changed
  61     :show-inheritance:
  62     :members:
  63
  64 :class:`Mode`
  65 -----------------
  66
  67 .. autoclass:: black.Mode
  68     :show-inheritance:
  69     :members:
  70
  71 :class:`WriteBack`
  72 ------------------
  73
  74 .. autoclass:: black.WriteBack
  75     :show-inheritance:
  76     :members: