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:`Line`
  15 -------------
  16
  17 .. autoclass:: black.lines.Line
  18     :members:
  19     :special-members: __str__, __bool__
  20
  21 :class:`LinesBlock`
  22 -------------------------
  23
  24 .. autoclass:: black.lines.LinesBlock
  25     :members:
  26
  27 :class:`EmptyLineTracker`
  28 -------------------------
  29
  30 .. autoclass:: black.lines.EmptyLineTracker
  31     :members:
  32
  33 :class:`LineGenerator`
  34 ----------------------
  35
  36 .. autoclass:: black.linegen.LineGenerator
  37     :show-inheritance:
  38     :members:
  39
  40 :class:`ProtoComment`
  41 ---------------------
  42
  43 .. autoclass:: black.comments.ProtoComment
  44     :members:
  45
  46 :class:`Report`
  47 ---------------
  48
  49 .. autoclass:: black.report.Report
  50     :members:
  51     :special-members: __str__
  52
  53 :class:`Visitor`
  54 ----------------
  55
  56 .. autoclass:: black.nodes.Visitor
  57     :show-inheritance:
  58     :members:
  59
  60 Enums
  61 =====
  62
  63 :class:`Changed`
  64 ----------------
  65
  66 .. autoclass:: black.Changed
  67     :show-inheritance:
  68     :members:
  69
  70 :class:`Mode`
  71 -----------------
  72
  73 .. autoclass:: black.Mode
  74     :show-inheritance:
  75     :members:
  76
  77 :class:`WriteBack`
  78 ------------------
  79
  80 .. autoclass:: black.WriteBack
  81     :show-inheritance:
  82     :members: