LogChain

This simple class allows you to chain log sinks, that is to install a new sink but keep passing log messages to the old one instead of replacing it completely as Log.SetActiveTarget does.

It is especially useful when you want to divert the logs somewhere (for example to a file or a log window) but also keep showing the error messages using the standard dialogs as LogGui does by default.

Example of usage:

logChain = wx.LogChain(wx.LogStderr)

# all the log messages are sent to stderr and also processed as usually

# don't delete logChain directly as this would leave a dangling
# pointer as active log target, use SetActiveTarget() instead

Inheritance Diagram

Inheritance diagram for class LogChain

Known Subclasses

LogInterposer, LogInterposerTemp

Methods Summary

__init__	Sets the specified logger (which may be None) as the default log target but the log messages are also passed to the previous log target if any.
DetachOldLog	Detaches the old log target so it won’t be destroyed when the LogChain object is destroyed.
GetOldLog	Returns the pointer to the previously active log target (which may be None).
IsPassingMessages	Returns True if the messages are passed to the previously active log target (default) or False if PassMessages had been called.
PassMessages	By default, the log messages are passed to the previously active log target.
SetLog	Sets another log target to use (may be None).

Properties Summary

OldLog

See GetOldLog

Class API

---

class LogChain(Log)

This simple class allows you to chain log sinks, that is to install a new sink but keep passing log messages to the old one instead of replacing it completely as Log.SetActiveTarget does.

Possible constructors:

LogChain(logger)

Methods

---

__init__(self, logger)

Sets the specified logger (which may be None) as the default log target but the log messages are also passed to the previous log target if any.

Parameters:logger (Log) –

---

DetachOldLog(self)

Detaches the old log target so it won’t be destroyed when the LogChain object is destroyed.

---

GetOldLog(self)

Returns the pointer to the previously active log target (which may be None).

Return type: Log

---

IsPassingMessages(self)

Returns True if the messages are passed to the previously active log target (default) or False if PassMessages had been called.

Return type:bool

---

PassMessages(self, passMessages)

By default, the log messages are passed to the previously active log target.

Calling this function with False parameter disables this behaviour (presumably temporarily, as you shouldn’t use LogChain at all otherwise) and it can be reenabled by calling it again with passMessages set to True.

Parameters:passMessages (bool) –

---

SetLog(self, logger)

Sets another log target to use (may be None).

The log target specified in the LogChain constructor or in a previous call to this function is deleted. This doesn’t change the old log target value (the one the messages are forwarded to) which still remains the same as was active when LogChain object was created.

Parameters:logger (Log) –

Properties

---

OldLog

See GetOldLog