wx.LogFormatter

wx.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 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 wx.Log instance using its SetFormatter(). Then, if you call:

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

the log output could be something like:

New in version 2.9.4.

See also

Logging Overview

Class Hierarchy

Inheritance diagram for class LogFormatter:

Methods Summary

__init__	The default constructor does nothing.
Format	This function creates the full log message string.
FormatTime	This function formats the time stamp part of the log message.

Class API

class wx.LogFormatter(object)

Possible constructors:

LogFormatter()

LogFormatter class is used to format the log messages.

Methods

__init__(self)

The default constructor does nothing.

---

Format(self, level, msg, info)

This function creates the full log message string.

Override it to customize the output string format.

Parameters:

• level (wx.LogLevel) – The level of this log record, e.g. wx.LOG_Error .

• msg (string) – The log message itself.

• info (wx.LogRecordInfo) – All the other information (such as time, component, location…) associated with this log record.

Return type:

string

Returns:

The formatted 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 FormatTime .

---

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.

Parameters:

time (int) – Time to format.

Return type:

string

Returns:

The formatted time string, may be empty.

Deprecated

This function only exists for compatibility, please override FormatTimeMS in the new code.