EdbLogger

class pyedb.edb_logger.EdbLogger(level=logging.DEBUG, filename=None, to_stdout=False, settings=None)

Bases: object

Specifies the logger to use for EDB logger.

This class allows you to add a handler to write messages to a file and to indicate whether to write messages to the standard output (stdout).

Parameters:

levelint, optional

Logging level to filter the message severity allowed in the logger. The default is logging.DEBUG.

filenamestr, optional

Name of the file to write messages to. The default is None.

to_stdoutbool, optional

Whether to write log messages to stdout. The default is False.

Overview

Methods

add_file_logger	Add a new file to the logger handlers list.
remove_file_logger	Remove a file from the logger handlers list.
remove_all_file_loggers	Remove all file loggers.
reset_timer	“Reset actual timer to actual time or specified time.
add_error_message	Add a type 2 “Error” message to the message manager tree.
add_warning_message	Add a type 1 “Warning” message to the message manager tree.
add_info_message	Add a type 0 “Info” message to the active design level of the message manager tree.
add_debug_message	Parameterized message to the message manager.
add_message	Add a message to the message manager.
disable_stdout_log	Disable printing log messages to stdout.
enable_stdout_log	Enable printing log messages to stdout.
disable_log_on_file	Disable writing log messages to an output file.
enable_log_on_file	Enable writing log messages to an output file.
info	Write an info message to the global logger.
info_timer	Write an info message to the global logger with elapsed time.
warning	Write a warning message to the global logger.
error	Write an error message to the global logger.
debug	Write a debug message to the global logger.

Properties

logger	EDB logger object.
glb	Global logger.

Attributes

log_file
settings
level
filename

Import detail

from pyedb.edb_logger import EdbLogger

Property detail

property EdbLogger.logger

EDB logger object.

property EdbLogger.glb

Global logger.

Attribute detail

EdbLogger.log_file = ''

EdbLogger.settings = None

EdbLogger.level = 10

EdbLogger.filename

Method detail

EdbLogger.add_file_logger(filename)

Add a new file to the logger handlers list.

EdbLogger.remove_file_logger(project_name)

Remove a file from the logger handlers list.

EdbLogger.remove_all_file_loggers()

Remove all file loggers.

EdbLogger.reset_timer(time_val=None)

“Reset actual timer to actual time or specified time.

Parameters:

time_valfloat, optional

Value time to apply.

Returns:

EdbLogger.add_error_message(message_text)

Add a type 2 “Error” message to the message manager tree.

Also add an error message to the logger if the handler is present.

Parameters:

message_textstr

Text to display as the error message.

EdbLogger.add_warning_message(message_text)

Add a type 1 “Warning” message to the message manager tree.

Also add a warning message to the logger if the handler is present.

Parameters:

message_textstr

Text to display as the warning message.

Examples

Add a warning message to the EDB message manager.

>>> edb.logger.warning("Global warning message")

EdbLogger.add_info_message(message_text)

Add a type 0 “Info” message to the active design level of the message manager tree.

Also add an info message to the logger if the handler is present.

Parameters:

message_textstr

Text to display as the info message.

Examples

Add an info message at the global level.

>>> edb.logger.info("Global warning message")

EdbLogger.add_debug_message(message_text)

Parameterized message to the message manager.

Parameters:

message_textstr

Text to display as the message.

EdbLogger.add_message(message_type, message_text)

Add a message to the message manager.

Parameters:

message_typeint

Type of the message. Options are: * 0 : Info * 1 : Warning * 2 : Error * 3 : Debug

message_textstr

Text to display as the message.

EdbLogger.disable_stdout_log()

Disable printing log messages to stdout.

EdbLogger.enable_stdout_log()

Enable printing log messages to stdout.

EdbLogger.disable_log_on_file()

Disable writing log messages to an output file.

EdbLogger.enable_log_on_file()

Enable writing log messages to an output file.

EdbLogger.info(msg, *args, **kwargs)

Write an info message to the global logger.

EdbLogger.info_timer(msg, start_time=None, *args, **kwargs)

Write an info message to the global logger with elapsed time. Message will have an appendix of type Elapsed time: time.

EdbLogger.warning(msg, *args, **kwargs)

Write a warning message to the global logger.

EdbLogger.error(msg, *args, **kwargs)

Write an error message to the global logger.

EdbLogger.debug(msg, *args, **kwargs)

Write a debug message to the global logger.