gui.log.StringHandler Class Reference

Stores the log records as a list of strings. More...

Inheritance diagram for gui.log.StringHandler:

Public Member Functions
def	__init__ (self, storeAsUnicode=True)
	Constructor. More...
def	getBufferAsList (self, clean=True)
	Returns all buffered messages. More...
def	getBufferAsString (self, clean=True)
	Returns all buffered messages. More...
def	emit (self, record)
	Emit a record. More...
def	flush (self)
	Empty the buffer. More...

Public Attributes
	buffer
	storeAsUnicode

Static Public Attributes
bool	storeAsUnicode = True
	Stores the log records as unicode strings. More...
	encoding = sys.stdout.encoding or sys.getfilesystemencoding()
	Encoding of all character strings. More...

Private Member Functions
def	_toUnicode (self, msg)
	Convert a non unicode string into a unicode string. More...

Detailed Description

Stores the log records as a list of strings.

Constructor & Destructor Documentation

__init__()

def gui.log.StringHandler.__init__	(		self,
			storeAsUnicode = True
	)

Constructor.

Parameters

self	The object instance itself
storeAsUnicode	Store recorded log records as unicode strings

Member Function Documentation

_toUnicode()

def gui.log.StringHandler._toUnicode (   self,   msg  )

private

Convert a non unicode string into a unicode string.

Returns

The unicode string

See also

encoding

References smm.objects.SMMBaseObject.encoding, smm.quote.base.FetchPluginBase.encoding, and gui.log.StringHandler.encoding.

Referenced by gui.log.StringHandler.emit().

Here is the caller graph for this function:

emit()

def gui.log.StringHandler.emit	(		self,
			record
	)

Emit a record.

Add a formatted log record to the buffer.

References gui.log.StringHandler._toUnicode(), smm.objects.SMMBaseObject._toUnicode(), gui.log.StringHandler.buffer, gui.log.StringHandler.flush(), and gui.log.StringHandler.storeAsUnicode.

Here is the call graph for this function:

flush()

def gui.log.StringHandler.flush

(

self

)

Empty the buffer.

References gui.log.StringHandler.buffer.

Referenced by gui.log.StringHandler.emit(), and gui.log.StringHandler.getBufferAsList().

Here is the caller graph for this function:

getBufferAsList()

def gui.log.StringHandler.getBufferAsList	(		self,
			clean = True
	)

Returns all buffered messages.

Parameters

clean

Clean the internal message buffer

Returns

List of messages strings

See also

getBufferAsString()

References gui.log.StringHandler.buffer, and gui.log.StringHandler.flush().

Referenced by gui.log.StringHandler.getBufferAsString().

Here is the call graph for this function:

Here is the caller graph for this function:

getBufferAsString()

def gui.log.StringHandler.getBufferAsString	(		self,
			clean = True
	)

Returns all buffered messages.

Parameters

clean

Clean the internal message buffer

Returns

Messages concatenate to a string

See also

getBufferAsList()

References gui.log.StringHandler.getBufferAsList(), and gui.log.StringHandler.storeAsUnicode.

Here is the call graph for this function:

Member Data Documentation

buffer

gui.log.StringHandler.buffer

The message buffer itself

Referenced by gui.log.StringHandler.emit(), gui.log.StringHandler.flush(), and gui.log.StringHandler.getBufferAsList().

encoding

gui.log.StringHandler.encoding = sys.stdout.encoding or sys.getfilesystemencoding()

static

Encoding of all character strings.

The default_encoding is used to convert character strings into unicode strings

See also

storeAsUnicode

Referenced by gui.log.StringHandler._toUnicode().

storeAsUnicode [1/2]

bool gui.log.StringHandler.storeAsUnicode = True

static

Stores the log records as unicode strings.

Referenced by gui.log.StringHandler.emit(), and gui.log.StringHandler.getBufferAsString().

storeAsUnicode [2/2]

gui.log.StringHandler.storeAsUnicode

---

The documentation for this class was generated from the following file:

• gui/log.py