AedtLogger

class ansys.aedt.core.aedt_logger.AedtLogger(level=10, filename=None, to_stdout=False, desktop=None)

Specifies the logger to use for each AEDT logger.

This class allows you to add a handler to write messages to a file and to indicate whether to write mnessages 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.

Methods

AedtLogger.add_debug_message(message_text[, ...])	Parameterized message to the message manager to specify the type and project or design level.
AedtLogger.add_error_message(message_text[, ...])	Add a type 2 "Error" message to the message manager tree.
AedtLogger.add_file_logger(filename, ...[, ...])	Add a new file to the logger handlers list.
AedtLogger.add_info_message(message_text[, ...])	Add a type 0 "Info" message to the active design level of the message manager tree.
AedtLogger.add_logger(destination[, level])	Add a logger for either the active project or active design.
AedtLogger.add_message(message_type, ...[, ...])	Add a message to the message manager to specify the type and project or design level.
AedtLogger.add_warning_message(message_text)	Add a type 1 "Warning" message to the message manager tree.
AedtLogger.clear_messages([proj_name, ...])	Clear all messages.
AedtLogger.debug(msg, *args, **kwargs)	Write a debug message to the global logger.
AedtLogger.disable_desktop_log()	Disable the log in AEDT.
AedtLogger.disable_log_on_file()	Disable writing log messages to an output file.
AedtLogger.disable_stdout_log()	Disable printing log messages to stdout.
AedtLogger.enable_desktop_log()	Enable the log in AEDT.
AedtLogger.enable_log_on_file()	Enable writing log messages to an output file.
AedtLogger.enable_stdout_log()	Enable printing log messages to stdout.
AedtLogger.error(msg, *args, **kwargs)	Write an error message to the global logger.
AedtLogger.get_messages([project_name, ...])	Get the message manager content for a specified project and design.
AedtLogger.info(msg, *args, **kwargs)	Write an info message to the global logger.
AedtLogger.info_timer(msg[, start_time])	Write an info message to the global logger with elapsed time.
AedtLogger.remove_all_project_file_logger()	Remove all the local files from the logger handlers list.
AedtLogger.remove_file_logger(project_name)	Remove a file from the logger handlers list.
AedtLogger.reset_timer([time_val])	Reset actual timer to actual time or specified time.
AedtLogger.warning(msg, *args, **kwargs)	Write a warning message to the global logger.

Attributes

AedtLogger.aedt_error_messages	Message manager content for the active project and design.
AedtLogger.aedt_info_messages	Message manager content for the active project and design.
AedtLogger.aedt_messages	Message manager content for the active project and design.
AedtLogger.aedt_warning_messages	Message manager content for the active project and design.
AedtLogger.design_logger	Design logger.
AedtLogger.design_name	Name of current logger design.
AedtLogger.error_messages	Message manager content for the active pyaedt session.
AedtLogger.glb	Global logger.
AedtLogger.info_messages	Message manager content for the active pyaedt session.
AedtLogger.logger	AEDT logger object.
AedtLogger.messages	Message manager content for the active session.
AedtLogger.non_graphical	Check if desktop is graphical or not.
AedtLogger.odesign	Design object.
AedtLogger.oproject	Project object.
AedtLogger.project_logger	Project logger.
AedtLogger.project_name	Name of current logger project.
AedtLogger.warning_messages	Message manager content for the active pyaedt session.