taurus taurus

Previous topic

LogIt

Next topic

LoopList

This Page

Logger

Inheritance diagram of Logger

class Logger(name='', parent=None, format=None)

Bases: taurus.core.util.object.Object

The taurus logger class. All taurus pertinent classes should inherit directly or indirectly from this class if they need taurus logging facilities.

Critical = 50

Critical message level (constant)

Debug = 10

Debug message level (constant)

DftLogFormat = <logging.Formatter object at 0x9c1ea0c>

Default log format (constant)

DftLogLevel = 20

Default log level (constant)

Error = 40

Error message level (constant)

Info = 20

Info message level (constant)

Trace = 5

Trace message level (constant)

Warning = 30

Warning message level (constant)

addChild(child)

Adds a new logging child

Parameters:child (:class:~`logging.Logger`) – the new child
classmethod addLevelName(level_no, level_name)

Registers a new log level

Parameters:
  • level_no (:class:~`int`) – the level number
  • level_name (:class:~`str`) – the corresponding name
addLogHandler(handler)

Registers a new handler in this object’s logger

Parameters:handler (:class:~`logging.Handler`) – the new handler to be added
classmethod addRootLogHandler(h)

Adds a new handler to the root logger

Parameters:h (:class:~`logging.Handler`) – the new log handler
changeLogName(name)

Change the log name for this object.

Parameters:name (:class:~`str`) – the new log name
cleanUp()

The cleanUp. Default implementation does nothing Overwrite when necessary

copyLogHandlers(other)

Copies the log handlers of other object to this object

Parameters:other (:class:~`object`) – object which contains ‘log_handlers’
critical(msg, *args, **kw)

Record a critical message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.critical().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
debug(msg, *args, **kw)

Record a debug message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.debug().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
deprecated(msg, *args, **kw)

Record a deprecated warning message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.warning().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
classmethod disableLogOutput()

Disables the logging.StreamHandler which dumps log records, by default, to the stderr.

classmethod enableLogOutput()

Enables the logging.StreamHandler which dumps log records, by default, to the stderr.

error(msg, *args, **kw)

Record an error message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.error().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
exception(msg, *args)

Log a message with severity ‘ERROR’ on the root logger, with exception information.. Accepted args are the same as logging.Logger.exception().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
flushOutput()

Flushes the log output

getChildren()

Returns the log children for this object

Return type::class:~`sequence<logging.Logger`
Returns:the list of log children
classmethod getLogFormat()

Retuns the current log message format (the root log format)

Return type::class:~`str`
Returns:the log message format
getLogFullName()

Gets the full log name for this object

Return type::class:~`str`
Returns:the full log name
classmethod getLogLevel()

Retuns the current log level (the root log level)

Return type::class:~`int`
Returns:a number representing the log level
getLogName()

Gets the log name for this object

Return type::class:~`str`
Returns:the log name
getLogObj()

Returns the log object for this object

Return type::class:~`logging.Logger`
Returns:the log object
getParent()

Returns the log parent for this object or None if no parent exists

Return type::class:~`logging.Logger` or :class:~`None`
Returns:the log parent for this object
classmethod getRootLog()

Retuns the root logger

Return type::class:~`logging.Logger`
Returns:the root logger
info(msg, *args, **kw)

Record an info message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.info().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
classmethod initRoot()

Class method to initialize the root logger. Do NOT call this method directly in your code

log(level, msg, *args, **kw)

Record a log message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.log().

Parameters:
  • level (:class:~`int`) – the record level
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
log_format = <logging.Formatter object at 0x9c1ea0c>

Default log message format

log_level = 20

Current global log level

classmethod removeRootLogHandler(h)

Removes the given handler from the root logger

Parameters:h (:class:~`logging.Handler`) – the handler to be removed
classmethod resetLogFormat()

Resets the log message format (the root log format)

classmethod resetLogLevel()

Resets the log level (the root log level)

root_init_lock = <thread.lock object at 0x9ab25b0>

Internal usage

root_inited = True

Internal usage

classmethod setLogFormat(format)

sets the new log message format

Parameters:level (:class:~`str`) – the new log message format
classmethod setLogLevel(level)

sets the new log level (the root log level)

Parameters:level (:class:~`int`) – the new log level
stack(target=5)

Log the usual stack information, followed by a listing of all the local variables in each frame.

Parameters:target (:class:~`int`) – the log level assigned to the record
Return type::class:~`str`
Returns:The stack string representation
stream_handler = <logging.StreamHandler object at 0xa561dcc>

the main stream handler

syncLog()

Synchronises the log output

trace(msg, *args, **kw)

Record a trace message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.log().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments
traceback(level=5, extended=True)

Log the usual traceback information, followed by a listing of all the local variables in each frame.

Parameters:
  • level (:class:~`int`) – the log level assigned to the traceback record
  • extended (:class:~`bool`) – if True, the log record message will have multiple lines
Return type:

:class:~`str`

Returns:

The traceback string representation

warning(msg, *args, **kw)

Record a warning message in this object’s logger. Accepted args and kwargs are the same as logging.Logger.warning().

Parameters:
  • msg (:class:~`str`) – the message to be recorded
  • args – list of arguments
  • kw – list of keyword arguments