.. include:: headings.inc



.. _LogFormatter:

==========================================================================================================================================
|phoenix_title|  **LogFormatter**
==========================================================================================================================================

:ref:`LogFormatter`  class is used to format the log messages.          

It implements the default formatting and can be derived from to create custom formatters. 

The default implementation formats the message into a string containing the time stamp, level-dependent prefix and the message itself. 

To change it, you can derive from it and override its :meth:`~LogFormatter.Format`  method. For example, to include the thread id in the log messages you can use ::

            class LogFormatterWithThread(wx.LogFormatter):
                def Format(level, msg, info):
                    return "[%d] %s(%d) : %s" % \
                           (info.threadId, info.filename, info.line, msg)

And then associate it with :ref:`Log`  instance using its SetFormatter(). Then, if you call: 

::

            wx.LogMessage("*** Application started ***")



the log output could be something like: 









         



.. versionadded:: 2.9.4 
     







.. seealso:: :ref:`Log Classes Overview <log classes overview>`  







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **LogFormatter**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/LogFormatter_inheritance.png" alt="Inheritance diagram of LogFormatter" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="LogFormatter.html" title="LogFormatter  class is used to format the log messages." alt="" coords="7,5,124,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~LogFormatter.__init__`                                                   The default constructor does nothing.
:meth:`~LogFormatter.Format`                                                     This function creates the full log message string.
:meth:`~LogFormatter.FormatTime`                                                 This function formats the time stamp part of the log message.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: LogFormatter(object)

   LogFormatter class is used to format the log messages.
   
   **Possible constructors**::

       LogFormatter()
       



   .. method:: __init__(self)

      The default constructor does nothing.                   





   .. method:: Format(self, level, msg, info)

      This function creates the full log message string.                  

      Override it to customize the output string format. 




      :param `level`: The level of this log record, e.g. :meth:`LOG_Error` .   
      :type `level`: LogLevel
      :param `msg`: The log message itself.   
      :type `msg`: string
      :param `info`: All the other information (such as time, component, location...) associated with this log record.  
      :type `info`: LogRecordInfo










      :rtype: `string`



                  



      :returns: 

         The formated message.  







      .. note:: 

         Time stamping is disabled for Visual ``C++`` users in debug builds by default because otherwise it would be impossible to directly go to the line from which the log message was generated by simply clicking in the debugger window on the corresponding error message. If you wish to enable it, override :meth:`FormatTime` .   








   .. method:: FormatTime(self, time)

      This function formats the time stamp part of the log message.                  

      Override this function if you need to customize just the time stamp. 




      :param `time`: Time to format.  
      :type `time`: int






      :rtype: `string`



                  



      :returns: 

         The formated time string, may be empty.