Message Manager

The PyAEDT API includes these classes for AEDT and EDB Message managers:

AEDTMessageManager

Manages AEDT messaging to both the logger and the AEDT Message Manager window.

LogHandler

This section lists modules for creating a handler to send log messages in AEDT logging stream.

class pyaedt.log_handler.LogHandler(aedt_app_messenger, log_destination, level=20)[source]

Creates a handler to send log messages in AEDT logging stream.

Parameters
aedt_app_messengerclass:pyaedt.application.MessageManager.AEDTMessageManager

AEDT app log manager.

log_destinationstr

AEDT has 3 different logs: ‘Global’, ‘Project’, ‘Design’.

levelint, optional

Threshold for this handler. For example logging.DEBUG

log_handler.LogHandler

acquire()

Acquire the I/O thread lock.

addFilter(filter)

Add the specified filter to this handler.

close()

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

createLock()

Acquire a thread lock for serializing access to the underlying I/O.

emit(record)[source]

Write the record to the stream.

Parameters
recordclass:logging.LogRecord

Contains information related to the event being logged.

filter(record)

Determine if a record is loggable by consulting all the filters.

The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero.

Changed in version 3.2: Allow filters to be just callables.

flush()

Ensure all logging output has been flushed.

This version does nothing and is intended to be implemented by subclasses.

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

handle(record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock. Returns whether the filter passed the record for emission.

handleError(record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

release()

Release the I/O thread lock.

removeFilter(filter)

Remove the specified filter from this handler.

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler. level must be an int or a str.

AedtLogger

This section lists modules for creating and editing pyaedt log files.

AedtLogger

Logger used for each Aedt logger.

AppFilter

This filter will be used to specify the destination of the log Global, project and design.