==============
core.reporting
==============

.. toctree::
   :hidden:



.. index:: core.reporting
.. module:: core.reporting
   :noindex:

General test progress and result reporting support.


Module Members
==============

| :class:`~WriteBuffer`
| :func:`~putErrorStack`


Classes
-------


.. class:: WriteBuffer(\*\*kwargs)

   Buffer for styled writes until a flush is forced.

   This supports 'rich' output; *i.e.* each write includes a style attribute,
   which is stored alongside the buffered text, This class does not interpret
   the style.

   .. graphviz::

         digraph foo {
         rankdir=BT;
         ranksep=0.3;
         node[fontsize=10 margin=0.01 height=0.2 width=0.4];
         edge[arrowsize=0.6 arrowhead=onormal];
         "cstest.core.reporting.WriteBuffer" [color=blue height=0.4 width=0.6];
             "cstest.ui.terminal.Terminal" -> "cstest.core.reporting.WriteBuffer";
             "cstest.core.log.Logger" -> "cstest.core.reporting.WriteBuffer";
         }

   Subclasses: :class:`~cstest.ui.terminal.Terminal` cstest.core.log.Logger


   .. method:: addstr(text, style=None)
      :noindex:

      Add a styled string to the write buffer.


      **Arguments**

        *text*
          A string.

        *style*
          A style name as defined in the :mod:`colours` module.

   .. method:: extractCleanedWriteBuf()
      :noindex:

      Extract buffer with empty trailing lines removed.