robotide.lib.robot.output.logger.Logger Class Reference

A global logger proxy to delegating messages to registered loggers. More...

Inheritance diagram for robotide.lib.robot.output.logger.Logger:

Public Member Functions
def	__enter__ (self)
def	__exit__ (self, *exc_info)
def	__init__ (self, register_console_logger=True)
def	__iter__ (self)
def	close (self)
def	disable_library_import_logging (self)
def	disable_message_cache (self)
def	enable_library_import_logging (self)
def	end_keyword (self, keyword)
def	end_suite (self, suite)
def	end_test (self, test)
def	imported (self, import_type, name, **attrs)
def	log_output (self, output)
def	message (self, msg)
	Messages about what the framework is doing, warnings, errors, ... More...
def	output_file (self, file_type, path)
	Finished output, report, log, debug, or xunit file. More...
def	register_console_logger (self, type='verbose', width=78, colors='AUTO', markers='AUTO', stdout=None, stderr=None)
def	register_error_listener (self, listener)
def	register_listeners (self, listeners, library_listeners)
def	register_logger (self, *loggers)
def	register_syslog (self, path=None, level='INFO')
def	register_xml_logger (self, logger)
def	start_keyword (self, keyword)
def	start_suite (self, suite)
def	start_test (self, test)
def	unregister_console_logger (self)
def	unregister_logger (self, *loggers)
def	unregister_xml_logger (self)
Public Member Functions inherited from robotide.lib.robot.output.loggerhelper.AbstractLogger
def	debug (self, msg)
def	error (self, msg)
def	fail (self, msg)
def	info (self, msg)
def	set_level (self, level)
def	trace (self, msg)
def	warn (self, msg)
def	write (self, message, level, html=False)

Public Attributes
	log_message

Static Public Attributes
def	log_message = message

Properties
	cache_only = property
	delayed_logging = property
	end_loggers = property
	start_loggers = property

Private Member Functions
def	_log_message (self, msg, no_cache=False)
	Log messages written (mainly) by libraries. More...
def	_relay_cached_messages (self, logger)
def	_wrap_and_relay (self, logger)
def	cache_only (self)
def	delayed_logging (self)
def	end_loggers (self)
def	start_loggers (self)

Private Attributes
	_cache_only
	_console_logger
	_enabled
	_error_listener
	_error_occurred
	_library_listeners
	_listeners
	_log_message_cache
	_message_cache
	_other_loggers
	_prev_log_message_handlers
	_started_keywords
	_syslog
	_xml_logger

Detailed Description

A global logger proxy to delegating messages to registered loggers.

Whenever something is written to LOGGER in code, all registered loggers are
notified.  Messages are also cached and cached messages written to new
loggers when they are registered.

NOTE: This API is likely to change in future versions.

Definition at line 35 of file logger.py.

Constructor & Destructor Documentation

__init__()

def robotide.lib.robot.output.logger.Logger.__init__	(		self,
			register_console_logger = True
	)

Reimplemented from robotide.lib.robot.output.loggerhelper.AbstractLogger.

Definition at line 37 of file logger.py.

Member Function Documentation

__enter__()

def robotide.lib.robot.output.logger.Logger.__enter__

(

self

)

Definition at line 74 of file logger.py.

__exit__()

def robotide.lib.robot.output.logger.Logger.__exit__	(		self,
		*	exc_info
	)

Definition at line 79 of file logger.py.

__iter__()

def robotide.lib.robot.output.logger.Logger.__iter__

(

self

)

Definition at line 71 of file logger.py.

_log_message()

def robotide.lib.robot.output.logger.Logger._log_message (   self,   msg,   no_cache = False  )

private

Log messages written (mainly) by libraries.

Definition at line 186 of file logger.py.

_relay_cached_messages()

def robotide.lib.robot.output.logger.Logger._relay_cached_messages (   self,   logger  )

private

Definition at line 94 of file logger.py.

_wrap_and_relay()

def robotide.lib.robot.output.logger.Logger._wrap_and_relay (   self,   logger  )

private

Definition at line 89 of file logger.py.

cache_only()

def robotide.lib.robot.output.logger.Logger.cache_only (   self )

private

Definition at line 161 of file logger.py.

close()

def robotide.lib.robot.output.logger.Logger.close

(

self

)

Definition at line 248 of file logger.py.

delayed_logging()

def robotide.lib.robot.output.logger.Logger.delayed_logging (   self )

private

Definition at line 172 of file logger.py.

disable_library_import_logging()

def robotide.lib.robot.output.logger.Logger.disable_library_import_logging

(

self

)

Definition at line 206 of file logger.py.

disable_message_cache()

def robotide.lib.robot.output.logger.Logger.disable_message_cache

(

self

)

Definition at line 137 of file logger.py.

enable_library_import_logging()

def robotide.lib.robot.output.logger.Logger.enable_library_import_logging

(

self

)

Definition at line 202 of file logger.py.

end_keyword()

def robotide.lib.robot.output.logger.Logger.end_keyword	(		self,
			keyword
	)

Definition at line 232 of file logger.py.

end_loggers()

def robotide.lib.robot.output.logger.Logger.end_loggers (   self )

private

Definition at line 66 of file logger.py.

end_suite()

def robotide.lib.robot.output.logger.Logger.end_suite	(		self,
			suite
	)

Definition at line 213 of file logger.py.

end_test()

def robotide.lib.robot.output.logger.Logger.end_test	(		self,
			test
	)

Definition at line 221 of file logger.py.

imported()

def robotide.lib.robot.output.logger.Logger.imported	(		self,
			import_type,
			name,
		**	attrs
	)

Definition at line 239 of file logger.py.

log_output()

def robotide.lib.robot.output.logger.Logger.log_output	(		self,
			output
	)

Definition at line 198 of file logger.py.

message()

def robotide.lib.robot.output.logger.Logger.message	(		self,
			msg
	)

Messages about what the framework is doing, warnings, errors, ...

Reimplemented from robotide.lib.robot.output.loggerhelper.AbstractLogger.

Definition at line 146 of file logger.py.

output_file()

def robotide.lib.robot.output.logger.Logger.output_file	(		self,
			file_type,
			path
	)

Finished output, report, log, debug, or xunit file.

Definition at line 244 of file logger.py.

register_console_logger()

def robotide.lib.robot.output.logger.Logger.register_console_logger	(		self,
			type = 'verbose',
			width = 78,
			colors = 'AUTO',
			markers = 'AUTO',
			stdout = None,
			stderr = None
	)

Definition at line 84 of file logger.py.

register_error_listener()

def robotide.lib.robot.output.logger.Logger.register_error_listener	(		self,
			listener
	)

Definition at line 140 of file logger.py.

register_listeners()

def robotide.lib.robot.output.logger.Logger.register_listeners	(		self,
			listeners,
			library_listeners
	)

Definition at line 121 of file logger.py.

register_logger()

def robotide.lib.robot.output.logger.Logger.register_logger	(		self,
		*	loggers
	)

Definition at line 127 of file logger.py.

register_syslog()

def robotide.lib.robot.output.logger.Logger.register_syslog	(		self,
			path = None,
			level = 'INFO'
	)

Definition at line 102 of file logger.py.

register_xml_logger()

def robotide.lib.robot.output.logger.Logger.register_xml_logger	(		self,
			logger
	)

Definition at line 115 of file logger.py.

start_keyword()

def robotide.lib.robot.output.logger.Logger.start_keyword	(		self,
			keyword
	)

Definition at line 225 of file logger.py.

start_loggers()

def robotide.lib.robot.output.logger.Logger.start_loggers (   self )

private

Definition at line 58 of file logger.py.

start_suite()

def robotide.lib.robot.output.logger.Logger.start_suite	(		self,
			suite
	)

Definition at line 209 of file logger.py.

start_test()

def robotide.lib.robot.output.logger.Logger.start_test	(		self,
			test
	)

Definition at line 217 of file logger.py.

unregister_console_logger()

def robotide.lib.robot.output.logger.Logger.unregister_console_logger

(

self

)

Definition at line 99 of file logger.py.

unregister_logger()

def robotide.lib.robot.output.logger.Logger.unregister_logger	(		self,
		*	loggers
	)

Definition at line 132 of file logger.py.

unregister_xml_logger()

def robotide.lib.robot.output.logger.Logger.unregister_xml_logger

(

self

)

Definition at line 118 of file logger.py.

Member Data Documentation

_cache_only

robotide.lib.robot.output.logger.Logger._cache_only

private

Definition at line 51 of file logger.py.

_console_logger

robotide.lib.robot.output.logger.Logger._console_logger

private

Definition at line 38 of file logger.py.

_enabled

robotide.lib.robot.output.logger.Logger._enabled

private

Definition at line 50 of file logger.py.

_error_listener

robotide.lib.robot.output.logger.Logger._error_listener

private

Definition at line 48 of file logger.py.

_error_occurred

robotide.lib.robot.output.logger.Logger._error_occurred

private

Definition at line 47 of file logger.py.

_library_listeners

robotide.lib.robot.output.logger.Logger._library_listeners

private

Definition at line 42 of file logger.py.

_listeners

robotide.lib.robot.output.logger.Logger._listeners

private

Definition at line 41 of file logger.py.

_log_message_cache

robotide.lib.robot.output.logger.Logger._log_message_cache

private

Definition at line 45 of file logger.py.

_message_cache

robotide.lib.robot.output.logger.Logger._message_cache

private

Definition at line 44 of file logger.py.

_other_loggers

robotide.lib.robot.output.logger.Logger._other_loggers

private

Definition at line 43 of file logger.py.

_prev_log_message_handlers

robotide.lib.robot.output.logger.Logger._prev_log_message_handlers

private

Definition at line 49 of file logger.py.

_started_keywords

robotide.lib.robot.output.logger.Logger._started_keywords

private

Definition at line 46 of file logger.py.

_syslog

robotide.lib.robot.output.logger.Logger._syslog

private

Definition at line 39 of file logger.py.

_xml_logger

robotide.lib.robot.output.logger.Logger._xml_logger

private

Definition at line 40 of file logger.py.

log_message [1/2]

def robotide.lib.robot.output.logger.Logger.log_message = message

static

Definition at line 196 of file logger.py.

log_message [2/2]

robotide.lib.robot.output.logger.Logger.log_message

Definition at line 204 of file logger.py.

Property Documentation

cache_only

robotide.lib.robot.output.logger.Logger.cache_only = property

static

Definition at line 159 of file logger.py.

delayed_logging

robotide.lib.robot.output.logger.Logger.delayed_logging = property

static

Definition at line 170 of file logger.py.

end_loggers

robotide.lib.robot.output.logger.Logger.end_loggers = property

static

Definition at line 64 of file logger.py.

start_loggers

robotide.lib.robot.output.logger.Logger.start_loggers = property

static

Definition at line 56 of file logger.py.

---

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

• src/robotide/lib/robot/output/logger.py