====================
``topology.logging``
====================

.. automodule:: topology.logging

   .. contents::
      :local:

.. currentmodule:: topology.logging


Classes
=======

- :py:class:`BaseLogger`:
  Base class for Topology logger classes.

- :py:class:`FileLogger`:
  Subclass of BaseLogger that adds a PexpectFileHandler.

- :py:class:`PexpectLogger`:
  Special subclass that implements a logger to be used with Pexpect

- :py:class:`PexpectLoggerRead`:
  Undocumented.

- :py:class:`PexpectLoggerSend`:
  Undocumented.

- :py:class:`ConnectionLogger`:
  Logger for shell connections.

- :py:class:`LoggingManager`:
  Defines an object that manage and create loggers for Topology components.


.. autoclass:: BaseLogger
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: BaseLogger
      :parts: 1

.. autoclass:: FileLogger
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: FileLogger
      :parts: 1

.. autoclass:: PexpectLogger
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: PexpectLogger
      :parts: 1

.. autoclass:: PexpectLoggerRead
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: PexpectLoggerRead
      :parts: 1

.. autoclass:: PexpectLoggerSend
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: PexpectLoggerSend
      :parts: 1

.. autoclass:: ConnectionLogger
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: ConnectionLogger
      :parts: 1

.. autoclass:: LoggingManager
   :members:

   .. rubric:: Inheritance
   .. inheritance-diagram:: LoggingManager
      :parts: 1


Variables
=========

- :py:data:`LEVELS`
- :py:data:`manager`
- :py:data:`get_logger`

.. autodata:: LEVELS
   :annotation:

   .. code-block:: guess

      OrderedDict([('NOTSET', 0),
                   ('DEBUG', 10),
                   ('INFO', 20),
                   ('WARNING', 30),
                   ('ERROR', 40),
                   ('CRITICAL', 50)])

.. autodata:: manager
   :annotation:

   .. code-block:: guess

      <topology.logging.LoggingManager object at 0x7fd8ca298470>

.. autodata:: get_logger
   :annotation:

   .. code-block:: guess

      <bound method LoggingManager.get_logger of <topology.logging.LoggingManager object at 0x7fd8ca298470>>