6.20. foundations.verbose

verbose.py

Platform:

Windows, Linux, Mac Os X.

Description:

This module defines Foundations package verbose and logging objects.

Others:

6.20.1. Module Attributes

foundations.verbose.THREADS_IDENTIFIERS

foundations.verbose.INDENT_LEVEL

foundations.verbose.LOGGER

foundations.verbose.LOGGING_DEFAULT_FORMATTER

foundations.verbose.LOGGING_EXTENDED_FORMATTER

foundations.verbose.LOGGING_STANDARD_FORMATTER

foundations.verbose.TRACER_LOGGING_FUNCTION

6.20.2. Functions

foundations.verbose.indentMessage(message)

This definition idents given message using the attr`INDENT_LEVEL` attribute value.

Parameters:message – Message to indent. ( String ) Returns:indented message. ( String )

foundations.verbose.tracer(object)

This decorator is used for execution tracing.

Any method / definition decorated will have it’s execution traced through debug messages.

Both object entry and exit are logged.

Entering in an object:

INFO    : ---> foundations.environment.getUserApplicationDataDirectory() <<<---

Exiting from an object:

INFO   : <--- foundations.environment.getSystemApplicationDataDirectory() ^ '...' --->

Parameters:object – Object to decorate. ( Object ) Returns:Object. ( Object )

foundations.verbose.installLogger(logger=None, module=None)

This definition installs given logger in given module or default logger in caller introspected module.

Parameters:

• logger – Logger to install. ( Logger )
• module – Module. ( Module )

Returns:

Logger. ( Logger )

foundations.verbose.uninstallLogger(logger=None, module=None)

This definition uninstalls given logger in given module or default logger in caller introspected module.

Parameters:

• logger – Logger to uninstall. ( Logger )
• module – Module. ( Module )

Returns:

Definition success. ( Boolean )

foundations.verbose.getLoggingConsoleHandler(logger=None, formatter=<logging.Formatter object at 0x103c6ef50>)

This definition adds a logging console handler to given logger or default logger.

Parameters:

• logger – Logger to add the handler to. ( Logger )
• formatter – Handler formatter. ( F )

Returns:

Added handler. ( Handler )

foundations.verbose.getLoggingFileHandler(logger=None, file=None, formatter=<logging.Formatter object at 0x103c6ef50>)

This definition adds a logging file handler to given logger or default logger using given file.

Parameters:

• logger – Logger to add the handler to. ( Logger )
• file – File to verbose into. ( String )
• formatter – Handler formatter. ( Formatter )

Returns:

Added handler. ( Handler )

foundations.verbose.getLoggingStreamHandler(logger=None, formatter=<logging.Formatter object at 0x103c6ef50>)

This definition adds a logging stream handler to given logger or default logger using given file.

Parameters:

• logger – Logger to add the handler to. ( Logger )
• file – File to verbose into. ( String )
• formatter – Handler formatter. ( Formatter )

Returns:

Added handler. ( Handler )

foundations.verbose.removeLoggingHandler(handler, logger=None)

This definition removes given logging handler from given logger.

Parameters:

• handler – Handler. ( Handler )
• logger – Handler logger. ( Logger )

Returns:

Definition success. ( Boolean )

foundations.verbose.setVerbosityLevel(verbosityLevel=3, logger=None)

This definition defines logging verbosity level.

Available verbosity levels:

0: Critical.
1: Error.
2: Warning.
3: Info.
4: Debug.

Parameters:

• verbosityLevel – Verbosity level. ( Integer )
• logger – Logger to set the verbosity level to. ( Logger )

Returns:

Definition success. ( Boolean )

6.20.3. Classes

class foundations.verbose.Streamer(stream=None)

Bases: object

This class is intented to be used as a stream object for logging.StreamHandler logging handler.

Parameters:stream – Stream object. ( Object )

stream

This method is the property for self.__stream attribute.

Returns:self.__stream. ( List )

write(message)

This method provides write ability to the class.

Parameters:message – Current message. ( String )

flush()

This method flushes the current stream.

class foundations.verbose.StandardOutputStreamer(logger)

Bases: object

This class is a redirection object intented to be used for sys.stdout and sys.stderr streams.

Logging messages will be written to given logger handlers.

Parameters:logger – Logger. ( Object )

logger

This method is the property for self.__logger attribute.

Returns:self.__logger. ( Logger )

write(message)

This method writes given message to logger handlers.

Parameters:message – Message. ( String ) Returns:Method success. ( Boolean )